{"items":[{"type":"link","label":"Intercom API","link":"/docs/references/rest-api/api.intercom.io","routeSlug":"/docs/references/rest-api/api.intercom.io","content":{"contentType":"overview","meta":{"name":"Intercom API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.intercom.io.json","url":"/_bundle/docs/references/@2.18/rest-api/api.intercom.io.json?download"},{"kind":"download","label":"api.intercom.io.yaml","url":"/_bundle/docs/references/@2.18/rest-api/api.intercom.io.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://developers.intercom.com","url":"https://developers.intercom.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://spdx.org/licenses/MIT"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"go","title":"Go","lang":"Go"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Intercom API (2.18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The intercom API reference."}],"sectionId":"/docs/references/rest-api/api.intercom.io"}],"sectionId":"/docs/references/rest-api/api.intercom.io"}]}]}},{"type":"group","label":"Admins","link":"/docs/references/rest-api/api.intercom.io/admins","routeSlug":"/docs/references/rest-api/api.intercom.io/admins","items":[{"label":"Identify an admin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/identifyadmin","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/identifyadmin","metadata":{"seo":{"title":"Identify an admin","description":"You can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"identifyAdmin","name":"Identify an admin","isWebhook":false,"pointer":"/paths/~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identify an admin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology)."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧 Single Sign On"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are building a custom \"Log in with Intercom\" flow for your site, and you call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/me"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_single_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1me/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/me","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/me","href":"admins/identifyadmin","openApiOperationId":"identifyAdmin","summary":"Identify an admin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin_with_app","exampleIds":["paths/~1me/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/admin_with_app","exampleIds":["paths/~1me/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1me/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1me/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Admin not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin_with_app","exampleIds":["paths/~1me/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin_with_app","exampleIds":["paths/~1me/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1me/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1me/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1me/get/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/identifyadmin"}],"panels":[]}]},"httpPath":"/me"},{"label":"Set an admin to away","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/setawayadmin","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/setawayadmin","metadata":{"seo":{"title":"Set an admin to away","description":"You can set an Admin as away for the Inbox."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAwayAdmin","name":"Set an admin to away","isWebhook":false,"pointer":"/paths/~1admins~1{admin_id}~1away/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set an admin to away","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set an Admin as away for the Inbox."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"away_mode_reassign"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the request can return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the teammate does not have Inbox access."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"admin_id","in":"path","schemaId":"schema_1150","description":"The unique identifier of a given admin","required":true}],"pointer":"/paths/~1admins~1{admin_id}~1away/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins~1{admin_id}~1away/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1151","exampleIds":["paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized"]}},"schemaId":"schema_1151","exampleIds":["paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized"],"pointer":"/paths/~1admins~1{admin_id}~1away/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/admins/{admin_id}/away","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"admin_id","in":"path","required":true,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1151","exampleIds":["paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized"]}},"responseCodes":["200","400","401","403","404","405"],"pointer":"/admins/{admin_id}/away","href":"admins/setawayadmin","openApiOperationId":"setAwayAdmin","summary":"Set an admin to away"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1151","exampleIds":["paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1151","exampleIds":["paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/parameter_invalid","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_found","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_mandatory","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_required","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_enabled_missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/parameter_invalid","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_found","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_mandatory","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_required","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_enabled_missing"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Can be returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"away_mode_reassign"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the admin does not have Inbox access for the workspace."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/403/content/application~1json/examples/Admin without Inbox access"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/403/content/application~1json/examples/Admin without Inbox access"]},{"code":"404","description":"Admin not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/404/content/application~1json/examples/Admin not found"]},{"code":"405","description":"Method Not Allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/405/content/application~1json/examples/Admin is a bot"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/405/content/application~1json/examples/Admin is a bot"]}],"pointer":"/paths/~1admins~1{admin_id}~1away/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/parameter_invalid","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_found","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_mandatory","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_required","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_enabled_missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/parameter_invalid","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_found","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_mandatory","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_required","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_not_allowed","paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_enabled_missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/403/content/application~1json/examples/Admin without Inbox access"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/403/content/application~1json/examples/Admin without Inbox access"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/404/content/application~1json/examples/Admin not found"]}}},{"code":"405","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/405/content/application~1json/examples/Admin is a bot"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/405/content/application~1json/examples/Admin is a bot"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/setawayadmin"}],"panels":[]}]},"httpPath":"/admins/{admin_id}/away"},{"label":"List all activity logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/listactivitylogs","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/listactivitylogs","metadata":{"seo":{"title":"List all activity logs","description":"You can get a log of activities by all admins in an app."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivityLogs","name":"List all activity logs","isWebhook":false,"pointer":"/paths/~1admins~1activity_logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all activity logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get a log of activities by all admins in an app."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_at_after","in":"query","schemaId":"schema_1152","description":"The start date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to 30 days before the request.","example":"1677253093"},{"name":"created_at_before","in":"query","schemaId":"schema_1152","description":"The end date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to the time of the request.","example":"1677861493"},{"name":"page","in":"query","schemaId":"schema_1153","description":"The page number of results to return. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1154","description":"The number of results per page. Must be between 1 and 250.","example":20}],"pointer":"/paths/~1admins~1activity_logs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins~1activity_logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admins/activity_logs","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"created_at_after","in":"query","required":false,"example":"1677253093","schemaId":"schema_1152"},{"name":"created_at_before","in":"query","required":false,"example":"1677861493","schemaId":"schema_1152"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1153"},{"name":"per_page","in":"query","required":false,"example":20,"schemaId":"schema_1154"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/admins/activity_logs","href":"admins/listactivitylogs","openApiOperationId":"listActivityLogs","summary":"List all activity logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/event_types not supported","paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/per_page above 250"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/event_types not supported","paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/per_page above 250"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1admins~1activity_logs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/event_types not supported","paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/per_page above 250"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/event_types not supported","paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/per_page above 250"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/listactivitylogs"}],"panels":[]}]},"httpPath":"/admins/activity_logs"},{"label":"Search activity logs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/searchactivitylogs","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/searchactivitylogs","metadata":{"seo":{"title":"Search activity logs","description":"Search and filter admin activity logs using a POST request with event type filter in the request body. You can find more details about the available event types in the List all activity log event types endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchActivityLogs","name":"Search activity logs","isWebhook":false,"pointer":"/paths/~1admins~1activity_logs~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search activity logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and filter admin activity logs using a POST request with event type filter in the request body. You can find more details about the available event types in the List all activity log event types endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are paginated by page number. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body to choose a page. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link in the response is a URL that keeps the query string of the request URL and sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page. It does not include the filters from your request body. To fetch the next page, send a POST request with the same request body to that URL. Query parameters in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL take precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins~1activity_logs~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1155","exampleIds":["paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types","paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters"]}},"schemaId":"schema_1155","exampleIds":["paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types","paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters"],"pointer":"/paths/~1admins~1activity_logs~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admins/activity_logs/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1155","exampleIds":["paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types","paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters"]}},"responseCodes":["200","400","401"],"pointer":"/admins/activity_logs/search","href":"admins/searchactivitylogs","openApiOperationId":"searchActivityLogs","summary":"Search activity logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1155","exampleIds":["paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types","paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1155","exampleIds":["paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types","paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/400/content/application~1json/examples/per_page above 250"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/400/content/application~1json/examples/per_page above 250"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1admins~1activity_logs~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity_log_list","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/400/content/application~1json/examples/per_page above 250"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/400/content/application~1json/examples/per_page above 250"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/searchactivitylogs"}],"panels":[]}]},"httpPath":"/admins/activity_logs/search"},{"label":"List all activity log event types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/listactivitylogeventtypes","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/listactivitylogeventtypes","metadata":{"seo":{"title":"List all activity log event types","description":"You can get a list of all activity log event types. This is useful for discovering valid values to use with the event_types filter on the Search activity logs endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivityLogEventTypes","name":"List all activity log event types","isWebhook":false,"pointer":"/paths/~1admins~1activity_log_event_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all activity log event types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get a list of all activity log event types. This is useful for discovering valid values to use with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter on the Search activity logs endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins~1activity_log_event_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admins/activity_log_event_types","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/admins/activity_log_event_types","href":"admins/listactivitylogeventtypes","openApiOperationId":"listActivityLogEventTypes","summary":"List all activity log event types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity_log_event_type_list","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/activity_log_event_type_list","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1admins~1activity_log_event_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/activity_log_event_type_list","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity_log_event_type_list","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/listactivitylogeventtypes"}],"panels":[]}]},"httpPath":"/admins/activity_log_event_types"},{"label":"List all admins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/listadmins","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/listadmins","metadata":{"seo":{"title":"List all admins","description":"You can fetch a list of admins for a given workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAdmins","name":"List all admins","isWebhook":false,"pointer":"/paths/~1admins/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all admins","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of admins for a given workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"display_avatar","in":"query","schemaId":"schema_1156","description":"If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false.","example":true}],"pointer":"/paths/~1admins/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admins","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"display_avatar","in":"query","required":false,"example":true,"schemaId":"schema_1156"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/admins","href":"admins/listadmins","openApiOperationId":"listAdmins","summary":"List all admins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin_list","exampleIds":["paths/~1admins/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/admin_list","exampleIds":["paths/~1admins/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1admins/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin_list","exampleIds":["paths/~1admins/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin_list","exampleIds":["paths/~1admins/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/listadmins"}],"panels":[]}]},"httpPath":"/admins"},{"label":"Retrieve an admin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/retrieveadmin","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/retrieveadmin","metadata":{"seo":{"title":"Retrieve an admin","description":"You can retrieve the details of a single admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAdmin","name":"Retrieve an admin","isWebhook":false,"pointer":"/paths/~1admins~1{admin_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an admin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the details of a single admin."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_single_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"admin_id","in":"path","schemaId":"schema_1150","description":"The unique identifier of a given admin","required":true,"example":123}],"pointer":"/paths/~1admins~1{admin_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins~1{admin_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admins/{admin_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"admin_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/admins/{admin_id}","href":"admins/retrieveadmin","openApiOperationId":"retrieveAdmin","summary":"Retrieve an admin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Admin found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}/get/responses/200/content/application~1json/examples/Admin found"]}},"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}/get/responses/200/content/application~1json/examples/Admin found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Admin not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1admins~1{admin_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}/get/responses/200/content/application~1json/examples/Admin found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{admin_id}/get/responses/200/content/application~1json/examples/Admin found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/retrieveadmin"}],"panels":[]}]},"httpPath":"/admins/{admin_id}"},{"label":"Remove an admin","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/admins/removeadmin","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/removeadmin","metadata":{"seo":{"title":"Remove an admin","description":"You can remove a single admin (teammate) from your workspace.Requires the remove_admins OAuth scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeAdmin","name":"Remove an admin","isWebhook":false,"pointer":"/paths/~1admins~1remove/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an admin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can remove a single admin (teammate) from your workspace."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This removes the admin's access to the workspace. In most cases their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"work is reassigned to the IDs given in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reassign_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. In"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspaces with more than one seat type, no reassignment happens if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin has no seat, a Collaborator seat or a Lite seat."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"admin_id","in":"query","schemaId":"schema_1150","description":"The unique identifier of the admin to remove.","required":true,"example":123},{"name":"reassign_messages_admin_id","in":"query","schemaId":"schema_1150","description":"The unique identifier of a human admin to reassign the removed admin's auto-message ownership to.","required":true,"example":456},{"name":"reassign_owner_admin_id","in":"query","schemaId":"schema_1150","description":"The unique identifier of a human admin to reassign the removed admin's ownership (of users and leads) to.","required":true,"example":456},{"name":"reassign_articles_author_id","in":"query","schemaId":"schema_1150","description":"The unique identifier of a human admin to reassign the removed admin's article authorship to.","required":true,"example":456},{"name":"reassign_conversations_admin_id","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of an admin with Inbox access, or a team, to reassign the removed admin's conversation replies to. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to leave conversations unassigned."},"children":[]}]}]}],"required":true,"example":456},{"name":"reassign_replies_teams","in":"query","schemaId":"schema_1157","description":"A list of teams and the admin each team's conversation replies should be reassigned to."}],"pointer":"/paths/~1admins~1remove/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1admins~1remove/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/admins/remove","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"admin_id","in":"query","required":true,"example":123,"schemaId":"schema_1150"},{"name":"reassign_messages_admin_id","in":"query","required":true,"example":456,"schemaId":"schema_1150"},{"name":"reassign_owner_admin_id","in":"query","required":true,"example":456,"schemaId":"schema_1150"},{"name":"reassign_articles_author_id","in":"query","required":true,"example":456,"schemaId":"schema_1150"},{"name":"reassign_conversations_admin_id","in":"query","required":true,"example":456,"schemaId":"schema_1150"},{"name":"reassign_replies_teams","in":"query","required":false,"schemaId":"schema_1157"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","405"],"pointer":"/admins/remove","href":"admins/removeadmin","openApiOperationId":"removeAdmin","summary":"Remove an admin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1158","exampleIds":["paths/~1admins~1remove/delete/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"schema_1158","exampleIds":["paths/~1admins~1remove/delete/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reassign_conversations_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to an admin without Inbox access for the workspace. This includes teammates with a Lite seat."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin not found. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reassign_conversations_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is missing, or doesn't match an admin or team, returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the message \"Resource Not Found\"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/404/content/application~1json/examples/Admin not found"]},{"code":"405","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method Not Allowed. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reassign_messages_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reassign_owner_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reassign_articles_author_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to a bot. A team ID in any of these four parameters returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/405/content/application~1json/examples/Method Not Allowed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/405/content/application~1json/examples/Method Not Allowed"]}],"pointer":"/paths/~1admins~1remove/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1158","exampleIds":["paths/~1admins~1remove/delete/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1158","exampleIds":["paths/~1admins~1remove/delete/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/404/content/application~1json/examples/Admin not found"]}}},{"code":"405","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/405/content/application~1json/examples/Method Not Allowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1remove/delete/responses/405/content/application~1json/examples/Method Not Allowed"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/removeadmin"}],"panels":[]}]},"httpPath":"/admins/remove"},{"type":"link","label":"Activity Log Event Types","link":"/docs/references/rest-api/api.intercom.io/admins/activity_log_event_type_list","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/activity_log_event_type_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"activity_log_event_type_list"},"seo":{"title":"Activity Log Event Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity Log Event Types","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/activity_log_event_type_list"},"children":[]}]}]}},{"type":"link","label":"Admin","link":"/docs/references/rest-api/api.intercom.io/admins/admin","routeSlug":"/docs/references/rest-api/api.intercom.io/admins/admin","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"admin"},"seo":{"title":"Admin"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/admin"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Admins"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admins","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Admins"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Activity Log Event Types","link":"/admins/activity_log_event_type_list","deprecated":false},{"title":"Admin","link":"/admins/admin","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/me","summary":"Identify an admin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/identifyadmin","deprecated":false},{"title":"/admins/{admin_id}/away","summary":"Set an admin to away","prefix":{"name":"put","color":"put"},"badges":[],"link":"/admins/setawayadmin","deprecated":false},{"title":"/admins/activity_logs","summary":"List all activity logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/listactivitylogs","deprecated":false},{"title":"/admins/activity_logs/search","summary":"Search activity logs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admins/searchactivitylogs","deprecated":false},{"title":"/admins/activity_log_event_types","summary":"List all activity log event types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/listactivitylogeventtypes","deprecated":false},{"title":"/admins","summary":"List all admins","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/listadmins","deprecated":false},{"title":"/admins/{admin_id}","summary":"Retrieve an admin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/retrieveadmin","deprecated":false},{"title":"/admins/remove","summary":"Remove an admin","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/admins/removeadmin","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Content","link":"/docs/references/rest-api/api.intercom.io/ai-content","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content","items":[{"label":"List content import sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/listcontentimportsources","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/listcontentimportsources","metadata":{"seo":{"title":"List content import sources","description":"You can retrieve a list of all content import sources for a workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContentImportSources","name":"List content import sources","isWebhook":false,"pointer":"/paths/~1ai~1content_import_sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List content import sources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve a list of all content import sources for a workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.total_pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are worked out from every content import source in the workspace, including deleted ones that the list leaves out, so both can be higher than the number of sources you get back across all pages. The last pages can be short or empty."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1159","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1160","description":"The number of results to return per page. Maximum 150.","example":50}],"pointer":"/paths/~1ai~1content_import_sources/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1content_import_sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ai/content_import_sources","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_1159"},{"name":"per_page","in":"query","example":50,"schemaId":"schema_1160"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/ai/content_import_sources","href":"ai-content/listcontentimportsources","openApiOperationId":"listContentImportSources","summary":"List content import sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_sources_list","exampleIds":["paths/~1ai~1content_import_sources/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/content_import_sources_list","exampleIds":["paths/~1ai~1content_import_sources/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Page size too large"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Page size too large"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1ai~1content_import_sources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_import_sources_list","exampleIds":["paths/~1ai~1content_import_sources/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_sources_list","exampleIds":["paths/~1ai~1content_import_sources/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Page size too large"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Page size too large"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/listcontentimportsources"}],"panels":[]}]},"httpPath":"/ai/content_import_sources"},{"label":"Create a content import source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/createcontentimportsource","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/createcontentimportsource","metadata":{"seo":{"title":"Create a content import source","description":"You can create a new content import source by sending a POST request to this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContentImportSource","name":"Create a content import source","isWebhook":false,"pointer":"/paths/~1ai~1content_import_sources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a content import source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new content import source by sending a POST request to this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1content_import_sources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/create_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ai~1content_import_sources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ai/content_import_sources","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401"],"pointer":"/ai/content_import_sources","href":"ai-content/createcontentimportsource","openApiOperationId":"createContentImportSource","summary":"Create a content import source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid URL","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid URL","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid audience IDs"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1ai~1content_import_sources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid URL","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid URL","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid audience IDs"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/createcontentimportsource"}],"panels":[]}]},"httpPath":"/ai/content_import_sources"},{"label":"Delete a content import source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/deletecontentimportsource","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/deletecontentimportsource","metadata":{"seo":{"title":"Delete a content import source","description":"You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContentImportSource","name":"Delete a content import source","isWebhook":false,"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a content import source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"source_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content import source which is given by Intercom.","required":true}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ai/content_import_sources/{source_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"source_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/ai/content_import_sources/{source_id}","href":"ai-content/deletecontentimportsource","openApiOperationId":"deleteContentImportSource","summary":"Delete a content import source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"successful"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content import source not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/404/content/application~1json/examples/Content import source not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/404/content/application~1json/examples/Content import source not found"]}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/404/content/application~1json/examples/Content import source not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/404/content/application~1json/examples/Content import source not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/deletecontentimportsource"}],"panels":[]}]},"httpPath":"/ai/content_import_sources/{source_id}"},{"label":"Retrieve a content import source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/getcontentimportsource","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/getcontentimportsource","metadata":{"seo":{"title":"Retrieve a content import source","description":"You can retrieve a content import source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContentImportSource","name":"Retrieve a content import source","isWebhook":false,"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a content import source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve a content import source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"source_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content import source which is given by Intercom.","required":true}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ai/content_import_sources/{source_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"source_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/ai/content_import_sources/{source_id}","href":"ai-content/getcontentimportsource","openApiOperationId":"getContentImportSource","summary":"Retrieve a content import source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content import source not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/404/content/application~1json/examples/Content import source not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/404/content/application~1json/examples/Content import source not found"]}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/404/content/application~1json/examples/Content import source not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/404/content/application~1json/examples/Content import source not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/getcontentimportsource"}],"panels":[]}]},"httpPath":"/ai/content_import_sources/{source_id}"},{"label":"Update a content import source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/updatecontentimportsource","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/updatecontentimportsource","metadata":{"seo":{"title":"Update a content import source","description":"You can update an existing content import source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContentImportSource","name":"Update a content import source","isWebhook":false,"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a content import source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing content import source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"source_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content import source which is given by Intercom.","required":true}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/update_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ai/content_import_sources/{source_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"source_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/ai/content_import_sources/{source_id}","href":"ai-content/updatecontentimportsource","openApiOperationId":"updateContentImportSource","summary":"Update a content import source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_content_import_source_request","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Invalid audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Invalid audience IDs"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content import source not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/404/content/application~1json/examples/Content import source not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/404/content/application~1json/examples/Content import source not found"]}],"pointer":"/paths/~1ai~1content_import_sources~1{source_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_import_source","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Invalid audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Sync behavior must be api","paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Invalid audience IDs"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/404/content/application~1json/examples/Content import source not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/404/content/application~1json/examples/Content import source not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/updatecontentimportsource"}],"panels":[]}]},"httpPath":"/ai/content_import_sources/{source_id}"},{"label":"List external pages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/listexternalpages","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/listexternalpages","metadata":{"seo":{"title":"List external pages","description":"You can retrieve a list of all external pages for a workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExternalPages","name":"List external pages","isWebhook":false,"pointer":"/paths/~1ai~1external_pages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List external pages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve a list of all external pages for a workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1159","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of results to fetch. Defaults to the first page. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot exceed 5,001, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot exceed 10,000. Past 5,001 the API returns a 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error; past 10,000 results it returns a 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bad_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with the message "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page limit reached, please use scroll API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1160","description":"The number of results to return per page. Maximum 150.","example":50}],"pointer":"/paths/~1ai~1external_pages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ai/external_pages","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_1159"},{"name":"per_page","in":"query","example":50,"schemaId":"schema_1160"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/ai/external_pages","href":"ai-content/listexternalpages","openApiOperationId":"listExternalPages","summary":"List external pages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_pages_list","exampleIds":["paths/~1ai~1external_pages/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/external_pages_list","exampleIds":["paths/~1ai~1external_pages/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page size too large","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page limit exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page size too large","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page limit exceeded"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1ai~1external_pages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/external_pages_list","exampleIds":["paths/~1ai~1external_pages/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_pages_list","exampleIds":["paths/~1ai~1external_pages/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page size too large","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page limit exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Invalid page","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page size too large","paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page limit exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/listexternalpages"}],"panels":[]}]},"httpPath":"/ai/external_pages"},{"label":"Create an external page (or update an external page by external ID)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/createexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/createexternalpage","metadata":{"seo":{"title":"Create an external page (or update an external page by external ID)","description":"You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExternalPage","name":"Create an external page (or update an external page by external ID)","isWebhook":false,"pointer":"/paths/~1ai~1external_pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an external page (or update an external page by external ID)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_external_page_request","exampleIds":["paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/create_external_page_request","exampleIds":["paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ai~1external_pages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ai/external_pages","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_external_page_request","exampleIds":["paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/ai/external_pages","href":"ai-content/createexternalpage","openApiOperationId":"createExternalPage","summary":"Create an external page (or update an external page by external ID)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_external_page_request","exampleIds":["paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_external_page_request","exampleIds":["paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Source is not an API source"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Source is not an API source"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content import source or audience not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}],"pointer":"/paths/~1ai~1external_pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Source is not an API source"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Source is not an API source"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Unknown audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/createexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages"},{"label":"Delete an external page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/deleteexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/deleteexternalpage","metadata":{"seo":{"title":"Delete an external page","description":"Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExternalPage","name":"Delete an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{page_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ai/external_pages/{page_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"page_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/ai/external_pages/{page_id}","href":"ai-content/deleteexternalpage","openApiOperationId":"deleteExternalPage","summary":"Delete an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"External page not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/404/content/application~1json/examples/External page not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/404/content/application~1json/examples/External page not found"]}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/404/content/application~1json/examples/External page not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/404/content/application~1json/examples/External page not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/deleteexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{page_id}"},{"label":"Retrieve an external page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/getexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/getexternalpage","metadata":{"seo":{"title":"Retrieve an external page","description":"You can retrieve an external page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExternalPage","name":"Retrieve an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{page_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve an external page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ai/external_pages/{page_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"page_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/ai/external_pages/{page_id}","href":"ai-content/getexternalpage","openApiOperationId":"getExternalPage","summary":"Retrieve an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"External page not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/404/content/application~1json/examples/External page not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/404/content/application~1json/examples/External page not found"]}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/404/content/application~1json/examples/External page not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/404/content/application~1json/examples/External page not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/getexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{page_id}"},{"label":"Update an external page","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/updateexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/updateexternalpage","metadata":{"seo":{"title":"Update an external page","description":"You can update an existing external page (if it was created via the API)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExternalPage","name":"Update an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{page_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing external page (if it was created via the API)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_external_page_request","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/update_external_page_request","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ai~1external_pages~1{page_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ai/external_pages/{page_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"page_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_external_page_request","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/ai/external_pages/{page_id}","href":"ai-content/updateexternalpage","openApiOperationId":"updateExternalPage","summary":"Update an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_external_page_request","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_external_page_request","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Source cannot be changed","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Unsupported locale"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Source cannot be changed","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Unsupported locale"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"External page, content import source or audience not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}],"pointer":"/paths/~1ai~1external_pages~1{page_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_page","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Source cannot be changed","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Unsupported locale"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Missing parameter","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Source cannot be changed","paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Unsupported locale"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Content import source not found","paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/updateexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{page_id}"},{"label":"Add a tag to an external page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/attachtagtoexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/attachtagtoexternalpage","metadata":{"seo":{"title":"Add a tag to an external page","description":"Apply an existing tag to an external page. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToExternalPage","name":"Add a tag to an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to an external page. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission. Pages uploaded as files can't be tagged and return a 404."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true,"example":"1234"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ai/external_pages/{external_page_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"external_page_id","in":"path","required":true,"example":"1234","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/ai/external_pages/{external_page_id}/tags","href":"ai-content/attachtagtoexternalpage","openApiOperationId":"attachTagToExternalPage","summary":"Add a tag to an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"External page, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/attachtagtoexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{external_page_id}/tags"},{"label":"Remove a tag from an external page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ai-content/detachtagfromexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/detachtagfromexternalpage","metadata":{"seo":{"title":"Remove a tag from an external page","description":"Remove a tag from an external page. Returns the tag that was removed, with nullapplied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromExternalPage","name":"Remove a tag from an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from an external page. Returns the tag that was removed, with null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission. Pages uploaded as files can't be tagged and return a 404."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true,"example":"1234"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ai/external_pages/{external_page_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"external_page_id","in":"path","required":true,"example":"1234","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/ai/external_pages/{external_page_id}/tags/{id}","href":"ai-content/detachtagfromexternalpage","openApiOperationId":"detachTagFromExternalPage","summary":"Remove a tag from an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"External page or tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/detachtagfromexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{external_page_id}/tags/{id}"},{"type":"link","label":"Content Import Source","link":"/docs/references/rest-api/api.intercom.io/ai-content/content_import_source","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/content_import_source","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_import_source"},"seo":{"title":"Content Import Source"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Import Source","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_import_source"},"children":[]}]}]}},{"type":"link","label":"Content Import Sources","link":"/docs/references/rest-api/api.intercom.io/ai-content/content_import_sources_list","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/content_import_sources_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_import_sources_list"},"seo":{"title":"Content Import Sources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Import Sources","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_import_sources_list"},"children":[]}]}]}},{"type":"link","label":"External Page","link":"/docs/references/rest-api/api.intercom.io/ai-content/external_page","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/external_page","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"external_page"},"seo":{"title":"External Page"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Page","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/external_page"},"children":[]}]}]}},{"type":"link","label":"External Pages","link":"/docs/references/rest-api/api.intercom.io/ai-content/external_pages_list","routeSlug":"/docs/references/rest-api/api.intercom.io/ai-content/external_pages_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"external_pages_list"},"seo":{"title":"External Pages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Pages","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/external_pages_list"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"AI Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Content","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External Pages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Import Sources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.\","},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Content Import Source","link":"/ai-content/content_import_source","deprecated":false},{"title":"Content Import Sources","link":"/ai-content/content_import_sources_list","deprecated":false},{"title":"External Page","link":"/ai-content/external_page","deprecated":false},{"title":"External Pages","link":"/ai-content/external_pages_list","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ai/content_import_sources","summary":"List content import sources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-content/listcontentimportsources","deprecated":false},{"title":"/ai/content_import_sources","summary":"Create a content import source","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-content/createcontentimportsource","deprecated":false},{"title":"/ai/content_import_sources/{source_id}","summary":"Delete a content import source","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ai-content/deletecontentimportsource","deprecated":false},{"title":"/ai/content_import_sources/{source_id}","summary":"Retrieve a content import source","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-content/getcontentimportsource","deprecated":false},{"title":"/ai/content_import_sources/{source_id}","summary":"Update a content import source","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ai-content/updatecontentimportsource","deprecated":false},{"title":"/ai/external_pages","summary":"List external pages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-content/listexternalpages","deprecated":false},{"title":"/ai/external_pages","summary":"Create an external page (or update an external page by external ID)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-content/createexternalpage","deprecated":false},{"title":"/ai/external_pages/{page_id}","summary":"Delete an external page","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ai-content/deleteexternalpage","deprecated":false},{"title":"/ai/external_pages/{page_id}","summary":"Retrieve an external page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-content/getexternalpage","deprecated":false},{"title":"/ai/external_pages/{page_id}","summary":"Update an external page","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ai-content/updateexternalpage","deprecated":false},{"title":"/ai/external_pages/{external_page_id}/tags","summary":"Add a tag to an external page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-content/attachtagtoexternalpage","deprecated":false},{"title":"/ai/external_pages/{external_page_id}/tags/{id}","summary":"Remove a tag from an external page","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ai-content/detachtagfromexternalpage","deprecated":false}]}]}]}]}},{"type":"group","label":"Articles","link":"/docs/references/rest-api/api.intercom.io/articles","routeSlug":"/docs/references/rest-api/api.intercom.io/articles","items":[{"label":"List all articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/listarticles","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/listarticles","metadata":{"seo":{"title":"List all articles","description":"You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listArticles","name":"List all articles","isWebhook":false,"pointer":"/paths/~1articles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all articles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all articles by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 How are the articles sorted and ordered?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Articles will be returned in descending order on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. This means if you need to iterate through results then we'll show the most recently updated articles first."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1162","description":"The number of results to return per page. Defaults to 25. Maximum is 250.","example":25}],"pointer":"/paths/~1articles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":25,"schemaId":"schema_1162"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/articles","href":"articles/listarticles","openApiOperationId":"listArticles","summary":"List all articles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_list","exampleIds":["paths/~1articles/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/article_list","exampleIds":["paths/~1articles/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/400/content/application~1json/examples/Per page too large"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/400/content/application~1json/examples/Per page too large"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1articles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article_list","exampleIds":["paths/~1articles/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_list","exampleIds":["paths/~1articles/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/400/content/application~1json/examples/Per page too large"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/400/content/application~1json/examples/Per page too large"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/listarticles"}],"panels":[]}]},"httpPath":"/articles"},{"label":"Create an article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/createarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/createarticle","metadata":{"seo":{"title":"Create an article","description":"You can create a new article by making a POST request to https://api.intercom.io/articles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createArticle","name":"Create an article","isWebhook":false,"pointer":"/paths/~1articles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new article by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 Tags are managed separately"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are returned in article responses but cannot be set in the request body. To add or remove an article's tags, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /articles/{article_id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /articles/{article_id}/tags/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_article_request","exampleIds":["paths/~1articles/post/requestBody/content/application~1json/examples/article_created","paths/~1articles/post/requestBody/content/application~1json/examples/bad_request"]}},"schemaId":"components/schemas/create_article_request","exampleIds":["paths/~1articles/post/requestBody/content/application~1json/examples/article_created","paths/~1articles/post/requestBody/content/application~1json/examples/bad_request"],"pointer":"/paths/~1articles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/articles","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_article_request","exampleIds":["paths/~1articles/post/requestBody/content/application~1json/examples/article_created","paths/~1articles/post/requestBody/content/application~1json/examples/bad_request"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/articles","href":"articles/createarticle","openApiOperationId":"createArticle","summary":"Create an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_article_request","exampleIds":["paths/~1articles/post/requestBody/content/application~1json/examples/article_created","paths/~1articles/post/requestBody/content/application~1json/examples/bad_request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_article_request","exampleIds":["paths/~1articles/post/requestBody/content/application~1json/examples/article_created","paths/~1articles/post/requestBody/content/application~1json/examples/bad_request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"article created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles/post/responses/200/content/application~1json/examples/article created"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles/post/responses/200/content/application~1json/examples/article created"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. A JSON request whose body is an empty object returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no response body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request","paths/~1articles/post/responses/400/content/application~1json/examples/Missing title","paths/~1articles/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles/post/responses/400/content/application~1json/examples/Collection not found","paths/~1articles/post/responses/400/content/application~1json/examples/Publish time in the past"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request","paths/~1articles/post/responses/400/content/application~1json/examples/Missing title","paths/~1articles/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles/post/responses/400/content/application~1json/examples/Collection not found","paths/~1articles/post/responses/400/content/application~1json/examples/Publish time in the past"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles/post/responses/401/content/application~1json/examples/Author not authorised"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles/post/responses/401/content/application~1json/examples/Author not authorised"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found: the author, an audience, the folder or a collection in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not exist."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/404/content/application~1json/examples/Author not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/404/content/application~1json/examples/Author not found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles/post/responses/422/content/application~1json/examples/Invalid availability value"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles/post/responses/422/content/application~1json/examples/Invalid availability value"]}],"pointer":"/paths/~1articles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles/post/responses/200/content/application~1json/examples/article created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles/post/responses/200/content/application~1json/examples/article created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request","paths/~1articles/post/responses/400/content/application~1json/examples/Missing title","paths/~1articles/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles/post/responses/400/content/application~1json/examples/Collection not found","paths/~1articles/post/responses/400/content/application~1json/examples/Publish time in the past"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request","paths/~1articles/post/responses/400/content/application~1json/examples/Missing title","paths/~1articles/post/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles/post/responses/400/content/application~1json/examples/Collection not found","paths/~1articles/post/responses/400/content/application~1json/examples/Publish time in the past"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles/post/responses/401/content/application~1json/examples/Author not authorised"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles/post/responses/401/content/application~1json/examples/Author not authorised"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/404/content/application~1json/examples/Author not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/404/content/application~1json/examples/Author not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles/post/responses/422/content/application~1json/examples/Invalid availability value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles/post/responses/422/content/application~1json/examples/Invalid availability value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/createarticle"}],"panels":[]}]},"httpPath":"/articles"},{"label":"Retrieve an article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/retrievearticle","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/retrievearticle","metadata":{"seo":{"title":"Retrieve an article","description":"You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveArticle","name":"Retrieve an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single article by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{article_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles/{article_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/articles/{article_id}","href":"articles/retrievearticle","openApiOperationId":"retrieveArticle","summary":"Retrieve an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Article found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/get/responses/200/content/application~1json/examples/Article found"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/get/responses/200/content/application~1json/examples/Article found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Article not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/404/content/application~1json/examples/Article not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/404/content/application~1json/examples/Article not found"]}],"pointer":"/paths/~1articles~1{article_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/get/responses/200/content/application~1json/examples/Article found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/get/responses/200/content/application~1json/examples/Article found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/404/content/application~1json/examples/Article not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/get/responses/404/content/application~1json/examples/Article not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/retrievearticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}"},{"label":"Update an article","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/updatearticle","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/updatearticle","metadata":{"seo":{"title":"Update an article","description":"You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateArticle","name":"Update an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update the details of a single article by making a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 Tags are managed separately"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are returned in article responses but cannot be set in the request body. To add or remove an article's tags, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /articles/{article_id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /articles/{article_id}/tags/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{article_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found"]}},"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found"],"pointer":"/paths/~1articles~1{article_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/articles/{article_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/articles/{article_id}","href":"articles/updatearticle","openApiOperationId":"updateArticle","summary":"Update an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. A JSON request whose body is an empty object returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no response body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish and unpublish in the same request","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish time in the past","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unpublish on an article that is not published","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Collection not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish and unpublish in the same request","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish time in the past","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unpublish on an article that is not published","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Collection not found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Author not authorised"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Author not authorised"]},{"code":"404","description":"Article Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found","paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Author not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found","paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Author not found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Invalid availability value"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Invalid availability value"]}],"pointer":"/paths/~1articles~1{article_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{article_id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish and unpublish in the same request","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish time in the past","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unpublish on an article that is not published","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Collection not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish and unpublish in the same request","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish time in the past","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unpublish on an article that is not published","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unsupported locale","paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Collection not found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Author not authorised"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Author not authorised"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found","paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Author not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found","paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Author not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Invalid availability value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Body and body_markdown both provided","paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Invalid availability value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/updatearticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}"},{"label":"Delete an article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/deletearticle","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/deletearticle","metadata":{"seo":{"title":"Delete an article","description":"You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteArticle","name":"Delete an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single article by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{article_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/articles/{article_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/articles/{article_id}","href":"articles/deletearticle","openApiOperationId":"deleteArticle","summary":"Delete an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_article_object","exampleIds":["paths/~1articles~1{article_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_article_object","exampleIds":["paths/~1articles~1{article_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Article Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/404/content/application~1json/examples/Article Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/404/content/application~1json/examples/Article Not Found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article has dependent procedures","paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article is referenced elsewhere"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article has dependent procedures","paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article is referenced elsewhere"]}],"pointer":"/paths/~1articles~1{article_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_article_object","exampleIds":["paths/~1articles~1{article_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_article_object","exampleIds":["paths/~1articles~1{article_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/404/content/application~1json/examples/Article Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/404/content/application~1json/examples/Article Not Found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article has dependent procedures","paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article is referenced elsewhere"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article has dependent procedures","paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article is referenced elsewhere"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/deletearticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}"},{"label":"Retrieve an article draft","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/retrievearticledraft","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/retrievearticledraft","metadata":{"seo":{"title":"Retrieve an article draft","description":"Fetch the staged draft of a published article by making a GET request tohttps://api.intercom.io/articles/<id>/draft. The response is the articlerendered with its draft content, leaving the live article untouched."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveArticleDraft","name":"Retrieve an article draft","isWebhook":false,"pointer":"/paths/~1articles~1{id}~1draft/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an article draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the staged draft of a published article by making a GET request to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<id>/draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response is the article"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rendered with its draft content, leaving the live article untouched."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A draft exists only when a published article has unpublished changes staged"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on top of it. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty response body when the article"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has no staged draft. An article ID that doesn't exist returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the standard error body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{id}~1draft/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{id}~1draft/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles/{id}/draft","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/articles/{id}/draft","href":"articles/retrievearticledraft","openApiOperationId":"retrieveArticleDraft","summary":"Retrieve an article draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Article draft found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/200/content/application~1json/examples/Article draft found"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/200/content/application~1json/examples/Article draft found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"pointer":"/paths/~1articles~1{id}~1draft/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/200/content/application~1json/examples/Article draft found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/200/content/application~1json/examples/Article draft found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/retrievearticledraft"}],"panels":[]}]},"httpPath":"/articles/{id}/draft"},{"label":"Stage an article draft","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/stagearticledraft","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/stagearticledraft","metadata":{"seo":{"title":"Stage an article draft","description":"Stage changes to a published article as a draft by making a PUT request tohttps://api.intercom.io/articles/<id>/draft. The live article remainsunchanged until the draft is published."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stageArticleDraft","name":"Stage an article draft","isWebhook":false,"pointer":"/paths/~1articles~1{id}~1draft/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stage an article draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stage changes to a published article as a draft by making a PUT request to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<id>/draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The live article remains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unchanged until the draft is published."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The article must already be published; staging a draft on an article that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has never been published returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". That "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the short body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"errors\": [{ \"message\": \"...\", \"status\": 422 }] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" errors use the standard error format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only text content is staged: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"author_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including per-locale values in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Any other field in the request body, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folder_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the AI availability fields or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduling fields, is still validated but not applied, so the live article is left untouched. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduling, state and placement notes on the request schema's other fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"do not apply to this endpoint, because those fields are not applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{id}~1draft/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{id}~1draft/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged"]}},"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged"],"pointer":"/paths/~1articles~1{id}~1draft/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/articles/{id}/draft","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged"]}},"responseCodes":["200","401","404","422"],"pointer":"/articles/{id}/draft","href":"articles/stagearticledraft","openApiOperationId":"stageArticleDraft","summary":"Stage an article draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Draft staged","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/200/content/application~1json/examples/Draft staged"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/200/content/application~1json/examples/Draft staged"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/IntegrationNotFound"]},{"code":"422","description":"Article is not published, or a requested locale is not published","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article not published","paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Locale not published"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article not published","paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Locale not published"]}],"pointer":"/paths/~1articles~1{id}~1draft/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/200/content/application~1json/examples/Draft staged"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/200/content/application~1json/examples/Draft staged"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/IntegrationNotFound"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article not published","paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Locale not published"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article not published","paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Locale not published"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/stagearticledraft"}],"panels":[]}]},"httpPath":"/articles/{id}/draft"},{"label":"Publish an article draft","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/publisharticledraft","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/publisharticledraft","metadata":{"seo":{"title":"Publish an article draft","description":"Publish a staged draft by making a POST request tohttps://api.intercom.io/articles/<id>/draft/publish, promoting the draftcontent to live."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"publishArticleDraft","name":"Publish an article draft","isWebhook":false,"pointer":"/paths/~1articles~1{id}~1draft~1publish/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish an article draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publish a staged draft by making a POST request to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<id>/draft/publish"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", promoting the draft"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content to live."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On a single-language workspace no body is required. On a multilingual"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspace you must list which locales to publish via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omitting it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when there is no staged draft to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"publish, or when a requested locale has no pending changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for no staged draft has the short body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"errors\": [{ \"message\": \"...\", \"status\": 422 }] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" errors use the standard error format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{id}~1draft~1publish/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{id}~1draft~1publish/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/publish_article_draft_request","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales"]}},"schemaId":"components/schemas/publish_article_draft_request","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales"],"pointer":"/paths/~1articles~1{id}~1draft~1publish/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/articles/{id}/draft/publish","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/publish_article_draft_request","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales"]}},"responseCodes":["200","401","404","422"],"pointer":"/articles/{id}/draft/publish","href":"articles/publisharticledraft","openApiOperationId":"publishArticleDraft","summary":"Publish an article draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/publish_article_draft_request","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/publish_article_draft_request","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Draft published","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/200/content/application~1json/examples/Draft published"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/200/content/application~1json/examples/Draft published"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/IntegrationNotFound"]},{"code":"422","description":"No draft to publish, locales not specified on a multilingual workspace, or a requested locale has no pending changes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/No draft to publish","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locales required on a multilingual workspace","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locale has no pending changes"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/No draft to publish","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locales required on a multilingual workspace","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locale has no pending changes"]}],"pointer":"/paths/~1articles~1{id}~1draft~1publish/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/200/content/application~1json/examples/Draft published"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/200/content/application~1json/examples/Draft published"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/IntegrationNotFound"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/No draft to publish","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locales required on a multilingual workspace","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locale has no pending changes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/No draft to publish","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locales required on a multilingual workspace","paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locale has no pending changes"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/publisharticledraft"}],"panels":[]}]},"httpPath":"/articles/{id}/draft/publish"},{"label":"Add a tag to an article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/attachtagtoarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/attachtagtoarticle","metadata":{"seo":{"title":"Add a tag to an article","description":"Apply an existing tag to an article. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToArticle","name":"Add a tag to an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to an article. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1articles~1{article_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/articles/{article_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/articles/{article_id}/tags","href":"articles/attachtagtoarticle","openApiOperationId":"attachTagToArticle","summary":"Add a tag to an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Article, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1articles~1{article_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/attachtagtoarticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}/tags"},{"label":"Remove a tag from an article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/detachtagfromarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/detachtagfromarticle","metadata":{"seo":{"title":"Remove a tag from an article","description":"Remove a tag from an article. Returns the tag that was removed, with nullapplied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromArticle","name":"Remove a tag from an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from an article. Returns the tag that was removed, with null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/articles/{article_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/articles/{article_id}/tags/{id}","href":"articles/detachtagfromarticle","openApiOperationId":"detachTagFromArticle","summary":"Remove a tag from an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Article or tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/detachtagfromarticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}/tags/{id}"},{"label":"List article versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/listarticleversions","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/listarticleversions","metadata":{"seo":{"title":"List article versions","description":"Fetch the version history of an article by making a GET request tohttps://api.intercom.io/articles/<article_id>/versions. Versions arereturned newest-first as a paginated list of metadata. UseGET /articles/{article_id}/versions/{id} to retrieve a single versionwith its full content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listArticleVersions","name":"List article versions","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List article versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the version history of an article by making a GET request to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<article_id>/versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Versions are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned newest-first as a paginated list of metadata. Use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /articles/{article_id}/versions/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve a single version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with its full content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has an empty response body, whether the article or its content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isn't found."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article whose versions you are listing.","required":true,"example":123}],"pointer":"/paths/~1articles~1{article_id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":"The number of results to return per page. Defaults to 10.","example":10},{"name":"locale","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter versions to a specific locale. Use the locale identifier (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If the article has no content in that locale, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]}],"example":"en"}],"pointer":"/paths/~1articles~1{article_id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles/{article_id}/versions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_1150"},{"name":"locale","in":"query","required":false,"example":"en","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/articles/{article_id}/versions","href":"articles/listarticleversions","openApiOperationId":"listArticleVersions","summary":"List article versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Versions found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_version_list","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/200/content/application~1json/examples/Versions found"]}},"schemaId":"components/schemas/article_version_list","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/200/content/application~1json/examples/Versions found"]},{"code":"400","description":"No content for the requested locale","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/No content for locale"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/No content for locale"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"pointer":"/paths/~1articles~1{article_id}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article_version_list","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/200/content/application~1json/examples/Versions found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_version_list","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/200/content/application~1json/examples/Versions found"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/No content for locale"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/No content for locale"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/listarticleversions"}],"panels":[]}]},"httpPath":"/articles/{article_id}/versions"},{"label":"Retrieve an article version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/retrievearticleversion","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/retrievearticleversion","metadata":{"seo":{"title":"Retrieve an article version","description":"Fetch a single prior version of an article, including its body content,by making a GET request tohttps://api.intercom.io/articles/<article_id>/versions/<id>. Returnsthe version's full content; the live article remains untouched."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveArticleVersion","name":"Retrieve an article version","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}~1versions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an article version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch a single prior version of an article, including its body content,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by making a GET request to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/<article_id>/versions/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the version's full content; the live article remains untouched."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has an empty response body, whether the article, its content or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the version isn't found."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the version.","required":true,"example":"301"}],"pointer":"/paths/~1articles~1{article_id}~1versions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the version's content for a specific locale. If the article has no content in that locale, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]}],"example":"en"}],"pointer":"/paths/~1articles~1{article_id}~1versions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}~1versions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles/{article_id}/versions/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"},{"name":"id","in":"path","required":true,"example":"301","schemaId":"schema_1152"}],"query":[{"name":"locale","in":"query","required":false,"example":"en","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/articles/{article_id}/versions/{id}","href":"articles/retrievearticleversion","openApiOperationId":"retrieveArticleVersion","summary":"Retrieve an article version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Version found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_version","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/200/content/application~1json/examples/Version found"]}},"schemaId":"components/schemas/article_version","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/200/content/application~1json/examples/Version found"]},{"code":"400","description":"No content for the requested locale","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/No content for locale"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/No content for locale"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"pointer":"/paths/~1articles~1{article_id}~1versions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article_version","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/200/content/application~1json/examples/Version found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_version","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/200/content/application~1json/examples/Version found"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/No content for locale"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/No content for locale"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/retrievearticleversion"}],"panels":[]}]},"httpPath":"/articles/{article_id}/versions/{id}"},{"label":"Search for articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/articles/searcharticles","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/searcharticles","metadata":{"seo":{"title":"Search for articles","description":"You can search for articles by making a GET request to https://api.intercom.io/articles/search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchArticles","name":"Search for articles","isWebhook":false,"pointer":"/paths/~1articles~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for articles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for articles by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/articles/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no articles match the search, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an empty array rather than an object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"phrase","in":"query","schemaId":"schema_1164","description":"The phrase within your articles to search for. Maximum length is 500 characters.","example":"Getting started"},{"name":"state","in":"query","schemaId":"schema_1165","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Articles returned. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"published"},{"name":"help_center_id","in":"query","schemaId":"schema_1150","description":"The ID of the Help Center to search in.","example":123},{"name":"highlight","in":"query","schemaId":"schema_1156","description":"Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.","example":false},{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":"The number of results to return per page. Defaults to 10.","example":10}],"pointer":"/paths/~1articles~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"phrase","in":"query","required":false,"example":"Getting started","schemaId":"schema_1164"},{"name":"state","in":"query","required":false,"example":"published","schemaId":"schema_1165"},{"name":"help_center_id","in":"query","required":false,"example":123,"schemaId":"schema_1150"},{"name":"highlight","in":"query","required":false,"example":false,"schemaId":"schema_1156"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_1150"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/articles/search","href":"articles/searcharticles","openApiOperationId":"searchArticles","summary":"Search for articles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_search_response","exampleIds":["paths/~1articles~1search/get/responses/200/content/application~1json/examples/Search successful","paths/~1articles~1search/get/responses/200/content/application~1json/examples/No results"]}},"schemaId":"components/schemas/article_search_response","exampleIds":["paths/~1articles~1search/get/responses/200/content/application~1json/examples/Search successful","paths/~1articles~1search/get/responses/200/content/application~1json/examples/No results"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/400/content/application~1json/examples/Phrase too long","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid state","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid help center","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid pagination"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/400/content/application~1json/examples/Phrase too long","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid state","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid help center","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid pagination"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1articles~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article_search_response","exampleIds":["paths/~1articles~1search/get/responses/200/content/application~1json/examples/Search successful","paths/~1articles~1search/get/responses/200/content/application~1json/examples/No results"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article_search_response","exampleIds":["paths/~1articles~1search/get/responses/200/content/application~1json/examples/Search successful","paths/~1articles~1search/get/responses/200/content/application~1json/examples/No results"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/400/content/application~1json/examples/Phrase too long","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid state","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid help center","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid pagination"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/400/content/application~1json/examples/Phrase too long","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid state","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid help center","paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid pagination"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/searcharticles"}],"panels":[]}]},"httpPath":"/articles/search"},{"type":"link","label":"Article","link":"/docs/references/rest-api/api.intercom.io/articles/article","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/article","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article"},"seo":{"title":"Article"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article"},"children":[]}]}]}},{"type":"link","label":"Articles","link":"/docs/references/rest-api/api.intercom.io/articles/article_list_item","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/article_list_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_list_item"},"seo":{"title":"Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Articles","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_list_item"},"children":[]}]}]}},{"type":"link","label":"Article Search Highlights","link":"/docs/references/rest-api/api.intercom.io/articles/article_search_highlights","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/article_search_highlights","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_search_highlights"},"seo":{"title":"Article Search Highlights"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Search Highlights","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_search_highlights"},"children":[]}]}]}},{"type":"link","label":"Article Search Response","link":"/docs/references/rest-api/api.intercom.io/articles/article_search_response","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/article_search_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_search_response"},"seo":{"title":"Article Search Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Search Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_search_response"},"children":[]}]}]}},{"type":"link","label":"Article Version","link":"/docs/references/rest-api/api.intercom.io/articles/article_version","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/article_version","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_version"},"seo":{"title":"Article Version"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Version","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_version"},"children":[]}]}]}},{"type":"link","label":"Article Version Summary","link":"/docs/references/rest-api/api.intercom.io/articles/article_version_summary","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/article_version_summary","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_version_summary"},"seo":{"title":"Article Version Summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Version Summary","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_version_summary"},"children":[]}]}]}},{"type":"link","label":"Internal Article","link":"/docs/references/rest-api/api.intercom.io/articles/internal_article","routeSlug":"/docs/references/rest-api/api.intercom.io/articles/internal_article","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"internal_article"},"seo":{"title":"Internal Article"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal Article","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/internal_article"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Articles","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Articles"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Article","link":"/articles/article","deprecated":false},{"title":"Articles","link":"/articles/article_list_item","deprecated":false},{"title":"Article Search Highlights","link":"/articles/article_search_highlights","deprecated":false},{"title":"Article Search Response","link":"/articles/article_search_response","deprecated":false},{"title":"Article Version","link":"/articles/article_version","deprecated":false},{"title":"Article Version Summary","link":"/articles/article_version_summary","deprecated":false},{"title":"Internal Article","link":"/articles/internal_article","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/articles","summary":"List all articles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/listarticles","deprecated":false},{"title":"/articles","summary":"Create an article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/articles/createarticle","deprecated":false},{"title":"/articles/{article_id}","summary":"Retrieve an article","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/retrievearticle","deprecated":false},{"title":"/articles/{article_id}","summary":"Update an article","prefix":{"name":"put","color":"put"},"badges":[],"link":"/articles/updatearticle","deprecated":false},{"title":"/articles/{article_id}","summary":"Delete an article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/articles/deletearticle","deprecated":false},{"title":"/articles/{id}/draft","summary":"Retrieve an article draft","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/retrievearticledraft","deprecated":false},{"title":"/articles/{id}/draft","summary":"Stage an article draft","prefix":{"name":"put","color":"put"},"badges":[],"link":"/articles/stagearticledraft","deprecated":false},{"title":"/articles/{id}/draft/publish","summary":"Publish an article draft","prefix":{"name":"post","color":"post"},"badges":[],"link":"/articles/publisharticledraft","deprecated":false},{"title":"/articles/{article_id}/tags","summary":"Add a tag to an article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/articles/attachtagtoarticle","deprecated":false},{"title":"/articles/{article_id}/tags/{id}","summary":"Remove a tag from an article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/articles/detachtagfromarticle","deprecated":false},{"title":"/articles/{article_id}/versions","summary":"List article versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/listarticleversions","deprecated":false},{"title":"/articles/{article_id}/versions/{id}","summary":"Retrieve an article version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/retrievearticleversion","deprecated":false},{"title":"/articles/search","summary":"Search for articles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/searcharticles","deprecated":false}]}]}]}]}},{"type":"group","label":"Audiences","link":"/docs/references/rest-api/api.intercom.io/audiences","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences","items":[{"label":"List all audiences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/audiences/listaudiences","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences/listaudiences","metadata":{"seo":{"title":"List all audiences","description":"You can fetch a list of all audiences for the workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAudiences","name":"List all audiences","isWebhook":false,"pointer":"/paths/~1audiences/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all audiences","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all audiences for the workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to the first page. Values below 1 are treated as 1.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1166","description":"The number of results to return per page. Defaults to 50. Values above 50 are reduced to 50, and values below 1 are treated as 1.","example":50}],"pointer":"/paths/~1audiences/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1audiences/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audiences","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1166"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/audiences","href":"audiences/listaudiences","openApiOperationId":"listAudiences","summary":"List all audiences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience_list","exampleIds":["paths/~1audiences/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/audience_list","exampleIds":["paths/~1audiences/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1audiences/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/audience_list","exampleIds":["paths/~1audiences/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience_list","exampleIds":["paths/~1audiences/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audiences/listaudiences"}],"panels":[]}]},"httpPath":"/audiences"},{"label":"Create an audience","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/audiences/createaudience","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences/createaudience","metadata":{"seo":{"title":"Create an audience","description":"You can create a new audience by making a POST request to https://api.intercom.io/audiences."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAudience","name":"Create an audience","isWebhook":false,"pointer":"/paths/~1audiences/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an audience","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new audience by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1audiences/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_audience_request","exampleIds":["paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created"]}},"schemaId":"components/schemas/create_audience_request","exampleIds":["paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created"],"pointer":"/paths/~1audiences/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/audiences","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_audience_request","exampleIds":["paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created"]}},"responseCodes":["201","401","422"],"pointer":"/audiences","href":"audiences/createaudience","openApiOperationId":"createAudience","summary":"Create an audience"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_audience_request","exampleIds":["paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_audience_request","exampleIds":["paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Audience created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences/post/responses/201/content/application~1json/examples/Audience created"]}},"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences/post/responses/201/content/application~1json/examples/Audience created"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/422/content/application~1json/examples/Validation error"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/422/content/application~1json/examples/Validation error"]}],"pointer":"/paths/~1audiences/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences/post/responses/201/content/application~1json/examples/Audience created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences/post/responses/201/content/application~1json/examples/Audience created"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/422/content/application~1json/examples/Validation error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/422/content/application~1json/examples/Validation error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audiences/createaudience"}],"panels":[]}]},"httpPath":"/audiences"},{"label":"Retrieve an audience","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/audiences/retrieveaudience","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences/retrieveaudience","metadata":{"seo":{"title":"Retrieve an audience","description":"You can fetch the details of a single audience by making a GET request to https://api.intercom.io/audiences/{id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAudience","name":"Retrieve an audience","isWebhook":false,"pointer":"/paths/~1audiences~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an audience","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single audience by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/audiences/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the audience.","required":true,"example":"123"}],"pointer":"/paths/~1audiences~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1audiences~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audiences/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/audiences/{id}","href":"audiences/retrieveaudience","openApiOperationId":"retrieveAudience","summary":"Retrieve an audience"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audience found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/get/responses/200/content/application~1json/examples/Audience found"]}},"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/get/responses/200/content/application~1json/examples/Audience found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Audience not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/404/content/application~1json/examples/Audience not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/404/content/application~1json/examples/Audience not found"]}],"pointer":"/paths/~1audiences~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/get/responses/200/content/application~1json/examples/Audience found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/get/responses/200/content/application~1json/examples/Audience found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/404/content/application~1json/examples/Audience not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/404/content/application~1json/examples/Audience not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audiences/retrieveaudience"}],"panels":[]}]},"httpPath":"/audiences/{id}"},{"label":"Update an audience","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/audiences/updateaudience","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences/updateaudience","metadata":{"seo":{"title":"Update an audience","description":"You can update the details of a single audience by making a PUT request to https://api.intercom.io/audiences/{id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAudience","name":"Update an audience","isWebhook":false,"pointer":"/paths/~1audiences~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an audience","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update the details of a single audience by making a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/audiences/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send this request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it behaves the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the audience.","required":true,"example":"123"}],"pointer":"/paths/~1audiences~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1audiences~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_audience_request","exampleIds":["paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated"]}},"schemaId":"components/schemas/update_audience_request","exampleIds":["paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated"],"pointer":"/paths/~1audiences~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/audiences/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_audience_request","exampleIds":["paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated"]}},"responseCodes":["200","401","404","422"],"pointer":"/audiences/{id}","href":"audiences/updateaudience","openApiOperationId":"updateAudience","summary":"Update an audience"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_audience_request","exampleIds":["paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_audience_request","exampleIds":["paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audience updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/put/responses/200/content/application~1json/examples/Audience updated"]}},"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/put/responses/200/content/application~1json/examples/Audience updated"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Audience not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/404/content/application~1json/examples/Audience not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/404/content/application~1json/examples/Audience not found"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Name cannot be blank","paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Audience has no ruleset"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Name cannot be blank","paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Audience has no ruleset"]}],"pointer":"/paths/~1audiences~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/put/responses/200/content/application~1json/examples/Audience updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/audience","exampleIds":["paths/~1audiences~1{id}/put/responses/200/content/application~1json/examples/Audience updated"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/404/content/application~1json/examples/Audience not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/404/content/application~1json/examples/Audience not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Name cannot be blank","paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Audience has no ruleset"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Name cannot be blank","paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Audience has no ruleset"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audiences/updateaudience"}],"panels":[]}]},"httpPath":"/audiences/{id}"},{"label":"Delete an audience","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/audiences/deleteaudience","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences/deleteaudience","metadata":{"seo":{"title":"Delete an audience","description":"You can delete a single audience by making a DELETE request to https://api.intercom.io/audiences/{id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAudience","name":"Delete an audience","isWebhook":false,"pointer":"/paths/~1audiences~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an audience","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single audience by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/audiences/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An audience that is still used by other objects, such as a workflow, cannot be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_audiences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the audience.","required":true,"example":"123"}],"pointer":"/paths/~1audiences~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1audiences~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/audiences/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","404"],"pointer":"/audiences/{id}","href":"audiences/deleteaudience","openApiOperationId":"deleteAudience","summary":"Delete an audience"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Audience deleted"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/400/content/application~1json/examples/Audience has dependent objects"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/400/content/application~1json/examples/Audience has dependent objects"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Audience not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/404/content/application~1json/examples/Audience not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/404/content/application~1json/examples/Audience not found"]}],"pointer":"/paths/~1audiences~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/400/content/application~1json/examples/Audience has dependent objects"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/400/content/application~1json/examples/Audience has dependent objects"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/404/content/application~1json/examples/Audience not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/404/content/application~1json/examples/Audience not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audiences/deleteaudience"}],"panels":[]}]},"httpPath":"/audiences/{id}"},{"type":"link","label":"Audience","link":"/docs/references/rest-api/api.intercom.io/audiences/audience","routeSlug":"/docs/references/rest-api/api.intercom.io/audiences/audience","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"audience"},"seo":{"title":"Audience"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/audience"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Audiences"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audiences","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Audiences"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Audience","link":"/audiences/audience","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/audiences","summary":"List all audiences","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audiences/listaudiences","deprecated":false},{"title":"/audiences","summary":"Create an audience","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audiences/createaudience","deprecated":false},{"title":"/audiences/{id}","summary":"Retrieve an audience","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audiences/retrieveaudience","deprecated":false},{"title":"/audiences/{id}","summary":"Update an audience","prefix":{"name":"put","color":"put"},"badges":[],"link":"/audiences/updateaudience","deprecated":false},{"title":"/audiences/{id}","summary":"Delete an audience","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/audiences/deleteaudience","deprecated":false}]}]}]}]}},{"type":"group","label":"Auth Tokens","link":"/docs/references/rest-api/api.intercom.io/auth-tokens","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens","items":[{"label":"List all auth tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/listauthtokens","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/listauthtokens","metadata":{"seo":{"title":"List all auth tokens","description":"Returns a paginated list of the workspace's stored third-party credentials. Use this to discover the id of a credential you want a data connector to authenticate with — that id is not otherwise available over REST. Only metadata is returned; credential values are never exposed. The list is not exhaustive: credentials a teammate created are listed, as are those created by some Intercom integrations, but credentials installed by an app package, those created by most other integrations, and those minted for an individual teammate's MCP access are not."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAuthTokens","name":"List all auth tokens","isWebhook":false,"pointer":"/paths/~1auth_tokens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all auth tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of the workspace's stored third-party credentials. Use this to discover the id of a credential you want a data connector to authenticate with — that id is not otherwise available over REST. Only metadata is returned; credential values are never exposed. The list is not exhaustive: credentials a teammate created are listed, as are those created by some Intercom integrations, but credentials installed by an app package, those created by most other integrations, and those minted for an individual teammate's MCP access are not."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1167","description":"The number of results to return per page. Defaults to 20, minimum 1, maximum 50."},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next.starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous response. Used to paginate through results."},"children":[]}]}]}]}],"pointer":"/paths/~1auth_tokens/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1auth_tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth_tokens","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1167"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/auth_tokens","href":"auth-tokens/listauthtokens","openApiOperationId":"listAuthTokens","summary":"List all auth tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token_list","exampleIds":["paths/~1auth_tokens/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/auth_token_list","exampleIds":["paths/~1auth_tokens/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/400/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/400/content/application~1json/examples/Invalid cursor"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1auth_tokens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/auth_token_list","exampleIds":["paths/~1auth_tokens/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token_list","exampleIds":["paths/~1auth_tokens/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/400/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/400/content/application~1json/examples/Invalid cursor"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-tokens/listauthtokens"}],"panels":[]}]},"httpPath":"/auth_tokens"},{"label":"Create an auth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/createauthtoken","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/createauthtoken","metadata":{"seo":{"title":"Create an auth token","description":"Stores a third-party credential in your workspace so a data connector can authenticate outbound requests with it. Set token_type to text (the default) to send the credential value as a request header yourself, or to oauth to have Intercom exchange OAuth client credentials for an access token and keep it refreshed. The value you supply is stored encrypted and is never returned by any endpoint, including this one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuthToken","name":"Create an auth token","isWebhook":false,"pointer":"/paths/~1auth_tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an auth token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stores a third-party credential in your workspace so a data connector can authenticate outbound requests with it. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default) to send the credential value as a request header yourself, or to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to have Intercom exchange OAuth client credentials for an access token and keep it refreshed. The value you supply is stored encrypted and is never returned by any endpoint, including this one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1auth_tokens/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_auth_token_request","exampleIds":["paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful","paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential"]}},"schemaId":"components/schemas/create_auth_token_request","exampleIds":["paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful","paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential"],"pointer":"/paths/~1auth_tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth_tokens","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_auth_token_request","exampleIds":["paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful","paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential"]}},"responseCodes":["201","400","401","403","429"],"pointer":"/auth_tokens","href":"auth-tokens/createauthtoken","openApiOperationId":"createAuthToken","summary":"Create an auth token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_auth_token_request","exampleIds":["paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful","paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_auth_token_request","exampleIds":["paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful","paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens/post/responses/201/content/application~1json/examples/successful","paths/~1auth_tokens/post/responses/201/content/application~1json/examples/OAuth credential"]}},"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens/post/responses/201/content/application~1json/examples/successful","paths/~1auth_tokens/post/responses/201/content/application~1json/examples/OAuth credential"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Missing required field","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Field not accepted for token_type","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/OAuth exchange failed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Missing required field","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Field not accepted for token_type","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/OAuth exchange failed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/403/content/application~1json/examples/No teammate associated with the access token"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/403/content/application~1json/examples/No teammate associated with the access token"]},{"code":"429","description":"Too many OAuth credentials created for this workspace in the last minute","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/429/content/application~1json/examples/Rate limited"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/429/content/application~1json/examples/Rate limited"]}],"pointer":"/paths/~1auth_tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens/post/responses/201/content/application~1json/examples/successful","paths/~1auth_tokens/post/responses/201/content/application~1json/examples/OAuth credential"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens/post/responses/201/content/application~1json/examples/successful","paths/~1auth_tokens/post/responses/201/content/application~1json/examples/OAuth credential"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Missing required field","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Field not accepted for token_type","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/OAuth exchange failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Missing required field","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Field not accepted for token_type","paths/~1auth_tokens/post/responses/400/content/application~1json/examples/OAuth exchange failed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/403/content/application~1json/examples/No teammate associated with the access token"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/403/content/application~1json/examples/No teammate associated with the access token"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/429/content/application~1json/examples/Rate limited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens/post/responses/429/content/application~1json/examples/Rate limited"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-tokens/createauthtoken"}],"panels":[]}]},"httpPath":"/auth_tokens"},{"label":"Retrieve an auth token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/retrieveauthtoken","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/retrieveauthtoken","metadata":{"seo":{"title":"Retrieve an auth token","description":"Returns the metadata for a single stored third-party credential. A credential that the list endpoint does not return is also not retrievable here, and responds with 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAuthToken","name":"Retrieve an auth token","isWebhook":false,"pointer":"/paths/~1auth_tokens~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an auth token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the metadata for a single stored third-party credential. A credential that the list endpoint does not return is also not retrievable here, and responds with 404.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the auth token.","required":true,"example":"12345"}],"pointer":"/paths/~1auth_tokens~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1auth_tokens~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth_tokens/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth_tokens/{id}","href":"auth-tokens/retrieveauthtoken","openApiOperationId":"retrieveAuthToken","summary":"Retrieve an auth token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/404/content/application~1json/examples/Auth token not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/404/content/application~1json/examples/Auth token not found"]}],"pointer":"/paths/~1auth_tokens~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/404/content/application~1json/examples/Auth token not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/get/responses/404/content/application~1json/examples/Auth token not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-tokens/retrieveauthtoken"}],"panels":[]}]},"httpPath":"/auth_tokens/{id}"},{"label":"Update an auth token","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/updateauthtoken","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/updateauthtoken","metadata":{"seo":{"title":"Update an auth token","description":"Updates the metadata of a stored third-party credential. A field you omit keeps its current value. The credential value itself cannot be changed here and is never returned. The domain is read-only, and request_header_key cannot be changed on a credential that has a domain. Only credentials with a token_type of text can be updated; any other type responds with 400. A credential the list endpoint does not return is also not updatable, and responds with 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAuthToken","name":"Update an auth token","isWebhook":false,"pointer":"/paths/~1auth_tokens~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an auth token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the metadata of a stored third-party credential. A field you omit keeps its current value. The credential value itself cannot be changed here and is never returned. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is read-only, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_header_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be changed on a credential that has a domain. Only credentials with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated; any other type responds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A credential the list endpoint does not return is also not updatable, and responds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the auth token.","required":true,"example":"12345"}],"pointer":"/paths/~1auth_tokens~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1auth_tokens~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_auth_token_request","exampleIds":["paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/update_auth_token_request","exampleIds":["paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1auth_tokens~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/auth_tokens/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_auth_token_request","exampleIds":["paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/auth_tokens/{id}","href":"auth-tokens/updateauthtoken","openApiOperationId":"updateAuthToken","summary":"Update an auth token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_auth_token_request","exampleIds":["paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_auth_token_request","exampleIds":["paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/400/content/application~1json/examples/Unsupported token type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/400/content/application~1json/examples/Unsupported token type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/403/content/application~1json/examples/No teammate associated with the access token"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/403/content/application~1json/examples/No teammate associated with the access token"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/404/content/application~1json/examples/Auth token not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/404/content/application~1json/examples/Auth token not found"]}],"pointer":"/paths/~1auth_tokens~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_token","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/400/content/application~1json/examples/Unsupported token type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/400/content/application~1json/examples/Unsupported token type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/403/content/application~1json/examples/No teammate associated with the access token"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/403/content/application~1json/examples/No teammate associated with the access token"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/404/content/application~1json/examples/Auth token not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1auth_tokens~1{id}/patch/responses/404/content/application~1json/examples/Auth token not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-tokens/updateauthtoken"}],"panels":[]}]},"httpPath":"/auth_tokens/{id}"},{"type":"link","label":"Auth Token","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/auth_token","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/auth_token","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"auth_token"},"seo":{"title":"Auth Token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth Token","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/auth_token"},"children":[]}]}]}},{"type":"link","label":"Create Auth Token Request","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/create_auth_token_request","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/create_auth_token_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_auth_token_request"},"seo":{"title":"Create Auth Token Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Auth Token Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_auth_token_request"},"children":[]}]}]}},{"type":"link","label":"OAuth Configuration","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/oauth_configuration","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/oauth_configuration","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"oauth_configuration"},"seo":{"title":"OAuth Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth Configuration","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/oauth_configuration"},"children":[]}]}]}},{"type":"link","label":"Update Auth Token Request","link":"/docs/references/rest-api/api.intercom.io/auth-tokens/update_auth_token_request","routeSlug":"/docs/references/rest-api/api.intercom.io/auth-tokens/update_auth_token_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_auth_token_request"},"seo":{"title":"Update Auth Token Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Auth Token Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_auth_token_request"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Auth Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth Tokens","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read and write the third-party credentials stored in your workspace, so you can find the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id of the credential a data connector should authenticate with, and store a new one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without leaving your integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reading requires an OAuth token with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_auth_tokens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope; creating and updating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"require the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_auth_tokens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope and an access token associated with a teammate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credential to send yourself, or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credential whose"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access token Intercom obtains and refreshes automatically via the client-credentials"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"grant. Only credentials with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated. No endpoint ever"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns a credential value, client secret, refresh configuration, or OAuth configuration."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Auth Token","link":"/auth-tokens/auth_token","deprecated":false},{"title":"Create Auth Token Request","link":"/auth-tokens/create_auth_token_request","deprecated":false},{"title":"OAuth Configuration","link":"/auth-tokens/oauth_configuration","deprecated":false},{"title":"Update Auth Token Request","link":"/auth-tokens/update_auth_token_request","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth_tokens","summary":"List all auth tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth-tokens/listauthtokens","deprecated":false},{"title":"/auth_tokens","summary":"Create an auth token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth-tokens/createauthtoken","deprecated":false},{"title":"/auth_tokens/{id}","summary":"Retrieve an auth token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth-tokens/retrieveauthtoken","deprecated":false},{"title":"/auth_tokens/{id}","summary":"Update an auth token","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/auth-tokens/updateauthtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Away Status Reasons","link":"/docs/references/rest-api/api.intercom.io/away-status-reasons","routeSlug":"/docs/references/rest-api/api.intercom.io/away-status-reasons","items":[{"label":"List all away status reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/away-status-reasons/listawaystatusreasons","routeSlug":"/docs/references/rest-api/api.intercom.io/away-status-reasons/listawaystatusreasons","metadata":{"seo":{"title":"List all away status reasons","description":"Returns a list of all away status reasons configured for the workspace, including deleted ones."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAwayStatusReasons","name":"List all away status reasons","isWebhook":false,"pointer":"/paths/~1away_status_reasons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all away status reasons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all away status reasons configured for the workspace, including deleted ones."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1away_status_reasons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/away_status_reasons","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/away_status_reasons","href":"away-status-reasons/listawaystatusreasons","openApiOperationId":"listAwayStatusReasons","summary":"List all away status reasons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/away_status_reason_list"}},"schemaId":"components/schemas/away_status_reason_list"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1away_status_reasons/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1away_status_reasons/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1away_status_reasons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/away_status_reason_list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/away_status_reason_list"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1away_status_reasons/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1away_status_reasons/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/away-status-reasons/listawaystatusreasons"}],"panels":[]}]},"httpPath":"/away_status_reasons"}],"content":{"contentType":"group","meta":{"name":"Away Status Reasons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Away Status Reasons","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Away Status Reasons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/away_status_reasons","summary":"List all away status reasons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/away-status-reasons/listawaystatusreasons","deprecated":false}]}]}]}]}},{"type":"group","label":"Banners","link":"/docs/references/rest-api/api.intercom.io/banners","routeSlug":"/docs/references/rest-api/api.intercom.io/banners","items":[{"label":"List banners for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/banners/listcontactbanners","routeSlug":"/docs/references/rest-api/api.intercom.io/banners/listcontactbanners","metadata":{"seo":{"title":"List banners for a contact","description":"Returns the banners a contact currently matches, so you can display them onsurfaces outside the Messenger (native mobile apps, kiosks, embedded tools)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactBanners","name":"List banners for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{id}~1banners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List banners for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the banners a contact currently matches, so you can display them on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surfaces outside the Messenger (native mobile apps, kiosks, embedded tools)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each banner in the response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"view_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use it to record a dismissal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the dismiss endpoint. A returned banner is treated as shown: requesting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this endpoint records an impression for each banner returned, so call it at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"point you are about to display the banners, not speculatively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a contact.","required":true}],"pointer":"/paths/~1contacts~1{id}~1banners/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{id}~1banners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{id}/banners","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{id}/banners","href":"banners/listcontactbanners","openApiOperationId":"listContactBanners","summary":"List banners for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1banners/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/banners/listcontactbanners"}],"panels":[]}]},"httpPath":"/contacts/{id}/banners"},{"label":"Dismiss a banner for a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/banners/dismisscontactbanner","routeSlug":"/docs/references/rest-api/api.intercom.io/banners/dismisscontactbanner","metadata":{"seo":{"title":"Dismiss a banner for a contact","description":"Records that a contact has dismissed a banner. Dismissals are shared acrosssurfaces, so a banner dismissed through this endpoint will also stop appearingin the web Messenger for that contact, and vice versa."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dismissContactBanner","name":"Dismiss a banner for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dismiss a banner for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records that a contact has dismissed a banner. Dismissals are shared across"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surfaces, so a banner dismissed through this endpoint will also stop appearing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the web Messenger for that contact, and vice versa."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is idempotent: dismissing an already-dismissed banner succeeds and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns the same response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a contact.","required":true},{"name":"view_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"view_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the banner to dismiss, as returned by the list banners endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{id}/banners/{view_id}/dismiss","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"},{"name":"view_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{id}/banners/{view_id}/dismiss","href":"banners/dismisscontactbanner","openApiOperationId":"dismissContactBanner","summary":"Dismiss a banner for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Banner view or contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/banners/dismisscontactbanner"}],"panels":[]}]},"httpPath":"/contacts/{id}/banners/{view_id}/dismiss"},{"type":"link","label":"Banner","link":"/docs/references/rest-api/api.intercom.io/banners/banner","routeSlug":"/docs/references/rest-api/api.intercom.io/banners/banner","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"banner"},"seo":{"title":"Banner"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Banner","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/banner"},"children":[]}]}]}},{"type":"link","label":"Banner Dismiss","link":"/docs/references/rest-api/api.intercom.io/banners/banner_dismiss","routeSlug":"/docs/references/rest-api/api.intercom.io/banners/banner_dismiss","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"banner_dismiss"},"seo":{"title":"Banner Dismiss"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Banner Dismiss","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/banner_dismiss"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Banners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Banners","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the banners a contact matches and record dismissals, so you can display"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"banners on surfaces outside the Messenger (native mobile apps, kiosks, embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tools). These endpoints require an OAuth token with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requesting a contact's banners records an impression for each banner returned, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dismissals are shared with the web Messenger."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Banner","link":"/banners/banner","deprecated":false},{"title":"Banner Dismiss","link":"/banners/banner_dismiss","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts/{id}/banners","summary":"List banners for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/banners/listcontactbanners","deprecated":false},{"title":"/contacts/{id}/banners/{view_id}/dismiss","summary":"Dismiss a banner for a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/banners/dismisscontactbanner","deprecated":false}]}]}]}]}},{"type":"group","label":"Brands","link":"/docs/references/rest-api/api.intercom.io/brands","routeSlug":"/docs/references/rest-api/api.intercom.io/brands","items":[{"label":"List all brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/brands/listbrands","routeSlug":"/docs/references/rest-api/api.intercom.io/brands/listbrands","metadata":{"seo":{"title":"List all brands","description":"Retrieves all brands for the workspace, including the default brand.The default brand id always matches the workspace id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBrands","name":"List all brands","isWebhook":false,"pointer":"/paths/~1brands/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all brands","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all brands for the workspace, including the default brand."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default brand id always matches the workspace id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1brands/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/brands","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/brands","href":"brands/listbrands","openApiOperationId":"listBrands","summary":"List all brands"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brand_list","exampleIds":["paths/~1brands/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/brand_list","exampleIds":["paths/~1brands/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1brands/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1brands/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1brands/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/brand_list","exampleIds":["paths/~1brands/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brand_list","exampleIds":["paths/~1brands/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1brands/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1brands/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/listbrands"}],"panels":[]}]},"httpPath":"/brands"},{"label":"Retrieve a brand","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/brands/retrievebrand","routeSlug":"/docs/references/rest-api/api.intercom.io/brands/retrievebrand","metadata":{"seo":{"title":"Retrieve a brand","description":"Fetches a specific brand by its unique identifier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveBrand","name":"Retrieve a brand","isWebhook":false,"pointer":"/paths/~1brands~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a brand","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a specific brand by its unique identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the brand","required":true}],"pointer":"/paths/~1brands~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1brands~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/brands/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/brands/{id}","href":"brands/retrievebrand","openApiOperationId":"retrieveBrand","summary":"Retrieve a brand"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brand","exampleIds":["paths/~1brands~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/brand","exampleIds":["paths/~1brands~1{id}/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Brand not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/404/content/application~1json/examples/Brand not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/404/content/application~1json/examples/Brand not found"]}],"pointer":"/paths/~1brands~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/brand","exampleIds":["paths/~1brands~1{id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/brand","exampleIds":["paths/~1brands~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/404/content/application~1json/examples/Brand not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1brands~1{id}/get/responses/404/content/application~1json/examples/Brand not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/retrievebrand"}],"panels":[]}]},"httpPath":"/brands/{id}"},{"type":"link","label":"Brand","link":"/docs/references/rest-api/api.intercom.io/brands/brand","routeSlug":"/docs/references/rest-api/api.intercom.io/brands/brand","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"brand"},"seo":{"title":"Brand"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brand","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/brand"},"children":[]}]}]}},{"type":"link","label":"Brand List","link":"/docs/references/rest-api/api.intercom.io/brands/brand_list","routeSlug":"/docs/references/rest-api/api.intercom.io/brands/brand_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"brand_list"},"seo":{"title":"Brand List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brand List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/brand_list"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Brands"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brands","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Brands"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Brand","link":"/brands/brand","deprecated":false},{"title":"Brand List","link":"/brands/brand_list","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/brands","summary":"List all brands","prefix":{"name":"get","color":"get"},"badges":[],"link":"/brands/listbrands","deprecated":false},{"title":"/brands/{id}","summary":"Retrieve a brand","prefix":{"name":"get","color":"get"},"badges":[],"link":"/brands/retrievebrand","deprecated":false}]}]}]}]}},{"type":"group","label":"Calls","link":"/docs/references/rest-api/api.intercom.io/calls","routeSlug":"/docs/references/rest-api/api.intercom.io/calls","items":[{"label":"List all calls","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/listcalls","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/listcalls","metadata":{"seo":{"title":"List all calls","description":"Retrieve a paginated list of calls."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCalls","name":"List all calls","isWebhook":false,"pointer":"/paths/~1calls/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all calls","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a paginated list of calls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_1168","description":"How many results to display per page. Defaults to 25. Must be between 1 and 25. A value outside that range returns a 400 error.","example":25}],"pointer":"/paths/~1calls/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1calls/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calls","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":25,"schemaId":"schema_1168"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/calls","href":"calls/listcalls","openApiOperationId":"listCalls","summary":"List all calls"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/call_list","exampleIds":["paths/~1calls/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/call_list","exampleIds":["paths/~1calls/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/400/content/application~1json/examples/Per page too large","paths/~1calls/get/responses/400/content/application~1json/examples/Per page too small"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/400/content/application~1json/examples/Per page too large","paths/~1calls/get/responses/400/content/application~1json/examples/Per page too small"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1calls/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/call_list","exampleIds":["paths/~1calls/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/call_list","exampleIds":["paths/~1calls/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/400/content/application~1json/examples/Per page too large","paths/~1calls/get/responses/400/content/application~1json/examples/Per page too small"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/400/content/application~1json/examples/Per page too large","paths/~1calls/get/responses/400/content/application~1json/examples/Per page too small"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/listcalls"}],"panels":[]}]},"httpPath":"/calls"},{"label":"Get a call","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/showcall","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/showcall","metadata":{"seo":{"title":"Get a call","description":"Retrieve a single call by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showCall","name":"Get a call","isWebhook":false,"pointer":"/paths/~1calls~1{call_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a call","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a single call by id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"call_id","in":"path","schemaId":"schema_1152","description":"The id of the call to retrieve","required":true}],"pointer":"/paths/~1calls~1{call_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1calls~1{call_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calls/{call_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"call_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/calls/{call_id}","href":"calls/showcall","openApiOperationId":"showCall","summary":"Get a call"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/call","exampleIds":["paths/~1calls~1{call_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/call","exampleIds":["paths/~1calls~1{call_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/404/content/application~1json/examples/Not Found"]}],"pointer":"/paths/~1calls~1{call_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/call","exampleIds":["paths/~1calls~1{call_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/call","exampleIds":["paths/~1calls~1{call_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/404/content/application~1json/examples/Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/showcall"}],"panels":[]}]},"httpPath":"/calls/{call_id}"},{"label":"Get call recording by call id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/showcallrecording","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/showcallrecording","metadata":{"seo":{"title":"Get call recording by call id","description":"Redirects to a signed URL for the call's recording if it exists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showCallRecording","name":"Get call recording by call id","isWebhook":false,"pointer":"/paths/~1calls~1{call_id}~1recording/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get call recording by call id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redirects to a signed URL for the call's recording if it exists."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"call_id","in":"path","schemaId":"schema_1152","description":"The id of the call","required":true}],"pointer":"/paths/~1calls~1{call_id}~1recording/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1calls~1{call_id}~1recording/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calls/{call_id}/recording","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"call_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["302","401","404"],"pointer":"/calls/{call_id}/recording","href":"calls/showcallrecording","openApiOperationId":"showCallRecording","summary":"Get call recording by call id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect to signed recording URL","headers":{"Location":{"description":"The signed recording URL","schema":{"type":"string","format":"uri"}}},"headerSchemaId":"schema_1169"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Call or recording not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Recording not found","paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Call not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Recording not found","paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Call not found"]}],"pointer":"/paths/~1calls~1{call_id}~1recording/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Recording not found","paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Call not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Recording not found","paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Call not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/showcallrecording"}],"panels":[]}]},"httpPath":"/calls/{call_id}/recording"},{"label":"Get call transcript by call id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/showcalltranscript","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/showcalltranscript","metadata":{"seo":{"title":"Get call transcript by call id","description":"Returns the transcript for the specified call as a JSON array of turns. Each turn carries a speaker_name when the speaker could be resolved. Clients should fall back to speaker_label when speaker_name is absent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showCallTranscript","name":"Get call transcript by call id","isWebhook":false,"pointer":"/paths/~1calls~1{id}~1transcript/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get call transcript by call id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the transcript for the specified call as a JSON array of turns. Each turn carries a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the speaker could be resolved. Clients should fall back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is absent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The id of the call","required":true}],"pointer":"/paths/~1calls~1{id}~1transcript/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1calls~1{id}~1transcript/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calls/{id}/transcript","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/calls/{id}/transcript","href":"calls/showcalltranscript","openApiOperationId":"showCallTranscript","summary":"Get call transcript by call id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1170","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/200/content/application~1json/examples/transcript"]}},"schemaId":"schema_1170","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/200/content/application~1json/examples/transcript"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"]}],"pointer":"/paths/~1calls~1{id}~1transcript/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1170","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/200/content/application~1json/examples/transcript"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1170","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/200/content/application~1json/examples/transcript"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/showcalltranscript"}],"panels":[]}]},"httpPath":"/calls/{id}/transcript"},{"label":"List calls with transcripts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/listcallswithtranscripts","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/listcallswithtranscripts","metadata":{"seo":{"title":"List calls with transcripts","description":"Retrieve calls by a list of conversation ids and include transcripts when available.A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCallsWithTranscripts","name":"List calls with transcripts","isWebhook":false,"pointer":"/paths/~1calls~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List calls with transcripts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve calls by a list of conversation ids and include transcripts when available."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum of 20 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be provided. If none are provided or more than 20 are provided, a 400 error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1calls~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1171","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"schema_1171","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1calls~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/calls/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1171","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","401"],"pointer":"/calls/search","href":"calls/listcallswithtranscripts","openApiOperationId":"listCallsWithTranscripts","summary":"List calls with transcripts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1171","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1171","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1172","exampleIds":["paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_1172","exampleIds":["paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/400/content/application~1json/examples/too_many_ids"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/400/content/application~1json/examples/too_many_ids"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1calls~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1172","exampleIds":["paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1172","exampleIds":["paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/400/content/application~1json/examples/too_many_ids"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/400/content/application~1json/examples/too_many_ids"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1calls~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/listcallswithtranscripts"}],"panels":[]}]},"httpPath":"/calls/search"},{"label":"Register a Fin Voice call","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/registerfinvoicecall","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/registerfinvoicecall","metadata":{"seo":{"title":"Register a Fin Voice call","description":"Register a Fin Voice call with Intercom. This endpoint creates an external referencethat links an external call identifier to an Intercom call and conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerFinVoiceCall","name":"Register a Fin Voice call","isWebhook":false,"pointer":"/paths/~1fin_voice~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a Fin Voice call","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a Fin Voice call with Intercom. This endpoint creates an external reference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that links an external call identifier to an Intercom call and conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The call can be from different sources:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AWS Connect (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Five9"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zoom Phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NICE CXone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dialpad"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generic"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin_voice~1register/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/register_fin_voice_call_request"}},"schemaId":"components/schemas/register_fin_voice_call_request","pointer":"/paths/~1fin_voice~1register/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin_voice/register","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/register_fin_voice_call_request"}},"responseCodes":["200","400","409","default"],"pointer":"/fin_voice/register","href":"calls/registerfinvoicecall","openApiOperationId":"registerFinVoiceCall","summary":"Register a Fin Voice call"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/register_fin_voice_call_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/register_fin_voice_call_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response","exampleIds":["paths/~1fin_voice~1register/post/responses/200/content/application~1json/examples/registered"]}},"schemaId":"components/schemas/ai_call_response","exampleIds":["paths/~1fin_voice~1register/post/responses/200/content/application~1json/examples/registered"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bad request - missing phone_number or call_id"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"409","description":"conflict - duplicate call registration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1fin_voice~1register/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai_call_response","exampleIds":["paths/~1fin_voice~1register/post/responses/200/content/application~1json/examples/registered"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response","exampleIds":["paths/~1fin_voice~1register/post/responses/200/content/application~1json/examples/registered"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"409","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/registerfinvoicecall"}],"panels":[]}]},"httpPath":"/fin_voice/register"},{"label":"Collect Fin Voice call by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallbyid","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallbyid","metadata":{"seo":{"title":"Collect Fin Voice call by ID","description":"Retrieve information about a Fin Voice call using the external reference ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"collectFinVoiceCallById","name":"Collect Fin Voice call by ID","isWebhook":false,"pointer":"/paths/~1fin_voice~1collect~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collect Fin Voice call by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve information about a Fin Voice call using the external reference ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The external reference ID","required":true}],"pointer":"/paths/~1fin_voice~1collect~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin_voice~1collect~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fin_voice/collect/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/fin_voice/collect/{id}","href":"calls/collectfinvoicecallbyid","openApiOperationId":"collectFinVoiceCallById","summary":"Collect Fin Voice call by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}},"schemaId":"components/schemas/ai_call_response"},{"code":"404","description":"not found - external reference not found or not matched","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1fin_voice~1collect~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai_call_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/collectfinvoicecallbyid"}],"panels":[]}]},"httpPath":"/fin_voice/collect/{id}"},{"label":"Collect Fin Voice call by external ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallbyexternalid","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallbyexternalid","metadata":{"seo":{"title":"Collect Fin Voice call by external ID","description":"Retrieve information about a Fin Voice call using the external call identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"collectFinVoiceCallByExternalId","name":"Collect Fin Voice call by external ID","isWebhook":false,"pointer":"/paths/~1fin_voice~1external_id~1{external_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collect Fin Voice call by external ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve information about a Fin Voice call using the external call identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_id","in":"path","schemaId":"schema_1152","description":"The external call identifier from the call provider","required":true}],"pointer":"/paths/~1fin_voice~1external_id~1{external_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin_voice~1external_id~1{external_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fin_voice/external_id/{external_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"external_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/fin_voice/external_id/{external_id}","href":"calls/collectfinvoicecallbyexternalid","openApiOperationId":"collectFinVoiceCallByExternalId","summary":"Collect Fin Voice call by external ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}},"schemaId":"components/schemas/ai_call_response"},{"code":"404","description":"not found - external reference not found or not matched","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1fin_voice~1external_id~1{external_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai_call_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/collectfinvoicecallbyexternalid"}],"panels":[]}]},"httpPath":"/fin_voice/external_id/{external_id}"},{"label":"Collect Fin Voice call by phone number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallbyphonenumber","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallbyphonenumber","metadata":{"seo":{"title":"Collect Fin Voice call by phone number","description":"Retrieve information about a Fin Voice call using the phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"collectFinVoiceCallByPhoneNumber","name":"Collect Fin Voice call by phone number","isWebhook":false,"pointer":"/paths/~1fin_voice~1phone_number~1{phone_number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collect Fin Voice call by phone number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve information about a Fin Voice call using the phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the most recent matched call for the given phone number, ordered by creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"phone_number","in":"path","schemaId":"schema_1152","description":"Phone number in E.164 format","required":true}],"pointer":"/paths/~1fin_voice~1phone_number~1{phone_number}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin_voice~1phone_number~1{phone_number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fin_voice/phone_number/{phone_number}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"phone_number","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","default"],"pointer":"/fin_voice/phone_number/{phone_number}","href":"calls/collectfinvoicecallbyphonenumber","openApiOperationId":"collectFinVoiceCallByPhoneNumber","summary":"Collect Fin Voice call by phone number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}},"schemaId":"components/schemas/ai_call_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"not found - no call found for phone number or not matched","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1fin_voice~1phone_number~1{phone_number}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai_call_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/collectfinvoicecallbyphonenumber"}],"panels":[]}]},"httpPath":"/fin_voice/phone_number/{phone_number}"},{"label":"Collect Fin Voice calls by conversation ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallsbyconversationid","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/collectfinvoicecallsbyconversationid","metadata":{"seo":{"title":"Collect Fin Voice calls by conversation ID","description":"Retrieve information about Fin Voice calls associated with a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"collectFinVoiceCallsByConversationId","name":"Collect Fin Voice calls by conversation ID","isWebhook":false,"pointer":"/paths/~1fin_voice~1conversation~1{conversation_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collect Fin Voice calls by conversation ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve information about Fin Voice calls associated with a conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all matched calls for the given conversation ID. A conversation may have multiple associated calls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":"The Intercom conversation identifier","required":true}],"pointer":"/paths/~1fin_voice~1conversation~1{conversation_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin_voice~1conversation~1{conversation_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fin_voice/conversation/{conversation_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","default"],"pointer":"/fin_voice/conversation/{conversation_id}","href":"calls/collectfinvoicecallsbyconversationid","openApiOperationId":"collectFinVoiceCallsByConversationId","summary":"Collect Fin Voice calls by conversation ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1173"}},"schemaId":"schema_1173"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1fin_voice~1conversation~1{conversation_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1173","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1173"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"default","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/collectfinvoicecallsbyconversationid"}],"panels":[]}]},"httpPath":"/fin_voice/conversation/{conversation_id}"},{"type":"link","label":"Call","link":"/docs/references/rest-api/api.intercom.io/calls/call","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/call","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"call"},"seo":{"title":"Call"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/call"},"children":[]}]}]}},{"type":"link","label":"Call Transcript Turn","link":"/docs/references/rest-api/api.intercom.io/calls/call_transcript_turn","routeSlug":"/docs/references/rest-api/api.intercom.io/calls/call_transcript_turn","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"call_transcript_turn"},"seo":{"title":"Call Transcript Turn"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Call Transcript Turn","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/call_transcript_turn"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Calls"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calls","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Calls"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Call","link":"/calls/call","deprecated":false},{"title":"Call Transcript Turn","link":"/calls/call_transcript_turn","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/calls","summary":"List all calls","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/listcalls","deprecated":false},{"title":"/calls/{call_id}","summary":"Get a call","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/showcall","deprecated":false},{"title":"/calls/{call_id}/recording","summary":"Get call recording by call id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/showcallrecording","deprecated":false},{"title":"/calls/{id}/transcript","summary":"Get call transcript by call id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/showcalltranscript","deprecated":false},{"title":"/calls/search","summary":"List calls with transcripts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/calls/listcallswithtranscripts","deprecated":false},{"title":"/fin_voice/register","summary":"Register a Fin Voice call","prefix":{"name":"post","color":"post"},"badges":[],"link":"/calls/registerfinvoicecall","deprecated":false},{"title":"/fin_voice/collect/{id}","summary":"Collect Fin Voice call by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/collectfinvoicecallbyid","deprecated":false},{"title":"/fin_voice/external_id/{external_id}","summary":"Collect Fin Voice call by external ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/collectfinvoicecallbyexternalid","deprecated":false},{"title":"/fin_voice/phone_number/{phone_number}","summary":"Collect Fin Voice call by phone number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/collectfinvoicecallbyphonenumber","deprecated":false},{"title":"/fin_voice/conversation/{conversation_id}","summary":"Collect Fin Voice calls by conversation ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calls/collectfinvoicecallsbyconversationid","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/docs/references/rest-api/api.intercom.io/companies","routeSlug":"/docs/references/rest-api/api.intercom.io/companies","items":[{"label":"Create or Update a company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/createorupdatecompany","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/createorupdatecompany","metadata":{"seo":{"title":"Create or Update a company","description":"You can create or update a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrUpdateCompany","name":"Create or Update a company","isWebhook":false,"pointer":"/paths/~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create or update a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies will be only visible in Intercom when there is at least one associated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies are looked up via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, if not found via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the new company will be created, if found, that company will be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must send either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A request with neither returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every custom attribute you send must already exist in your workspace. Sending one that doesn't returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Using `company_id`"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value when creating a company. However, it is not possible to update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Be sure to set a unique value once upon creation of the company."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_or_update_company_request","exampleIds":["paths/~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1companies/post/requestBody/content/application~1json/examples/bad_request"]}},"schemaId":"components/schemas/create_or_update_company_request","exampleIds":["paths/~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1companies/post/requestBody/content/application~1json/examples/bad_request"],"pointer":"/paths/~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_or_update_company_request","exampleIds":["paths/~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1companies/post/requestBody/content/application~1json/examples/bad_request"]}},"responseCodes":["200","400","401","422"],"pointer":"/companies","href":"companies/createorupdatecompany","openApiOperationId":"createOrUpdateCompany","summary":"Create or Update a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_or_update_company_request","exampleIds":["paths/~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1companies/post/requestBody/content/application~1json/examples/bad_request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_or_update_company_request","exampleIds":["paths/~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1companies/post/requestBody/content/application~1json/examples/bad_request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1companies/post/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1companies/post/responses/400/content/application~1json/examples/Missing company_id","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute value is an object","paths/~1companies/post/responses/400/content/application~1json/examples/Company is not an object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1companies/post/responses/400/content/application~1json/examples/Missing company_id","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute value is an object","paths/~1companies/post/responses/400/content/application~1json/examples/Company is not an object"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/422/content/application~1json/examples/Monthly spend out of range"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/422/content/application~1json/examples/Monthly spend out of range"]}],"pointer":"/paths/~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1companies/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1companies/post/responses/400/content/application~1json/examples/Missing company_id","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute value is an object","paths/~1companies/post/responses/400/content/application~1json/examples/Company is not an object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1companies/post/responses/400/content/application~1json/examples/Missing company_id","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute value is an object","paths/~1companies/post/responses/400/content/application~1json/examples/Company is not an object"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/422/content/application~1json/examples/Monthly spend out of range"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/422/content/application~1json/examples/Monthly spend out of range"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/createorupdatecompany"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Retrieve companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/retrievecompany","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/retrievecompany","metadata":{"seo":{"title":"Retrieve companies","description":"You can fetch a single company by passing in company_id or name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveCompany","name":"Retrieve companies","isWebhook":false,"pointer":"/paths/~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a single company by passing in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/companies?name={name}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/companies?company_id={company_id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch all companies and filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a query parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/companies?tag_id={tag_id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/companies?segment_id={segment_id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list is paged by page number. There is a limit of 10,000 companies; beyond that the request returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error and you should use the scroll endpoint instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the company to filter by."},"children":[]}]}]}],"example":"my company"},{"name":"company_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the company to filter by."},"children":[]}]}]}],"example":"12345"},{"name":"tag_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the company to filter by."},"children":[]}]}]}],"example":"678910"},{"name":"segment_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the company to filter by."},"children":[]}]}]}],"example":"98765"},{"name":"type","in":"query","schemaId":"schema_1174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to return that company's users instead of the company. The response is then a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array in the legacy user format, paged with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default 50)."},"children":[]}]}]}],"example":"users"},{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_1175","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many results to display per page. Defaults to 15. A value above 60 returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":15}],"pointer":"/paths/~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"example":"my company","schemaId":"schema_1152"},{"name":"company_id","in":"query","required":false,"example":"12345","schemaId":"schema_1152"},{"name":"tag_id","in":"query","required":false,"example":"678910","schemaId":"schema_1152"},{"name":"segment_id","in":"query","required":false,"example":"98765","schemaId":"schema_1152"},{"name":"type","in":"query","required":false,"example":"users","schemaId":"schema_1174"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":15,"schemaId":"schema_1175"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","503"],"pointer":"/companies","href":"companies/retrievecompany","openApiOperationId":"retrieveCompany","summary":"Retrieve companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1176","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/List of companies","paths/~1companies/get/responses/200/content/application~1json/examples/Single company (company_id or name)"]}},"schemaId":"schema_1176","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/List of companies","paths/~1companies/get/responses/200/content/application~1json/examples/Single company (company_id or name)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies/get/responses/400/content/application~1json/examples/Page limit reached"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies/get/responses/400/content/application~1json/examples/Page limit reached"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/404/content/application~1json/examples/Company Not Found"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/503/content/application~1json/examples/Search temporarily unavailable"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/503/content/application~1json/examples/Search temporarily unavailable"]}],"pointer":"/paths/~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1176","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/List of companies","paths/~1companies/get/responses/200/content/application~1json/examples/Single company (company_id or name)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1176","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/List of companies","paths/~1companies/get/responses/200/content/application~1json/examples/Single company (company_id or name)"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies/get/responses/400/content/application~1json/examples/Page limit reached"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies/get/responses/400/content/application~1json/examples/Page limit reached"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/404/content/application~1json/examples/Company Not Found"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/503/content/application~1json/examples/Search temporarily unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/get/responses/503/content/application~1json/examples/Search temporarily unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/retrievecompany"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Retrieve a company by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/retrieveacompanybyid","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/retrieveacompanybyid","metadata":{"seo":{"title":"Retrieve a company by ID","description":"You can fetch a single company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveACompanyById","name":"Retrieve a company by ID","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a company by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a single company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_1174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return the company's users instead of the company. The response is then a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array in the legacy user format."},"children":[]}]}]}],"example":"users"},{"name":"page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of users to fetch. Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to first page. There is a limit of 10,000 users; a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that go past it return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bad_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1175","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many users to return per page. Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to 50. A value above 60 returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":50}],"pointer":"/paths/~1companies~1{company_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[{"name":"type","in":"query","required":false,"example":"users","schemaId":"schema_1174"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1175"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}","href":"companies/retrieveacompanybyid","openApiOperationId":"RetrieveACompanyById","summary":"Retrieve a company by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1177","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"schema_1177","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Page limit reached"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Page limit reached"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{company_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1177","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1177","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Page limit reached"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Page limit reached"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/retrieveacompanybyid"}],"panels":[]}]},"httpPath":"/companies/{company_id}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/updatecompany","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/updatecompany","metadata":{"seo":{"title":"Update a company","description":"You can update a single company using the Intercom provisioned id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateCompany","name":"Update a company","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a single company using the Intercom provisioned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every custom attribute you send must already exist in your workspace. Sending one that doesn't returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send this request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it behaves the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Using `company_id`"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When updating a company it is not possible to update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This can only be set once upon creation of the company."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_company_request","exampleIds":["paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful","paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request"]}},"schemaId":"components/schemas/update_company_request","exampleIds":["paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful","paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request"],"pointer":"/paths/~1companies~1{company_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_company_request","exampleIds":["paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful","paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/companies/{company_id}","href":"companies/updatecompany","openApiOperationId":"UpdateCompany","summary":"Update a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_company_request","exampleIds":["paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful","paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_company_request","exampleIds":["paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful","paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/put/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/put/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute value is an object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute value is an object"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/404/content/application~1json/examples/Company Not Found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/422/content/application~1json/examples/Monthly spend out of range"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/422/content/application~1json/examples/Monthly spend out of range"]}],"pointer":"/paths/~1companies~1{company_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/put/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/put/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute value is an object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute value is an object"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/404/content/application~1json/examples/Company Not Found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/422/content/application~1json/examples/Monthly spend out of range"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/422/content/application~1json/examples/Monthly spend out of range"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/updatecompany"}],"panels":[]}]},"httpPath":"/companies/{company_id}"},{"label":"Delete a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/deletecompany","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/deletecompany","metadata":{"seo":{"title":"Delete a company","description":"Delete a single company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompany","name":"Delete a company","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a single company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The company record is kept in your workspace, but all contacts are detached. The contacts themselves are not deleted. Detaching contacts is permanent and can't be reversed. These changes may take some time to be reflected in your workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"deleted\": true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as soon as the request is accepted; the contacts are detached in the background. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook is sent after that work finishes, so it arrives some time after the response. No webhook is sent for a company that has no contacts attached, because there is nothing to detach."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third-party integrations that sync companies into Intercom (for example, Salesforce or Chargebee) will recreate any company deleted through this endpoint on their next sync. To prevent recreation, remove or filter the company at the source integration before deleting it via the API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{company_id}","href":"companies/deletecompany","openApiOperationId":"deleteCompany","summary":"Delete a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_company_object","exampleIds":["paths/~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/deleted_company_object","exampleIds":["paths/~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{company_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_company_object","exampleIds":["paths/~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_company_object","exampleIds":["paths/~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/deletecompany"}],"panels":[]}]},"httpPath":"/companies/{company_id}"},{"label":"List attached contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/listattachedcontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/listattachedcontacts","metadata":{"seo":{"title":"List attached contacts","description":"You can fetch a list of all contacts that belong to a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAttachedContacts","name":"List attached contacts","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all contacts that belong to a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1150","description":"How many contacts to return per page. Defaults to 50.","example":50},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to fetch the next page of contacts. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the previous response."},"children":[]}]}]}]},{"name":"include_merge_history","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include each contact's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merge_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Any other value omits it."},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{company_id}/contacts","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"},{"name":"include_merge_history","in":"query","required":false,"example":"true","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}/contacts","href":"companies/listattachedcontacts","openApiOperationId":"ListAttachedContacts","summary":"List attached contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listattachedcontacts"}],"panels":[]}]},"httpPath":"/companies/{company_id}/contacts"},{"label":"List attached segments for companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/listattachedsegmentsforcompanies","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/listattachedsegmentsforcompanies","metadata":{"seo":{"title":"List attached segments for companies","description":"You can fetch a list of all segments that belong to a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAttachedSegmentsForCompanies","name":"List attached segments for companies","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached segments for companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all segments that belong to a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{company_id}/segments","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{company_id}/segments","href":"companies/listattachedsegmentsforcompanies","openApiOperationId":"ListAttachedSegmentsForCompanies","summary":"List attached segments for companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_attached_segments","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_attached_segments","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{company_id}~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_attached_segments","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_attached_segments","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listattachedsegmentsforcompanies"}],"panels":[]}]},"httpPath":"/companies/{company_id}/segments"},{"label":"List all company notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/listcompanynotes","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/listcompanynotes","metadata":{"seo":{"title":"List all company notes","description":"You can fetch a list of notes that are associated to a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanyNotes","name":"List all company notes","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all company notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of notes that are associated to a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of results to return. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of notes to return per page. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":50},{"name":"order","in":"query","schemaId":"schema_1178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order the notes are returned in, by id. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{company_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1178"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}/notes","href":"companies/listcompanynotes","openApiOperationId":"listCompanyNotes","summary":"List all company notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"]}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listcompanynotes"}],"panels":[]}]},"httpPath":"/companies/{company_id}/notes"},{"label":"Create a company note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/createcompanynote","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/createcompanynote","metadata":{"seo":{"title":"Create a company note","description":"You can add a note to a single company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCompanyNote","name":"Create a company note","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a company note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add a note to a single company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"]}},"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"],"pointer":"/paths/~1companies~1{company_id}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{company_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}/notes","href":"companies/createcompanynote","openApiOperationId":"createCompanyNote","summary":"Create a company note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company or admin not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"]}],"pointer":"/paths/~1companies~1{company_id}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/createcompanynote"}],"panels":[]}]},"httpPath":"/companies/{company_id}/notes"},{"label":"Search companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/searchcompanies","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/searchcompanies","metadata":{"seo":{"title":"Search companies","description":"You can search for companies by the value of their attributes in order to fetch exactly the companies you want."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCompanies","name":"Search companies","isWebhook":false,"pointer":"/paths/~1companies~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for companies by the value of their attributes in order to fetch exactly the companies you want."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To search for companies, send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/companies/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a query object in the body defining your filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the API does not include companies who have no associated users in search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Optimizing search queries"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search queries can be complex, so optimizing them can help the performance of your search."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators to combine multiple filters to get the exact results you need and utilize"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"companies/searchcompanies/request/nesting-and-limitations","deepLinkHash":"/companies/searchcompanies#companies/searchcompanies/request/nesting-and-limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nesting & Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are some limitations to the amount of multiple's there can be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 2 nested filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 15 filters for each AND or OR group"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"companies/searchcompanies/request/accepted-fields","deepLinkHash":"/companies/searchcompanies#companies/searchcompanies/request/accepted-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most keys listed as part of the Companies Model are searchable. The value you search for has to match the accepted type, otherwise the query will fail (ie. as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a date, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be a string such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"foobar\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX Timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX Timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remote_created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX Timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_request_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX Timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monthly_spend"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"session_count"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_count"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_attributes.{attribute_name}"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are not searchable and return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"companies/searchcompanies/request/accepted-operators","deepLinkHash":"/companies/searchcompanies#companies/searchcompanies/request/accepted-operators"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Operators"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"=\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The operator has to be compatible with the field's type (eg. you cannot search with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a given string value as it's only compatible for integer's and dates). Searching by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators are not supported for Date fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All except Date and tag_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values must be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All except Date and tag_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not In"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR !"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values must be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower than"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Contain"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"^"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts With"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ends With"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"companies/searchcompanies/request/sorting","deepLinkHash":"/companies/searchcompanies#companies/searchcompanies/request/sorting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ascending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to order the results. An invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_sort_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used as a filter but not as a sort field."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"companies/searchcompanies/request/pagination","deepLinkHash":"/companies/searchcompanies#companies/searchcompanies/request/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to 15 and must be between 1 and 150; anything else returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the previous response, and send it with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you used for that response. A cursor from a sort on a text field such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sent with a sort on a number or date field (or the other way round), returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Leaving out "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_request_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a date. A cursor sent with a different sort of the same kind is accepted, but the page it returns doesn't follow on from the previous one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_search_request","exampleIds":["paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/company_search_request","exampleIds":["paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1companies~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company_search_request","exampleIds":["paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","503"],"pointer":"/companies/search","href":"companies/searchcompanies","openApiOperationId":"searchCompanies","summary":"Search companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/company_search_request","exampleIds":["paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_search_request","exampleIds":["paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_search_response","exampleIds":["paths/~1companies~1search/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/company_search_response","exampleIds":["paths/~1companies~1search/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/400/content/application~1json/examples/Unsupported field","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Sort is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Pagination is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Per page out of range","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Cursor does not match the sort"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/400/content/application~1json/examples/Unsupported field","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Sort is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Pagination is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Per page out of range","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Cursor does not match the sort"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/503/content/application~1json/examples/Search temporarily unavailable"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/503/content/application~1json/examples/Search temporarily unavailable"]}],"pointer":"/paths/~1companies~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_search_response","exampleIds":["paths/~1companies~1search/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_search_response","exampleIds":["paths/~1companies~1search/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/400/content/application~1json/examples/Unsupported field","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Sort is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Pagination is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Per page out of range","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Cursor does not match the sort"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/400/content/application~1json/examples/Unsupported field","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Sort is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Pagination is not an object","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Per page out of range","paths/~1companies~1search/post/responses/400/content/application~1json/examples/Cursor does not match the sort"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/503/content/application~1json/examples/Search temporarily unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1search/post/responses/503/content/application~1json/examples/Search temporarily unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/searchcompanies"}],"panels":[]}]},"httpPath":"/companies/search"},{"label":"List all companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/listallcompanies","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/listallcompanies","metadata":{"seo":{"title":"List all companies","description":"You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllCompanies","name":"List all companies","isWebhook":false,"pointer":"/paths/~1companies~1list/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can list companies. The company list is sorted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_request_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and by default is ordered descending, most recently requested first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the API does not include companies who have no associated users in list responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/reference#iterating-over-all-companies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scroll API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Going past that limit returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bad_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Pagination"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint pages by page number, not by cursor. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object of the response. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope. A token with only read scopes cannot call this endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_1175","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many results to return per page. Defaults to 15. A value above 60 returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":15},{"name":"order","in":"query","schemaId":"schema_1178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Return the companies in ascending or descending order. Defaults to desc. Any other value returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1companies~1list/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1list/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/list","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":15,"schemaId":"schema_1175"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1178"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/companies/list","href":"companies/listallcompanies","openApiOperationId":"listAllCompanies","summary":"List all companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies~1list/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies~1list/post/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1list/post/responses/400/content/application~1json/examples/Page limit reached"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1list/post/responses/400/content/application~1json/examples/Page limit reached"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1list/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1list/post/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1companies~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies~1list/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies~1list/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1list/post/responses/400/content/application~1json/examples/Page limit reached"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/400/content/application~1json/examples/Per page too big","paths/~1companies~1list/post/responses/400/content/application~1json/examples/Page limit reached"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1list/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1list/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listallcompanies"}],"panels":[]}]},"httpPath":"/companies/list"},{"label":"Scroll over all companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/scrolloverallcompanies","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/scrolloverallcompanies","metadata":{"seo":{"title":"Scroll over all companies","description":"The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scrollOverAllCompanies","name":"Scroll over all companies","isWebhook":false,"pointer":"/paths/~1companies~1scroll/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scroll over all companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list all companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each app can only have 1 scroll open at a time. Starting a second one returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scroll_exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the scroll isn't used for 1 minute, it expires and calls with that scroll param return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the end of the scroll is reached, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be empty and the scroll parameter will expire."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response always has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scroll_param"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch the next page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Scroll Parameter"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get the first page of companies by simply sending a GET request to the scroll endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For subsequent requests you will need to use the scroll parameter from the response."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"danger","name":"Scroll network timeouts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Request failed due to an internal network error. Please restart the scroll operation.\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"scroll_param","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scroll_param"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the previous response. Omit it to start a new scroll."},"children":[]}]}]}],"example":"69352cd2-ab5b-42ac-b004-a13d4e55e9b0"}],"pointer":"/paths/~1companies~1scroll/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1scroll/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/scroll","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"scroll_param","in":"query","required":false,"example":"69352cd2-ab5b-42ac-b004-a13d4e55e9b0","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","503"],"pointer":"/companies/scroll","href":"companies/scrolloverallcompanies","openApiOperationId":"scrollOverAllCompanies","summary":"Scroll over all companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_scroll","exampleIds":["paths/~1companies~1scroll/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_scroll","exampleIds":["paths/~1companies~1scroll/get/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/400/content/application~1json/examples/Scroll already open"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/400/content/application~1json/examples/Scroll already open"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Scroll Parameter Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/404/content/application~1json/examples/Scroll parameter not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/404/content/application~1json/examples/Scroll parameter not found"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/503/content/application~1json/examples/Scroll temporarily unavailable"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/503/content/application~1json/examples/Scroll temporarily unavailable"]}],"pointer":"/paths/~1companies~1scroll/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_scroll","exampleIds":["paths/~1companies~1scroll/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_scroll","exampleIds":["paths/~1companies~1scroll/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/400/content/application~1json/examples/Scroll already open"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/400/content/application~1json/examples/Scroll already open"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/404/content/application~1json/examples/Scroll parameter not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/404/content/application~1json/examples/Scroll parameter not found"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/503/content/application~1json/examples/Scroll temporarily unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/503/content/application~1json/examples/Scroll temporarily unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/scrolloverallcompanies"}],"panels":[]}]},"httpPath":"/companies/scroll"},{"label":"Attach a Contact to a Company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/attachcontacttoacompany","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/attachcontacttoacompany","metadata":{"seo":{"title":"Attach a Contact to a Company","description":"You can attach a company to a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachContactToACompany","name":"Attach a Contact to a Company","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a Contact to a Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can attach a company to a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/companies","href":"companies/attachcontacttoacompany","openApiOperationId":"attachContactToACompany","summary":"Attach a Contact to a Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found or Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/attachcontacttoacompany"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/companies"},{"label":"List attached companies for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/listcompaniesforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/listcompaniesforacontact","metadata":{"seo":{"title":"List attached companies for contact","description":"You can fetch a list of companies that are associated to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompaniesForAContact","name":"List attached companies for contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached companies for contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of companies that are associated to a contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1181","description":"The page of results to fetch. Values below 1 are treated as 1."},{"name":"per_page","in":"query","schemaId":"schema_1182","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of companies to return per page. The maximum is 60; a value above 60 returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1183","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the companies by when they were last active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_request_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The value is case-insensitive, and any value other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1181"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1182"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1183"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/companies","href":"companies/listcompaniesforacontact","openApiOperationId":"listCompaniesForAContact","summary":"List attached companies for contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/companies"},{"label":"Detach a contact from a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/detachcontactfromacompany","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/detachcontactfromacompany","metadata":{"seo":{"title":"Detach a contact from a company","description":"You can detach a company from a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachContactFromACompany","name":"Detach a contact from a company","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach a contact from a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can detach a company from a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"},{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_1152"},{"name":"company_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/companies/{company_id}","href":"companies/detachcontactfromacompany","openApiOperationId":"detachContactFromACompany","summary":"Detach a contact from a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found or Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/detachcontactfromacompany"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/companies/{company_id}"},{"label":"List granted companies for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/listgrantedcompaniesforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/listgrantedcompaniesforacontact","metadata":{"seo":{"title":"List granted companies for a contact","description":"List the companies a contact has been granted access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGrantedCompaniesForAContact","name":"List granted companies for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List granted companies for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the companies a contact has been granted access to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A granted company lets the contact read that company's tickets in the customer portal. It is separate from company membership — granting a company does not attach the contact to it, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/listcompaniesforacontact"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{id}/companies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not include grants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values you set on your companies, so the list round-trips with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /contacts/{contact_id}/granted_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The list is sorted by company id and paginated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an empty list when granted companies are not enabled for the workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1153","description":"The page number to retrieve, starting at 1.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1184","description":"The number of company ids to return per page. Values above 150 are reduced to 150.","example":50},{"name":"order","in":"query","schemaId":"schema_1185","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direction to sort the company ids in. Any other value is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"asc"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/granted_companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1153"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1184"},{"name":"order","in":"query","required":false,"example":"asc","schemaId":"schema_1185"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/granted_companies","href":"companies/listgrantedcompaniesforacontact","openApiOperationId":"listGrantedCompaniesForAContact","summary":"List granted companies for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"]}},"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listgrantedcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/granted_companies"},{"label":"Replace granted companies for a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/replacegrantedcompaniesforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/replacegrantedcompaniesforacontact","metadata":{"seo":{"title":"Replace granted companies for a contact","description":"Replace the full set of companies a contact has been granted access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceGrantedCompaniesForAContact","name":"Replace granted companies for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace granted companies for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace the full set of companies a contact has been granted access to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a replacement, not an append. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send become the contact's entire granted set — any company id you leave out is dropped. To add a company, send the existing ids plus the new one; to remove one, send the existing ids minus that one; to drop every grant, send an empty array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify companies by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you set on them, the same values "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{contact_id}/granted_companies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns. Duplicates in the request are collapsed. A contact can be granted at most 100 companies."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response echoes the stored set, so a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is confirmation of exactly what the contact can now read."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Requires granted companies to be enabled"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granted_companies_not_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless granted companies are enabled for the workspace. Contact Intercom Support to enable it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"]}},"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{contact_id}/granted_companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"]}},"responseCodes":["200","400","401","404","503"],"pointer":"/contacts/{contact_id}/granted_companies","href":"companies/replacegrantedcompaniesforacontact","openApiOperationId":"replaceGrantedCompaniesForAContact","summary":"Replace granted companies for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"]}},"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — the requested companies could not be read, retry the request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/replacegrantedcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/granted_companies"},{"label":"Remove a granted company from a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/companies/removegrantedcompanyfromacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/removegrantedcompanyfromacontact","metadata":{"seo":{"title":"Remove a granted company from a contact","description":"Remove a single company from a contact's granted set, leaving the contact's other grants in place."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeGrantedCompanyFromAContact","name":"Remove a granted company from a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a granted company from a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a single company from a contact's granted set, leaving the contact's other grants in place."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify the company by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you set on it, the same value "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{contact_id}/granted_companies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" containing a dot or a slash is supported — URL-encode a slash as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%2F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not idempotent. Removing a company the contact is not currently granted returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so repeating a successful call returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Treat the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Requires granted companies to be enabled"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granted_companies_not_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless granted companies are enabled for the workspace. Contact Intercom Support to enable it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"company_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you set on the company, as returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"acme-corp"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/granted_companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"},{"name":"company_id","in":"path","required":true,"example":"acme-corp","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/contacts/{contact_id}/granted_companies/{company_id}","href":"companies/removegrantedcompanyfromacontact","openApiOperationId":"removeGrantedCompanyFromAContact","summary":"Remove a granted company from a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The grant was removed. No content is returned."},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/removegrantedcompanyfromacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/granted_companies/{company_id}"},{"type":"link","label":"Company","link":"/docs/references/rest-api/api.intercom.io/companies/company","routeSlug":"/docs/references/rest-api/api.intercom.io/companies/company","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company"},"seo":{"title":"Company"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Companies"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Company","link":"/companies/company","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies","summary":"Create or Update a company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/createorupdatecompany","deprecated":false},{"title":"/companies","summary":"Retrieve companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/retrievecompany","deprecated":false},{"title":"/companies/{company_id}","summary":"Retrieve a company by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/retrieveacompanybyid","deprecated":false},{"title":"/companies/{company_id}","summary":"Update a company","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/updatecompany","deprecated":false},{"title":"/companies/{company_id}","summary":"Delete a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/companies/deletecompany","deprecated":false},{"title":"/companies/{company_id}/contacts","summary":"List attached contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listattachedcontacts","deprecated":false},{"title":"/companies/{company_id}/segments","summary":"List attached segments for companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listattachedsegmentsforcompanies","deprecated":false},{"title":"/companies/{company_id}/notes","summary":"List all company notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listcompanynotes","deprecated":false},{"title":"/companies/{company_id}/notes","summary":"Create a company note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/createcompanynote","deprecated":false},{"title":"/companies/search","summary":"Search companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/searchcompanies","deprecated":false},{"title":"/companies/list","summary":"List all companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/listallcompanies","deprecated":false},{"title":"/companies/scroll","summary":"Scroll over all companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/scrolloverallcompanies","deprecated":false},{"title":"/contacts/{contact_id}/companies","summary":"Attach a Contact to a Company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/attachcontacttoacompany","deprecated":false},{"title":"/contacts/{contact_id}/companies","summary":"List attached companies for contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/companies/{company_id}","summary":"Detach a contact from a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/companies/detachcontactfromacompany","deprecated":false},{"title":"/contacts/{contact_id}/granted_companies","summary":"List granted companies for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listgrantedcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/granted_companies","summary":"Replace granted companies for a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/replacegrantedcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/granted_companies/{company_id}","summary":"Remove a granted company from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/companies/removegrantedcompanyfromacontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Contacts","link":"/docs/references/rest-api/api.intercom.io/contacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts","items":[{"label":"List attached contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listattachedcontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listattachedcontacts","metadata":{"seo":{"title":"List attached contacts","description":"You can fetch a list of all contacts that belong to a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAttachedContacts","name":"List attached contacts","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all contacts that belong to a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1150","description":"How many contacts to return per page. Defaults to 50.","example":50},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to fetch the next page of contacts. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the previous response."},"children":[]}]}]}]},{"name":"include_merge_history","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include each contact's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merge_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Any other value omits it."},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{company_id}/contacts","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"},{"name":"include_merge_history","in":"query","required":false,"example":"true","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}/contacts","href":"contacts/listattachedcontacts","openApiOperationId":"ListAttachedContacts","summary":"List attached contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{company_id}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listattachedcontacts"}],"panels":[]}]},"httpPath":"/companies/{company_id}/contacts"},{"label":"Attach a Contact to a Company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/attachcontacttoacompany","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/attachcontacttoacompany","metadata":{"seo":{"title":"Attach a Contact to a Company","description":"You can attach a company to a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachContactToACompany","name":"Attach a Contact to a Company","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a Contact to a Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can attach a company to a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/companies","href":"contacts/attachcontacttoacompany","openApiOperationId":"attachContactToACompany","summary":"Attach a Contact to a Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1180","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found or Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/attachcontacttoacompany"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/companies"},{"label":"List attached companies for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listcompaniesforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listcompaniesforacontact","metadata":{"seo":{"title":"List attached companies for contact","description":"You can fetch a list of companies that are associated to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompaniesForAContact","name":"List attached companies for contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached companies for contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of companies that are associated to a contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1181","description":"The page of results to fetch. Values below 1 are treated as 1."},{"name":"per_page","in":"query","schemaId":"schema_1182","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of companies to return per page. The maximum is 60; a value above 60 returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1183","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the companies by when they were last active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_request_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The value is case-insensitive, and any value other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1181"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1182"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1183"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/companies","href":"contacts/listcompaniesforacontact","openApiOperationId":"listCompaniesForAContact","summary":"List attached companies for contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/companies"},{"label":"Detach a contact from a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/detachcontactfromacompany","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/detachcontactfromacompany","metadata":{"seo":{"title":"Detach a contact from a company","description":"You can detach a company from a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachContactFromACompany","name":"Detach a contact from a company","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach a contact from a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can detach a company from a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"},{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_1152"},{"name":"company_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/companies/{company_id}","href":"contacts/detachcontactfromacompany","openApiOperationId":"detachContactFromACompany","summary":"Detach a contact from a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company Not Found or Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/detachcontactfromacompany"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/companies/{company_id}"},{"label":"List all notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listnotes","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listnotes","metadata":{"seo":{"title":"List all notes","description":"You can fetch a list of notes that are associated to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNotes","name":"List all notes","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of notes that are associated to a contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a contact.","required":true}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of results to return. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of notes to return per page. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":50},{"name":"order","in":"query","schemaId":"schema_1178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order the notes are returned in, by id. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1178"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/notes","href":"contacts/listnotes","openApiOperationId":"listNotes","summary":"List all notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listnotes"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/notes"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/createnote","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/createnote","metadata":{"seo":{"title":"Create a note","description":"You can add a note to a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNote","name":"Create a note","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add a note to a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given contact.","required":true,"example":"6762f0ad1bb69f9f2193bb62"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"6762f0ad1bb69f9f2193bb62","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/notes","href":"contacts/createnote","openApiOperationId":"createNote","summary":"Create a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/createnote"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/notes"},{"label":"List attached segments for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listsegmentsforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listsegmentsforacontact","metadata":{"seo":{"title":"List attached segments for contact","description":"You can fetch a list of segments that are associated to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSegmentsForAContact","name":"List attached segments for contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached segments for contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of segments that are associated to a contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/segments","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/segments","href":"contacts/listsegmentsforacontact","openApiOperationId":"listSegmentsForAContact","summary":"List attached segments for contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listsegmentsforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/segments"},{"label":"List subscriptions for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listsubscriptionsforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listsubscriptionsforacontact","metadata":{"seo":{"title":"List subscriptions for a contact","description":"You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.This will return a list of Subscription Type objects that the contact is associated with."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptionsForAContact","name":"List subscriptions for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a list of Subscription Type objects that the contact is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data property will show a combined list of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.Opt-out subscription types that the user has opted-out from."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.Opt-in subscription types that the user has opted-in to receiving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/subscriptions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions","href":"contacts/listsubscriptionsforacontact","openApiOperationId":"listSubscriptionsForAContact","summary":"List subscriptions for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listsubscriptionsforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/subscriptions"},{"label":"Add subscription to a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/attachsubscriptiontypetocontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/attachsubscriptiontypetocontact","metadata":{"seo":{"title":"Add subscription to a contact","description":"You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachSubscriptionTypeToContact","name":"Add subscription to a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add subscription to a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a subscription type model for the subscription type that was added to the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"]}},"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/subscriptions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions","href":"contacts/attachsubscriptiontypetocontact","openApiOperationId":"attachSubscriptionTypeToContact","summary":"Add subscription to a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/attachsubscriptiontypetocontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/subscriptions"},{"label":"Remove subscription from a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/detachsubscriptiontypetocontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/detachsubscriptiontypetocontact","metadata":{"seo":{"title":"Remove subscription from a contact","description":"You can remove a specific subscription from a contact. This willreturn a subscription type model for the subscription type that was removedfrom the contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachSubscriptionTypeToContact","name":"Remove subscription from a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove subscription from a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can remove a specific subscription from a contact. This will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return a subscription type model for the subscription type that was removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"subscription_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the subscription type which is given by Intercom","required":true,"example":"37846"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/subscriptions/{subscription_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"},{"name":"subscription_id","in":"path","required":true,"example":"37846","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions/{subscription_id}","href":"contacts/detachsubscriptiontypetocontact","openApiOperationId":"detachSubscriptionTypeToContact","summary":"Remove subscription from a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/detachsubscriptiontypetocontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/subscriptions/{subscription_id}"},{"label":"List tags attached to a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listtagsforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listtagsforacontact","metadata":{"seo":{"title":"List tags attached to a contact","description":"You can fetch a list of all tags that are attached to a specific contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTagsForAContact","name":"List tags attached to a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tags attached to a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of all tags that are attached to a specific contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags","href":"contacts/listtagsforacontact","openApiOperationId":"listTagsForAContact","summary":"List tags attached to a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listtagsforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/tags"},{"label":"Add tag to a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/attachtagtocontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/attachtagtocontact","metadata":{"seo":{"title":"Add tag to a contact","description":"You can tag a specific contact. This will return a tag object forthe tag that was added to the contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToContact","name":"Add tag to a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag to a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can tag a specific contact. This will return a tag object for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the tag that was added to the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags","href":"contacts/attachtagtocontact","openApiOperationId":"attachTagToContact","summary":"Add tag to a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/attachtagtocontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/tags"},{"label":"Remove tag from a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/detachtagfromcontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/detachtagfromcontact","metadata":{"seo":{"title":"Remove tag from a contact","description":"You can remove tag from a specific contact. This will return atag object for the tag that was removed from the contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromContact","name":"Remove tag from a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can remove tag from a specific contact. This will return a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag object for the tag that was removed from the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"tag_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the tag which is given by Intercom","required":true,"example":"7522907"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags/{tag_id}","href":"contacts/detachtagfromcontact","openApiOperationId":"detachTagFromContact","summary":"Remove tag from a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/detachtagfromcontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/tags/{tag_id}"},{"label":"List deleted contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listdeletedcontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listdeletedcontacts","metadata":{"seo":{"title":"List deleted contacts","description":"Fetch a paginated list of the contacts in your workspace that are no longer active,so you can recover ones whose id, email, or external_id you no longer have andthen permanently delete them. Each entry carries a status describing why the contactis inactive: archived, blocked, merged, pending_deletion, or permanently_deleted.merged_into_id is present only when status is merged, and external_id and emailare null for permanently_deleted contacts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDeletedContacts","name":"List deleted contacts","isWebhook":false,"pointer":"/paths/~1contacts~1deleted/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List deleted contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch a paginated list of the contacts in your workspace that are no longer active,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so you can recover ones whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you no longer have and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then permanently delete them. Each entry carries a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describing why the contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is inactive: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_deletion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permanently_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged_into_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permanently_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of results per page. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; larger values are treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the leading digits are read, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A value that doesn't start with a positive integer, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_1159","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of results to fetch. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"escape_identity","in":"query","schemaId":"schema_1190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the response are HTML-escaped (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return them unescaped."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1deleted/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1deleted/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/deleted","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1189"},{"name":"page","in":"query","required":false,"schemaId":"schema_1159"},{"name":"escape_identity","in":"query","required":false,"schemaId":"schema_1190"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/contacts/deleted","href":"contacts/listdeletedcontacts","openApiOperationId":"listDeletedContacts","summary":"List deleted contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_contact_list","exampleIds":["paths/~1contacts~1deleted/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_contact_list","exampleIds":["paths/~1contacts~1deleted/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Invalid per_page"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Invalid per_page"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1contacts~1deleted/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_contact_list","exampleIds":["paths/~1contacts~1deleted/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_contact_list","exampleIds":["paths/~1contacts~1deleted/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Invalid per_page"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Invalid per_page"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listdeletedcontacts"}],"panels":[]}]},"httpPath":"/contacts/deleted"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/updatecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/updatecontact","metadata":{"seo":{"title":"Update a contact","description":"You can update an existing contact (ie. user or lead)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateContact","name":"Update a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing contact (ie. user or lead)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint handles both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom object associations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update a contact with an association to a custom object instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request/response examples to see the custom object association format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"id","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1{contact_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"]}},"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"],"pointer":"/paths/~1contacts~1{contact_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{contact_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/contacts/{contact_id}","href":"contacts/updatecontact","openApiOperationId":"UpdateContact","summary":"Update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"]}},"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"]}],"pointer":"/paths/~1contacts~1{contact_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/updatecontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/showcontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/showcontact","metadata":{"seo":{"title":"Get a contact","description":"You can fetch the details of a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ShowContact","name":"Get a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Merged contacts return 410 Gone"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a contact has been merged into another contact via the Merge endpoint ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /contacts/merge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), requesting it by its original ID will return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 410 Gone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header pointing to the canonical (merged-into) contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response headers:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Link: </contacts/{canonical_id}>; rel=\"canonical\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Link: </contacts/{canonical_id}>; rel=\"canonical\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"type\": \"error.list\",\n  \"errors\": [{ \"code\": \"contact_merged\", \"message\": \"This contact has been merged. See the 'Link' header for the canonical contact.\" }]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"type\": \"error.list\",\n  \"errors\": [{ \"code\": \"contact_merged\", \"message\": \"This contact has been merged. See the 'Link' header for the canonical contact.\" }]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header contains the path to the final merge target, resolving multi-hop merge chains (up to 3 hops)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_single_user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_id"},"children":[]}]}]}],"required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges."},"children":[]}]}]}]},{"name":"escape_identity","in":"query","schemaId":"schema_1190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the response, including nested ones such as social profile names, are HTML-escaped (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Custom attributes and tags are never escaped. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return them unescaped."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"},{"name":"escape_identity","in":"query","required":false,"schemaId":"schema_1190"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","410"],"pointer":"/contacts/{contact_id}","href":"contacts/showcontact","openApiOperationId":"ShowContact","summary":"Get a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/404/content/application~1json/examples/Contact not found"]},{"code":"410","description":"Contact Merged","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/410/content/application~1json/examples/Contact Merged"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/410/content/application~1json/examples/Contact Merged"],"headers":{"Link":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the canonical (merged-into) contact. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"</contacts/{id}>; rel=\"canonical\""},"children":[]}]}]}],"schema":{"type":"string","example":"</contacts/6762f0d01bb69f9f2193bb7d>; rel=\"canonical\""}}},"headerSchemaId":"schema_1194"}],"pointer":"/paths/~1contacts~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"410","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/410/content/application~1json/examples/Contact Merged"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/410/content/application~1json/examples/Contact Merged"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/showcontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/deletecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/deletecontact","metadata":{"seo":{"title":"Delete a contact","description":"You can delete a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteContact","name":"Delete a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_id"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{contact_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}","href":"contacts/deletecontact","openApiOperationId":"DeleteContact","summary":"Delete a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_deleted"}},"schemaId":"components/schemas/contact_deleted"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_deleted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_deleted"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/deletecontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}"},{"label":"Merge a lead and a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/mergecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/mergecontact","metadata":{"seo":{"title":"Merge a lead and a user","description":"You can merge a contact with a role of lead into a contact with a role of user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MergeContact","name":"Merge a lead and a user","isWebhook":false,"pointer":"/paths/~1contacts~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge a lead and a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can merge a contact with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into a contact with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Merged contacts are not retrievable via the API"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a merge is completed, the source contact ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is permanently removed from the active contact list. This means:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /contacts/{id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Requesting the source contact by its original ID returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"410 Gone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header pointing to the contact it was merged into. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/showcontact"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a contact"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /contacts/search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The source contact will not appear in search results, including queries filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The source contact will not appear in list results."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the target contact ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") remains accessible. If your application stores contact IDs, update them to use the target contact's ID after a merge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the merge history of the resulting contact in the response, with at most the 10 most recent merges."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1merge/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation"]}},"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation"],"pointer":"/paths/~1contacts~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/merge","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation"]}},"responseCodes":["200","400","401","404","409"],"pointer":"/contacts/merge","href":"contacts/mergecontact","openApiOperationId":"MergeContact","summary":"Merge a lead and a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/400/content/application~1json/examples/Not a duplicate"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/400/content/application~1json/examples/Not a duplicate"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/404/content/application~1json/examples/Contact not found"]},{"code":"409","description":"Merge in progress","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/409/content/application~1json/examples/Merge in progress"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/409/content/application~1json/examples/Merge in progress"]}],"pointer":"/paths/~1contacts~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1193","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/400/content/application~1json/examples/Not a duplicate"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/400/content/application~1json/examples/Not a duplicate"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/409/content/application~1json/examples/Merge in progress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/409/content/application~1json/examples/Merge in progress"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/mergecontact"}],"panels":[]}]},"httpPath":"/contacts/merge"},{"label":"Preview a contact merge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/previewmergecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/previewmergecontact","metadata":{"seo":{"title":"Preview a contact merge","description":"Preview the result of merging one contact into another without applying the merge. This is a read-only dry run: it reports whether the merge is allowed and, if so, exactly what would change, without modifying any data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PreviewMergeContact","name":"Preview a contact merge","isWebhook":false,"pointer":"/paths/~1contacts~1merge~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview a contact merge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview the result of merging one contact into another without applying the merge. This is a read-only dry run: it reports whether the merge is allowed and, if so, exactly what would change, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without modifying any data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contact IDs you would pass to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/mergecontact"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge two contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can merge a contact with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into a contact with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can optionally pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_attribute_names"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include specific custom attributes in the previewed attribute changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every attribute change (with the resulting value on the surviving contact) and, for each object type, two counts — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", how many are on the source contact and would move to the destination, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", how many the destination already has. Counts are reported for conversations, tickets, phone calls, notes, and tags. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counts non-ticket conversations only; tickets are reported separately under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tickets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_calls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present only for phone-channel merges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each reason has a stable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you can branch on and a human-readable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you can display."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Previewing non-duplicate contacts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default a merge requires the two contacts to share an identifier (email or phone). Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip_duplicate_validation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to preview a merge of contacts that don't, the same rule the merge endpoint enforces."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons[].code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_same_as_target"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source contact ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and the destination contact ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are the same contact. A contact can't be merged into itself."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_merge_role_pair"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" roles aren't mergeable. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_shared_identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contacts share no email or phone. The source's phone also counts as shared when it matches the destination's WhatsApp number. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip_duplicate_validation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to preview anyway."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebook_user"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Facebook contacts can't be merged."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_lead_channel_not_allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source is an external-channel lead that isn't eligible for merging."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailing_list"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts created from a mailing list can't be merged."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp_data_cannot_be_merged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The WhatsApp number on the source contact can't be reassigned to the destination."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"telegram_data_cannot_be_merged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Telegram sender on the source contact can't be reassigned to the destination."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ms_teams_data_cannot_be_merged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination contact already has a Microsoft Teams sender for the same team as the source contact, so the source's sender can't be reassigned to it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_data_cannot_be_merged"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone data on the source contact can't be reassigned to the destination."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1merge~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_preview_request","exampleIds":["paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed"]}},"schemaId":"components/schemas/merge_preview_request","exampleIds":["paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed"],"pointer":"/paths/~1contacts~1merge~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/merge/preview","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/merge_preview_request","exampleIds":["paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed"]}},"responseCodes":["200","401","404"],"pointer":"/contacts/merge/preview","href":"contacts/previewmergecontact","openApiOperationId":"PreviewMergeContact","summary":"Preview a contact merge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/merge_preview_request","exampleIds":["paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_preview_request","exampleIds":["paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merge_preview_response","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/allowed","paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/blocked"]}},"schemaId":"components/schemas/merge_preview_response","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/allowed","paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/blocked"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1merge~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/merge_preview_response","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/allowed","paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/blocked"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merge_preview_response","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/allowed","paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/blocked"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge~1preview/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/previewmergecontact"}],"panels":[]}]},"httpPath":"/contacts/merge/preview"},{"label":"Search contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/searchcontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/searchcontacts","metadata":{"seo":{"title":"Search contacts","description":"You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SearchContacts","name":"Search contacts","isWebhook":false,"pointer":"/paths/~1contacts~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To search for contacts, you need to send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/contacts/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will accept a query object in the body which will define your filters in order to search for contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Optimizing search queries"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search queries can be complex, so optimizing them can help the performance of your search."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators to combine multiple filters to get the exact results you need and utilize"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"contacts/searchcontacts/request/merged-contacts","deepLinkHash":"/contacts/searchcontacts#contacts/searchcontacts/request/merged-contacts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merged Contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts that have been merged (via POST /contacts/merge) are excluded from search results. If a contact was recently merged into another, it will no longer appear in queries filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or any other field. Only the target contact from the merge remains searchable."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"contacts/searchcontacts/request/contact-creation-delay","deepLinkHash":"/contacts/searchcontacts#contacts/searchcontacts/request/contact-creation-delay"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Creation Delay"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"contacts/searchcontacts/request/nesting-and-limitations","deepLinkHash":"/contacts/searchcontacts#contacts/searchcontacts/request/nesting-and-limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nesting & Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are some limitations to the amount of multiple's there can be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 2 nested filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 15 filters for each AND or OR group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 15 values in an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination.per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be between 1 and 150"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"contacts/searchcontacts/request/searching-for-timestamp-fields","deepLinkHash":"/contacts/searchcontacts#contacts/searchcontacts/request/searching-for-timestamp-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for Timestamp Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard timestamp fields and Date custom attributes behave differently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard timestamp fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_seen_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" etc.) are filtered on the exact second, in UTC. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches only Contacts whose value is that exact second, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" compare against the exact instant you pass - the value is not rounded or truncated. These fields report a type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the Data Attributes endpoint. Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also matches Contacts with no value set for the field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date custom attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are matched by calendar day, and the day boundary is always UTC regardless of your workspace's timezone. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches the whole UTC day, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches from the start of the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" UTC day, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches everything before the start of that day. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators are not supported on these fields and return an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1577869200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (January 1st, 2020 9:00 AM UTC) returns Contacts created after that exact instant. Passing the same value for a Date custom attribute truncates it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1577836800"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (January 1st, 2020 12:00 AM UTC), so those results begin from January 2nd, 2020 12:00 AM UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only search queries behave this way. Responses always carry the full UNIX timestamp, and sorting uses the full value."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"contacts/searchcontacts/request/accepted-fields","deepLinkHash":"/contacts/searchcontacts#contacts/searchcontacts/request/accepted-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a date, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be a string such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"foorbar\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"role"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts user or lead; contact is treated as lead"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"avatar"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owner_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email_domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signed_up_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_seen_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_contacted_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_replied_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_email_opened_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_email_clicked_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language_override"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"browser"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"browser_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"browser_language"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"os"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location.country"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location.region"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location.city"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unsubscribed_from_emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"marked_email_as_spam"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has_hard_bounced"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone_country"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack_email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fin_qualification_status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whatsapp_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only on workspaces with the WhatsApp integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_last_seen_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_app_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_device"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_os_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_app_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_sdk_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_last_seen_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_app_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_device"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_os_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_app_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_sdk_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled_push_messaging"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"segment_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_attributes.{attribute_name}"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matches the attribute's own type"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(String, Integer, Float, Boolean or Date)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ios_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ios_app_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are searchable only once your workspace has been set up for the Intercom iOS SDK or has received a request from it, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"android_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"android_app_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only once the same is true for the Android SDK. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_push_messaging"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs either. Until then, they return an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"contacts/searchcontacts/request/accepted-operators","deepLinkHash":"/contacts/searchcontacts#contacts/searchcontacts/request/accepted-operators"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Operators"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Operators not supported on Date custom attributes"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date custom attributes do not support the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators. Using them returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error. Standard timestamp fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" etc.) do support these operators, and are filtered on the exact second."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"=\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Which operators are valid depends on the field's type - see the \"Valid Types\" column below. Searching by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators, with a single ID string as the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is accepted only with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (matches Contacts with no value set) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (matches Contacts with any value set). An array value is accepted only with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". String values must be shorter than 256 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All except Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Equal"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also matches Contacts with no value set"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All except Date, Datetime, tag_id and segment_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values must be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All except Date, Datetime, tag_id and segment_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not In"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR !"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values must be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Float"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On Date custom attributes, matches from the start of the next day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Float"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower than"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On Date custom attributes, matches before the start of the day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Float"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than or equal to"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not supported on Date custom attributes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Float"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower than or equal to"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not supported on Date custom attributes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Contain"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"^"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts With"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ends With"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the query string to include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merge_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on each contact in the response; a JSON boolean in the request body is ignored. Returned for contacts of any role, with at most the 10 most recent merges."},"children":[]}]}]}]},{"name":"escape_identity","in":"query","schemaId":"schema_1190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the response, including nested ones such as social profile names, are HTML-escaped (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Custom attributes and tags are never escaped. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return them unescaped."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1search/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/contact_search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1contacts~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"},{"name":"escape_identity","in":"query","required":false,"schemaId":"schema_1190"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/contact_search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","422"],"pointer":"/contacts/search","href":"contacts/searchcontacts","openApiOperationId":"SearchContacts","summary":"Search contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/contact_search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/contact_search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts~1search/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts~1search/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid value","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Query nested too deeply","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid per_page"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid value","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Query nested too deeply","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid per_page"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Unsupported operator on a Date custom attribute","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/422/content/application~1json/examples/Unsupported date comparison"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/422/content/application~1json/examples/Unsupported date comparison"]}],"pointer":"/paths/~1contacts~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts~1search/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts~1search/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid value","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Query nested too deeply","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid per_page"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid value","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Query nested too deeply","paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid per_page"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/422/content/application~1json/examples/Unsupported date comparison"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/422/content/application~1json/examples/Unsupported date comparison"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/searchcontacts"}],"panels":[]}]},"httpPath":"/contacts/search"},{"label":"List all contact activities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listcontactactivities","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listcontactactivities","metadata":{"seo":{"title":"List all contact activities","description":"You can fetch a list of contact activity events for your workspace, such as when contacts are created, role updated, merged, or deleted. Events are returned oldest first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListContactActivities","name":"List all contact activities","isWebhook":false,"pointer":"/paths/~1contacts~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all contact activities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of contact activity events for your workspace, such as when contacts are created, role updated, merged, or deleted. Events are returned oldest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the activity store can't be read, this endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the same response as when there are no new events."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Pagination"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page, with a maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of results to return per page. Defaults to 50, minimum 1, maximum 150; larger values are treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the leading digits are read, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A value that doesn't start with a positive integer, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next.starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous response. Used to paginate through results."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1activities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/activities","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1160"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/contacts/activities","href":"contacts/listcontactactivities","openApiOperationId":"ListContactActivities","summary":"List all contact activities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_activity_list","exampleIds":["paths/~1contacts~1activities/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_activity_list","exampleIds":["paths/~1contacts~1activities/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/400/content/application~1json/examples/Invalid per_page"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/400/content/application~1json/examples/Invalid per_page"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1contacts~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_activity_list","exampleIds":["paths/~1contacts~1activities/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_activity_list","exampleIds":["paths/~1contacts~1activities/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/400/content/application~1json/examples/Invalid per_page"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/400/content/application~1json/examples/Invalid per_page"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactactivities"}],"panels":[]}]},"httpPath":"/contacts/activities"},{"label":"List all contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listcontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listcontacts","metadata":{"seo":{"title":"List all contacts","description":"You can fetch a list of all contacts (ie. users or leads) in your workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListContacts","name":"List all contacts","isWebhook":false,"pointer":"/paths/~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all contacts (ie. users or leads) in your workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Merged contacts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts that have been merged (via POST /contacts/merge) will not appear in list results. Only the target contact from the merge remains accessible."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Pagination"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page, with a maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merge_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on each contact in the response. Returned for contacts of any role, with at most the 10 most recent merges."},"children":[]}]}]}]},{"name":"escape_identity","in":"query","schemaId":"schema_1190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the response, including nested ones such as social profile names, are HTML-escaped (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Custom attributes and tags are never escaped. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return them unescaped."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_1189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of results per page. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; larger values are treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the leading digits are read, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A value that doesn't start with a positive integer, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next.starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous response. An empty value is ignored. A value that isn't a valid cursor returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"},{"name":"escape_identity","in":"query","required":false,"schemaId":"schema_1190"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1189"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/contacts","href":"contacts/listcontacts","openApiOperationId":"ListContacts","summary":"List all contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_list","exampleIds":["paths/~1contacts/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontacts"}],"panels":[]}]},"httpPath":"/contacts"},{"label":"Create contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/createcontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/createcontact","metadata":{"seo":{"title":"Create contact","description":"You can create a new contact (ie. user or lead)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateContact","name":"Create contact","isWebhook":false,"pointer":"/paths/~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new contact (ie. user or lead)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1195","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1195","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1195","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","409","422"],"pointer":"/contacts","href":"contacts/createcontact","openApiOperationId":"CreateContact","summary":"Create contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1195","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1195","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_1193","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts/post/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid custom attributes"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts/post/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid custom attributes"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"409","description":"Contact already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/409/content/application~1json/examples/Contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Archived contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Multiple matching contacts","paths/~1contacts/post/responses/409/content/application~1json/examples/Contact created at the same time"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/409/content/application~1json/examples/Contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Archived contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Multiple matching contacts","paths/~1contacts/post/responses/409/content/application~1json/examples/Contact created at the same time"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/422/content/application~1json/examples/Invalid email"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/422/content/application~1json/examples/Invalid email"]}],"pointer":"/paths/~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1193","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts/post/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid custom attributes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts/post/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts/post/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid custom attributes"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/409/content/application~1json/examples/Contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Archived contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Multiple matching contacts","paths/~1contacts/post/responses/409/content/application~1json/examples/Contact created at the same time"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/409/content/application~1json/examples/Contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Archived contact already exists","paths/~1contacts/post/responses/409/content/application~1json/examples/Multiple matching contacts","paths/~1contacts/post/responses/409/content/application~1json/examples/Contact created at the same time"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/422/content/application~1json/examples/Invalid email"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/422/content/application~1json/examples/Invalid email"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/createcontact"}],"panels":[]}]},"httpPath":"/contacts"},{"label":"Get a contact by External ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/showcontactbyexternalid","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/showcontactbyexternalid","metadata":{"seo":{"title":"Get a contact by External ID","description":"You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ShowContactByExternalId","name":"Get a contact by External ID","isWebhook":false,"pointer":"/paths/~1contacts~1find_by_external_id~1{external_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a contact by External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Merged contacts return 410 Gone"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the contact with this external ID has been merged into another contact, the API returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP 410 Gone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header pointing to the canonical (merged-into) contact. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on the response format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_single_user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_id","in":"path","schemaId":"schema_1152","description":"The external ID of the user that you want to retrieve","required":true,"example":"cdd29344-5e0c-4ef0-ac56-f9ba2979bc27"}],"pointer":"/paths/~1contacts~1find_by_external_id~1{external_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges."},"children":[]}]}]}]},{"name":"escape_identity","in":"query","schemaId":"schema_1190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the response, including nested ones such as social profile names, are HTML-escaped (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Custom attributes and tags are never escaped. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return them unescaped."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1find_by_external_id~1{external_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1find_by_external_id~1{external_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/find_by_external_id/{external_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"external_id","in":"path","required":true,"example":"cdd29344-5e0c-4ef0-ac56-f9ba2979bc27","schemaId":"schema_1152"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"},{"name":"escape_identity","in":"query","required":false,"schemaId":"schema_1190"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","410"],"pointer":"/contacts/find_by_external_id/{external_id}","href":"contacts/showcontactbyexternalid","openApiOperationId":"ShowContactByExternalId","summary":"Get a contact by External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/404/content/application~1json/examples/Contact not found"]},{"code":"410","description":"Contact Merged","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/410/content/application~1json/examples/Contact Merged"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/410/content/application~1json/examples/Contact Merged"],"headers":{"Link":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the canonical (merged-into) contact. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"</contacts/{id}>; rel=\"canonical\""},"children":[]}]}]}],"schema":{"type":"string","example":"</contacts/6762f0df1bb69f9f2193bb84>; rel=\"canonical\""}}},"headerSchemaId":"schema_1196"}],"pointer":"/paths/~1contacts~1find_by_external_id~1{external_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1193","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"410","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/410/content/application~1json/examples/Contact Merged"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/410/content/application~1json/examples/Contact Merged"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/showcontactbyexternalid"}],"panels":[]}]},"httpPath":"/contacts/find_by_external_id/{external_id}"},{"label":"Archive contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/archivecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/archivecontact","metadata":{"seo":{"title":"Archive contact","description":"You can archive a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ArchiveContact","name":"Archive contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1archive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can archive a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_id"},"children":[]}]}]}],"required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1archive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/archive","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/archive","href":"contacts/archivecontact","openApiOperationId":"ArchiveContact","summary":"Archive contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_archived"}},"schemaId":"components/schemas/contact_archived"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_archived","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_archived"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1archive/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/archivecontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/archive"},{"label":"Unarchive contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/unarchivecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/unarchivecontact","metadata":{"seo":{"title":"Unarchive contact","description":"You can unarchive a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UnarchiveContact","name":"Unarchive contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1unarchive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unarchive contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can unarchive a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_id"},"children":[]}]}]}],"required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1unarchive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1unarchive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/unarchive","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/unarchive","href":"contacts/unarchivecontact","openApiOperationId":"UnarchiveContact","summary":"Unarchive contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_unarchived"}},"schemaId":"components/schemas/contact_unarchived"},{"code":"400","description":"Contact can't be restored","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Blocked contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Merged contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Pending permanent deletion","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Duplicate contact"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Blocked contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Merged contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Pending permanent deletion","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Duplicate contact"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1unarchive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_unarchived","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_unarchived"}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Blocked contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Merged contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Pending permanent deletion","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Duplicate contact"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Blocked contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Merged contact","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Pending permanent deletion","paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Duplicate contact"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1unarchive/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/unarchivecontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/unarchive"},{"label":"List banners for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listcontactbanners","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listcontactbanners","metadata":{"seo":{"title":"List banners for a contact","description":"Returns the banners a contact currently matches, so you can display them onsurfaces outside the Messenger (native mobile apps, kiosks, embedded tools)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactBanners","name":"List banners for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{id}~1banners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List banners for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the banners a contact currently matches, so you can display them on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surfaces outside the Messenger (native mobile apps, kiosks, embedded tools)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each banner in the response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"view_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use it to record a dismissal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the dismiss endpoint. A returned banner is treated as shown: requesting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this endpoint records an impression for each banner returned, so call it at the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"point you are about to display the banners, not speculatively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a contact.","required":true}],"pointer":"/paths/~1contacts~1{id}~1banners/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{id}~1banners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{id}/banners","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{id}/banners","href":"contacts/listcontactbanners","openApiOperationId":"listContactBanners","summary":"List banners for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1banners/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_list","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactbanners"}],"panels":[]}]},"httpPath":"/contacts/{id}/banners"},{"label":"Dismiss a banner for a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/dismisscontactbanner","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/dismisscontactbanner","metadata":{"seo":{"title":"Dismiss a banner for a contact","description":"Records that a contact has dismissed a banner. Dismissals are shared acrosssurfaces, so a banner dismissed through this endpoint will also stop appearingin the web Messenger for that contact, and vice versa."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dismissContactBanner","name":"Dismiss a banner for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dismiss a banner for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records that a contact has dismissed a banner. Dismissals are shared across"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surfaces, so a banner dismissed through this endpoint will also stop appearing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the web Messenger for that contact, and vice versa."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is idempotent: dismissing an already-dismissed banner succeeds and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns the same response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a contact.","required":true},{"name":"view_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"view_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the banner to dismiss, as returned by the list banners endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{id}/banners/{view_id}/dismiss","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"},{"name":"view_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{id}/banners/{view_id}/dismiss","href":"contacts/dismisscontactbanner","openApiOperationId":"dismissContactBanner","summary":"Dismiss a banner for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Banner view or contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/banner_dismiss","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found","paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/dismisscontactbanner"}],"panels":[]}]},"httpPath":"/contacts/{id}/banners/{view_id}/dismiss"},{"label":"Block contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/blockcontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/blockcontact","metadata":{"seo":{"title":"Block contact","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?"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BlockContact","name":"Block contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1block/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Block contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Block a single contact."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" conversations of the contact will also be archived during the process."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More details in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.intercom.com/help/en/articles/8838656-inbox-faqs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAQ How do I block Inbox spam?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_id"},"children":[]}]}]}],"required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1block/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1block/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/block","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/contacts/{contact_id}/block","href":"contacts/blockcontact","openApiOperationId":"BlockContact","summary":"Block contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_blocked"}},"schemaId":"components/schemas/contact_blocked"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Company email address"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Company email address"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1{contact_id}~1block/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_blocked","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_blocked"}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Company email address"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Company email address"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1block/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/blockcontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/block"},{"label":"Get contact merge history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listcontactmergehistory","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listcontactmergehistory","metadata":{"seo":{"title":"Get contact merge history","description":"Retrieve the paginated list of contacts that have been merged into a given contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListContactMergeHistory","name":"Get contact merge history","isWebhook":false,"pointer":"/paths/~1contacts~1{id}~1merge_histories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contact merge history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the paginated list of contacts that have been merged into a given contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only available for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role. Returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the contact is not found or has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The id of the contact to fetch merge history for.","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}~1merge_histories/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for pagination. Pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from a previous response to fetch the next page."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_1160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of results to return per page (default 50, max 150). A value outside 1–150 returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"name":"order","in":"query","schemaId":"schema_1178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order to return results in. Defaults to descending. Any other value returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1{id}~1merge_histories/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{id}~1merge_histories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{id}/merge_histories","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_1152"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1160"},{"name":"order","in":"query","required":false,"schemaId":"schema_1178"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/contacts/{id}/merge_histories","href":"contacts/listcontactmergehistory","openApiOperationId":"ListContactMergeHistory","summary":"Get contact merge history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merge_history_list","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/merge_history_list","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact is not a user"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact is not a user"]},{"code":"422","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid per_page","paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid per_page","paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid cursor"]}],"pointer":"/paths/~1contacts~1{id}~1merge_histories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/merge_history_list","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merge_history_list","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact is not a user"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact is not a user"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid per_page","paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid per_page","paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid cursor"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactmergehistory"}],"panels":[]}]},"httpPath":"/contacts/{id}/merge_histories"},{"label":"Bulk create contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/bulkcreatecontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/bulkcreatecontacts","metadata":{"seo":{"title":"Bulk create contacts","description":"You can bulk create contacts by submitting an array of contact objects. This is a strict create and never updates an existing contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BulkCreateContacts","name":"Bulk create contacts","isWebhook":false,"pointer":"/paths/~1contacts~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk create contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can bulk create contacts by submitting an array of contact objects. This is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"strict create"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and never updates an existing contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint creates an async job that processes the items in the background. Use the returned job ID with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/bulk/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the job status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fields listed in the request schema below can be set. Any other fields in a contact object are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Handling existing contacts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a contact already exists with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (including an archived contact), that item is rejected and the job's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ends as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_with_errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". New contacts in the same request are still created. The job "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/bulk/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the signal that one or more items were rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created contacts aren't returned with IDs in the response. Look them up afterwards with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/showcontactbyexternalid"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a contact by External ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/searchcontacts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Limits"},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum of 100 contacts per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can append tasks to an existing job by including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag application is best-effort and processed asynchronously: unknown tag IDs are skipped, and per-tag results are not returned in the job status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulk_create_contacts_request","exampleIds":["paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job"]}},"schemaId":"components/schemas/bulk_create_contacts_request","exampleIds":["paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job"],"pointer":"/paths/~1contacts~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/bulk","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bulk_create_contacts_request","exampleIds":["paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job"]}},"responseCodes":["202","401","403","404","422"],"pointer":"/contacts/bulk","href":"contacts/bulkcreatecontacts","openApiOperationId":"BulkCreateContacts","summary":"Bulk create contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/bulk_create_contacts_request","exampleIds":["paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulk_create_contacts_request","exampleIds":["paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/post/responses/202/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/post/responses/202/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/403/content/application~1json/examples/job_closed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/403/content/application~1json/examples/job_closed"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/404/content/application~1json/examples/job_not_found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/404/content/application~1json/examples/job_not_found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contact_not_an_object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contact_not_an_object"]}],"pointer":"/paths/~1contacts~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/post/responses/202/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/post/responses/202/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/403/content/application~1json/examples/job_closed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/403/content/application~1json/examples/job_closed"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/404/content/application~1json/examples/job_not_found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/404/content/application~1json/examples/job_not_found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contact_not_an_object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contact_not_an_object"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/bulkcreatecontacts"}],"panels":[]}]},"httpPath":"/contacts/bulk"},{"label":"Bulk update contacts","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/bulkupdatecontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/bulkupdatecontacts","metadata":{"seo":{"title":"Bulk update contacts","description":"You can bulk update contacts by submitting an array of contact objects with the fields to update. Each contact must include an id field identifying the contact to update. You can also add or remove tags on each contact by including a tags object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BulkUpdateContacts","name":"Bulk update contacts","isWebhook":false,"pointer":"/paths/~1contacts~1bulk/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk update contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can bulk update contacts by submitting an array of contact objects with the fields to update. Each contact must include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field identifying the contact to update. You can also add or remove tags on each contact by including a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fields listed in the request schema below can be set. Any other fields in a contact object are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint creates an async job that processes the updates in the background. Use the returned job ID with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/bulk/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the job status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Limits"},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum of 100 contacts per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can append tasks to an existing job by including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag application is best-effort and processed asynchronously: unknown tag IDs are skipped, and per-tag results are not returned in the job status."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1bulk/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulk_update_contacts_request","exampleIds":["paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job"]}},"schemaId":"components/schemas/bulk_update_contacts_request","exampleIds":["paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job"],"pointer":"/paths/~1contacts~1bulk/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/bulk","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bulk_update_contacts_request","exampleIds":["paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job"]}},"responseCodes":["202","401","403","404","422"],"pointer":"/contacts/bulk","href":"contacts/bulkupdatecontacts","openApiOperationId":"BulkUpdateContacts","summary":"Bulk update contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/bulk_update_contacts_request","exampleIds":["paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulk_update_contacts_request","exampleIds":["paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags","paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/put/responses/202/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/put/responses/202/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/403/content/application~1json/examples/job_closed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/403/content/application~1json/examples/job_closed"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/404/content/application~1json/examples/job_not_found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/404/content/application~1json/examples/job_not_found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contact_not_an_object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contact_not_an_object"]}],"pointer":"/paths/~1contacts~1bulk/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/put/responses/202/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk/put/responses/202/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/403/content/application~1json/examples/job_closed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/403/content/application~1json/examples/job_closed"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/404/content/application~1json/examples/job_not_found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/404/content/application~1json/examples/job_not_found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contact_not_an_object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contact_not_an_object"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/bulkupdatecontacts"}],"panels":[]}]},"httpPath":"/contacts/bulk"},{"label":"Bulk delete contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/bulkdeletecontacts","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/bulkdeletecontacts","metadata":{"seo":{"title":"Bulk delete contacts","description":"You can delete contacts in bulk by submitting an array of contact ids."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BulkDeleteContacts","name":"Bulk delete contacts","isWebhook":false,"pointer":"/paths/~1contacts~1bulk~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk delete contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete contacts in bulk by submitting an array of contact "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint creates an async job that processes the deletes in the background. Use the returned job ID with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/bulk/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the job status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Permanent deletion"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A contact that doesn't exist, or can't be deleted, fails that item and the job's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ends as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_with_errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (visible via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/bulk/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") without failing the rest of the batch."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Limits"},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum of 1,000 contacts per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can append tasks to an existing job by including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1bulk~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulk_delete_contacts_request","exampleIds":["paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job"]}},"schemaId":"components/schemas/bulk_delete_contacts_request","exampleIds":["paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job"],"pointer":"/paths/~1contacts~1bulk~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/bulk/delete","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bulk_delete_contacts_request","exampleIds":["paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job"]}},"responseCodes":["202","401","403","404","422"],"pointer":"/contacts/bulk/delete","href":"contacts/bulkdeletecontacts","openApiOperationId":"BulkDeleteContacts","summary":"Bulk delete contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/bulk_delete_contacts_request","exampleIds":["paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bulk_delete_contacts_request","exampleIds":["paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/202/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/202/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/403/content/application~1json/examples/job_closed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/403/content/application~1json/examples/job_closed"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/404/content/application~1json/examples/job_not_found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/404/content/application~1json/examples/job_not_found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contact_not_an_object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contact_not_an_object"]}],"pointer":"/paths/~1contacts~1bulk~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/202/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/202/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/403/content/application~1json/examples/job_closed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/403/content/application~1json/examples/job_closed"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/404/content/application~1json/examples/job_not_found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/404/content/application~1json/examples/job_not_found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contact_not_an_object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_id","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/too_many_contacts","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contacts_not_an_array","paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contact_not_an_object"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/bulkdeletecontacts"}],"panels":[]}]},"httpPath":"/contacts/bulk/delete"},{"label":"Get a bulk update job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/showbulkupdatecontactsjob","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/showbulkupdatecontactsjob","metadata":{"seo":{"title":"Get a bulk update job","description":"You can check the status of a bulk contact update job. The state field indicates the overall job progress: running, completed, or completed_with_errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ShowBulkUpdateContactsJob","name":"Get a bulk update job","isWebhook":false,"pointer":"/paths/~1contacts~1bulk~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a bulk update job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the status of a bulk contact update job. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates the overall job progress: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_with_errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the bulk job.","required":true,"example":"job_v2_1"}],"pointer":"/paths/~1contacts~1bulk~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1bulk~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/bulk/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"job_v2_1","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/bulk/{id}","href":"contacts/showbulkupdatecontactsjob","openApiOperationId":"ShowBulkUpdateContactsJob","summary":"Get a bulk update job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/404/content/application~1json/examples/Job not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/404/content/application~1json/examples/Job not found"]}],"pointer":"/paths/~1contacts~1bulk~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contacts_bulk_job","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/404/content/application~1json/examples/Job not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1bulk~1{id}/get/responses/404/content/application~1json/examples/Job not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/showbulkupdatecontactsjob"}],"panels":[]}]},"httpPath":"/contacts/bulk/{id}"},{"label":"List granted companies for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact","metadata":{"seo":{"title":"List granted companies for a contact","description":"List the companies a contact has been granted access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGrantedCompaniesForAContact","name":"List granted companies for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List granted companies for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the companies a contact has been granted access to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A granted company lets the contact read that company's tickets in the customer portal. It is separate from company membership — granting a company does not attach the contact to it, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/listcompaniesforacontact"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{id}/companies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not include grants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values you set on your companies, so the list round-trips with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /contacts/{contact_id}/granted_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The list is sorted by company id and paginated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an empty list when granted companies are not enabled for the workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1153","description":"The page number to retrieve, starting at 1.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1184","description":"The number of company ids to return per page. Values above 150 are reduced to 150.","example":50},{"name":"order","in":"query","schemaId":"schema_1185","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direction to sort the company ids in. Any other value is treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"asc"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/granted_companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1153"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1184"},{"name":"order","in":"query","required":false,"example":"asc","schemaId":"schema_1185"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/granted_companies","href":"contacts/listgrantedcompaniesforacontact","openApiOperationId":"listGrantedCompaniesForAContact","summary":"List granted companies for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"]}},"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listgrantedcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/granted_companies"},{"label":"Replace granted companies for a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/replacegrantedcompaniesforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/replacegrantedcompaniesforacontact","metadata":{"seo":{"title":"Replace granted companies for a contact","description":"Replace the full set of companies a contact has been granted access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceGrantedCompaniesForAContact","name":"Replace granted companies for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace granted companies for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace the full set of companies a contact has been granted access to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a replacement, not an append. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send become the contact's entire granted set — any company id you leave out is dropped. To add a company, send the existing ids plus the new one; to remove one, send the existing ids minus that one; to drop every grant, send an empty array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify companies by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you set on them, the same values "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{contact_id}/granted_companies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns. Duplicates in the request are collapsed. A contact can be granted at most 100 companies."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response echoes the stored set, so a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is confirmation of exactly what the contact can now read."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Requires granted companies to be enabled"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granted_companies_not_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless granted companies are enabled for the workspace. Contact Intercom Support to enable it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"]}},"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{contact_id}/granted_companies","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"]}},"responseCodes":["200","400","401","404","503"],"pointer":"/contacts/{contact_id}/granted_companies","href":"contacts/replacegrantedcompaniesforacontact","openApiOperationId":"replaceGrantedCompaniesForAContact","summary":"Replace granted companies for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/replace_granted_companies_request","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop","paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"]}},"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — the requested companies could not be read, retry the request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/granted_company_list","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/replacegrantedcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/granted_companies"},{"label":"Remove a granted company from a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/contacts/removegrantedcompanyfromacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/removegrantedcompanyfromacontact","metadata":{"seo":{"title":"Remove a granted company from a contact","description":"Remove a single company from a contact's granted set, leaving the contact's other grants in place."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeGrantedCompanyFromAContact","name":"Remove a granted company from a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a granted company from a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a single company from a contact's granted set, leaving the contact's other grants in place."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify the company by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you set on it, the same value "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/contacts/listgrantedcompaniesforacontact"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /contacts/{contact_id}/granted_companies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" containing a dot or a slash is supported — URL-encode a slash as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%2F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not idempotent. Removing a company the contact is not currently granted returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so repeating a successful call returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Treat the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Requires granted companies to be enabled"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"granted_companies_not_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless granted companies are enabled for the workspace. Contact Intercom Support to enable it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"company_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you set on the company, as returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"acme-corp"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/granted_companies/{company_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"},{"name":"company_id","in":"path","required":true,"example":"acme-corp","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/contacts/{contact_id}/granted_companies/{company_id}","href":"contacts/removegrantedcompanyfromacontact","openApiOperationId":"removeGrantedCompanyFromAContact","summary":"Remove a granted company from a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The grant was removed. No content is returned."},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}],"pointer":"/paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found","paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/removegrantedcompanyfromacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/granted_companies/{company_id}"},{"type":"link","label":"Contact","link":"/docs/references/rest-api/api.intercom.io/contacts/contact","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/contact","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact"},"seo":{"title":"Contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact"},"children":[]}]}]}},{"type":"link","label":"Contacts Bulk Job","link":"/docs/references/rest-api/api.intercom.io/contacts/contacts_bulk_job","routeSlug":"/docs/references/rest-api/api.intercom.io/contacts/contacts_bulk_job","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contacts_bulk_job"},"seo":{"title":"Contacts Bulk Job"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts Bulk Job","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contacts_bulk_job"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your contacts"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Contact","link":"/contacts/contact","deprecated":false},{"title":"Contacts Bulk Job","link":"/contacts/contacts_bulk_job","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{company_id}/contacts","summary":"List attached contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listattachedcontacts","deprecated":false},{"title":"/contacts/{contact_id}/companies","summary":"Attach a Contact to a Company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/attachcontacttoacompany","deprecated":false},{"title":"/contacts/{contact_id}/companies","summary":"List attached companies for contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/companies/{company_id}","summary":"Detach a contact from a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/detachcontactfromacompany","deprecated":false},{"title":"/contacts/{contact_id}/notes","summary":"List all notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listnotes","deprecated":false},{"title":"/contacts/{contact_id}/notes","summary":"Create a note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/createnote","deprecated":false},{"title":"/contacts/{contact_id}/segments","summary":"List attached segments for contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listsegmentsforacontact","deprecated":false},{"title":"/contacts/{contact_id}/subscriptions","summary":"List subscriptions for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listsubscriptionsforacontact","deprecated":false},{"title":"/contacts/{contact_id}/subscriptions","summary":"Add subscription to a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/attachsubscriptiontypetocontact","deprecated":false},{"title":"/contacts/{contact_id}/subscriptions/{subscription_id}","summary":"Remove subscription from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/detachsubscriptiontypetocontact","deprecated":false},{"title":"/contacts/{contact_id}/tags","summary":"List tags attached to a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listtagsforacontact","deprecated":false},{"title":"/contacts/{contact_id}/tags","summary":"Add tag to a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/attachtagtocontact","deprecated":false},{"title":"/contacts/{contact_id}/tags/{tag_id}","summary":"Remove tag from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/detachtagfromcontact","deprecated":false},{"title":"/contacts/deleted","summary":"List deleted contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listdeletedcontacts","deprecated":false},{"title":"/contacts/{contact_id}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/updatecontact","deprecated":false},{"title":"/contacts/{contact_id}","summary":"Get a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/showcontact","deprecated":false},{"title":"/contacts/{contact_id}","summary":"Delete a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/deletecontact","deprecated":false},{"title":"/contacts/merge","summary":"Merge a lead and a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/mergecontact","deprecated":false},{"title":"/contacts/merge/preview","summary":"Preview a contact merge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/previewmergecontact","deprecated":false},{"title":"/contacts/search","summary":"Search contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/searchcontacts","deprecated":false},{"title":"/contacts/activities","summary":"List all contact activities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactactivities","deprecated":false},{"title":"/contacts","summary":"List all contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontacts","deprecated":false},{"title":"/contacts","summary":"Create contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/createcontact","deprecated":false},{"title":"/contacts/find_by_external_id/{external_id}","summary":"Get a contact by External ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/showcontactbyexternalid","deprecated":false},{"title":"/contacts/{contact_id}/archive","summary":"Archive contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/archivecontact","deprecated":false},{"title":"/contacts/{contact_id}/unarchive","summary":"Unarchive contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/unarchivecontact","deprecated":false},{"title":"/contacts/{id}/banners","summary":"List banners for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactbanners","deprecated":false},{"title":"/contacts/{id}/banners/{view_id}/dismiss","summary":"Dismiss a banner for a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/dismisscontactbanner","deprecated":false},{"title":"/contacts/{contact_id}/block","summary":"Block contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/blockcontact","deprecated":false},{"title":"/contacts/{id}/merge_histories","summary":"Get contact merge history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactmergehistory","deprecated":false},{"title":"/contacts/bulk","summary":"Bulk create contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/bulkcreatecontacts","deprecated":false},{"title":"/contacts/bulk","summary":"Bulk update contacts","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/bulkupdatecontacts","deprecated":false},{"title":"/contacts/bulk/delete","summary":"Bulk delete contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/bulkdeletecontacts","deprecated":false},{"title":"/contacts/bulk/{id}","summary":"Get a bulk update job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/showbulkupdatecontactsjob","deprecated":false},{"title":"/contacts/{contact_id}/granted_companies","summary":"List granted companies for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listgrantedcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/granted_companies","summary":"Replace granted companies for a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/replacegrantedcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/granted_companies/{company_id}","summary":"Remove a granted company from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/removegrantedcompanyfromacontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Content","link":"/docs/references/rest-api/api.intercom.io/content","routeSlug":"/docs/references/rest-api/api.intercom.io/content","items":[{"label":"Run a bulk action on Knowledge Hub content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content/bulkcontentactions","routeSlug":"/docs/references/rest-api/api.intercom.io/content/bulkcontentactions","metadata":{"seo":{"title":"Run a bulk action on Knowledge Hub content","description":"Asynchronously run a bulk action over up to 1,000 Knowledge Hub content items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkContentActions","name":"Run a bulk action on Knowledge Hub content","isWebhook":false,"pointer":"/paths/~1content~1bulk_actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a bulk action on Knowledge Hub content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronously run a bulk action over up to 1,000 Knowledge Hub content items."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Six actions are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publish"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpublish"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — permanently delete content (excludes synced sources and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — toggle Fin AI Agent, Copilot, and Sales Agent availability flags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_audience"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — manage segment membership on content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — apply and/or remove existing tags on content. Unlike the other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actions, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" addresses articles by the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" id, not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Tags must already exist and not be archived; supply at least one of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint validates the request, enqueues background work, and returns 202 with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"placeholder envelope. Items whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not in the action's allowlist are silently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dropped before processing. Articles imported from synced sources (Confluence, Notion,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zendesk, Salesforce Knowledge, etc.) are silently skipped on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — they can only be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removed by disconnecting the underlying import source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content~1bulk_actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/content_bulk_action_request","exampleIds":["paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags"]}},"schemaId":"components/schemas/content_bulk_action_request","exampleIds":["paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags"],"pointer":"/paths/~1content~1bulk_actions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/content/bulk_actions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/content_bulk_action_request","exampleIds":["paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags"]}},"responseCodes":["202","401","422"],"pointer":"/content/bulk_actions","href":"content/bulkcontentactions","openApiOperationId":"bulkContentActions","summary":"Run a bulk action on Knowledge Hub content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/content_bulk_action_request","exampleIds":["paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/content_bulk_action_request","exampleIds":["paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience","paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted — work has been enqueued"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_bulk_action_response","exampleIds":["paths/~1content~1bulk_actions/post/responses/202/content/application~1json/examples/Queued"]}},"schemaId":"components/schemas/content_bulk_action_response","exampleIds":["paths/~1content~1bulk_actions/post/responses/202/content/application~1json/examples/Queued"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. The token is invalid or is missing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid action, content_ids, or action-specific parameters"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1content~1bulk_actions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/content_bulk_action_response","exampleIds":["paths/~1content~1bulk_actions/post/responses/202/content/application~1json/examples/Queued"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_bulk_action_response","exampleIds":["paths/~1content~1bulk_actions/post/responses/202/content/application~1json/examples/Queued"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content/bulkcontentactions"}],"panels":[]}]},"httpPath":"/content/bulk_actions"},{"label":"Search knowledge base contents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content/searchcontent","routeSlug":"/docs/references/rest-api/api.intercom.io/content/searchcontent","metadata":{"seo":{"title":"Search knowledge base contents","description":"Search the knowledge base contents — articles, snippets, external pages, uploaded files, and internal articles — using a keyword query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchContent","name":"Search knowledge base contents","isWebhook":false,"pointer":"/paths/~1content~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search knowledge base contents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the knowledge base contents — articles, snippets, external pages, uploaded files, and internal articles — using a keyword query."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each result row has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator. Most types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_snippet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_source_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_article"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") return a flat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ type, id, title }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shape. Help center articles return a nested shape with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contents[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, one entry per locale."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"query","in":"query","schemaId":"schema_1164","description":"A free-text search term matched against the title and body of each content item. When omitted, returns the most recent content items. Keep it to 500 characters or fewer. The API doesn't currently reject longer values.","example":"billing"},{"name":"page","in":"query","schemaId":"schema_1159","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number to fetch. Defaults to 1. Values below 1 are clamped to 1. Values above 5001 return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1197","description":"Number of results per page. Defaults to 10. Maximum 50.","example":10},{"name":"states","in":"query","schemaId":"schema_1198","description":"Filter by publication state. Accepts a comma-separated list or repeated params.","example":"published,draft"},{"name":"locales","in":"query","schemaId":"schema_1199","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by locale codes (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Accepts a comma-separated list or repeated params."},"children":[]}]}]}],"example":"en,fr"},{"name":"tag_ids","in":"query","schemaId":"schema_1200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by tag IDs. Pairs with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control match semantics. Accepts a comma-separated list or repeated params."},"children":[]}]}]}],"example":"1,2,3"},{"name":"tag_operator","in":"query","schemaId":"schema_1201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match operator paired with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns content matching any of the given tags; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" excludes content matching any of them."},"children":[]}]}]}],"example":"IN"},{"name":"any_tag_ids","in":"query","schemaId":"schema_1200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by tag IDs using OR semantics — returns content matching any of the given tags. Alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Accepts a comma-separated list or repeated params."},"children":[]}]}]}],"example":"1,2,3"},{"name":"folder_ids","in":"query","schemaId":"schema_1200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by folder IDs. Must be sent together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folder_entity_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Accepts a comma-separated list or repeated params."},"children":[]}]}]}],"example":"10,20"},{"name":"folder_entity_type","in":"query","schemaId":"schema_1202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folder_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. Identifies the entity type the folder IDs refer to."},"children":[]}]}]}],"example":"folder"},{"name":"content_types","in":"query","schemaId":"schema_1203","description":"Restrict the search to specific content types. When provided, this REPLACES the default content type set rather than filtering on top of it. Accepts a comma-separated list or repeated params.","example":"article,snippet"},{"name":"copilot_state","in":"query","schemaId":"schema_1204","description":"Filter by whether the content is enabled for Copilot.","example":"on"},{"name":"fin_service_state","in":"query","schemaId":"schema_1204","description":"Filter by whether the content is enabled for Fin AI Agent (customer-facing service).","example":"on"},{"name":"fin_sales_state","in":"query","schemaId":"schema_1204","description":"Filter by whether the content is enabled for Fin Sales Agent.","example":"on"},{"name":"created_by_ids","in":"query","schemaId":"schema_1200","description":"Filter by the admin IDs that created the content. Accepts a comma-separated list or repeated params.","example":"991267464,991267465"},{"name":"last_updated_by_ids","in":"query","schemaId":"schema_1200","description":"Filter by the admin IDs that last updated the content. Accepts a comma-separated list or repeated params.","example":"991267464,991267465"},{"name":"created_at_after","in":"query","schemaId":"schema_1150","description":"Return content created at or after this time. Unix epoch seconds.","example":1677253093},{"name":"created_at_before","in":"query","schemaId":"schema_1150","description":"Return content created at or before this time. Unix epoch seconds.","example":1677861493},{"name":"updated_at_after","in":"query","schemaId":"schema_1150","description":"Return content last updated at or after this time. Unix epoch seconds.","example":1677253093},{"name":"updated_at_before","in":"query","schemaId":"schema_1150","description":"Return content last updated at or before this time. Unix epoch seconds.","example":1677861493}],"pointer":"/paths/~1content~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/content/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"query","in":"query","required":false,"example":"billing","schemaId":"schema_1164"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1159"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_1197"},{"name":"states","in":"query","required":false,"example":"published,draft","schemaId":"schema_1198","style":"form","explode":false},{"name":"locales","in":"query","required":false,"example":"en,fr","schemaId":"schema_1199","style":"form","explode":false},{"name":"tag_ids","in":"query","required":false,"example":"1,2,3","schemaId":"schema_1200","style":"form","explode":false},{"name":"tag_operator","in":"query","required":false,"example":"IN","schemaId":"schema_1201"},{"name":"any_tag_ids","in":"query","required":false,"example":"1,2,3","schemaId":"schema_1200","style":"form","explode":false},{"name":"folder_ids","in":"query","required":false,"example":"10,20","schemaId":"schema_1200","style":"form","explode":false},{"name":"folder_entity_type","in":"query","required":false,"example":"folder","schemaId":"schema_1202"},{"name":"content_types","in":"query","required":false,"example":"article,snippet","schemaId":"schema_1203","style":"form","explode":false},{"name":"copilot_state","in":"query","required":false,"example":"on","schemaId":"schema_1204"},{"name":"fin_service_state","in":"query","required":false,"example":"on","schemaId":"schema_1204"},{"name":"fin_sales_state","in":"query","required":false,"example":"on","schemaId":"schema_1204"},{"name":"created_by_ids","in":"query","required":false,"example":"991267464,991267465","schemaId":"schema_1200","style":"form","explode":false},{"name":"last_updated_by_ids","in":"query","required":false,"example":"991267464,991267465","schemaId":"schema_1200","style":"form","explode":false},{"name":"created_at_after","in":"query","required":false,"example":1677253093,"schemaId":"schema_1150"},{"name":"created_at_before","in":"query","required":false,"example":1677861493,"schemaId":"schema_1150"},{"name":"updated_at_after","in":"query","required":false,"example":1677253093,"schemaId":"schema_1150"},{"name":"updated_at_before","in":"query","required":false,"example":1677861493,"schemaId":"schema_1150"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","422"],"pointer":"/content/search","href":"content/searchcontent","openApiOperationId":"searchContent","summary":"Search knowledge base contents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_search_response","exampleIds":["paths/~1content~1search/get/responses/200/content/application~1json/examples/Search successful"]}},"schemaId":"components/schemas/content_search_response","exampleIds":["paths/~1content~1search/get/responses/200/content/application~1json/examples/Search successful"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number too high. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" multiplied by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not exceed 10,000, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not exceed 5001. Going over the 10,000 window returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bad_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. The token is invalid or is missing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1search/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1search/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Invalid filter value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/Invalid states value","paths/~1content~1search/get/responses/422/content/application~1json/examples/Incomplete folder filter"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/Invalid states value","paths/~1content~1search/get/responses/422/content/application~1json/examples/Incomplete folder filter"]}],"pointer":"/paths/~1content~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_search_response","exampleIds":["paths/~1content~1search/get/responses/200/content/application~1json/examples/Search successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_search_response","exampleIds":["paths/~1content~1search/get/responses/200/content/application~1json/examples/Search successful"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1search/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content~1search/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/Invalid states value","paths/~1content~1search/get/responses/422/content/application~1json/examples/Incomplete folder filter"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/Invalid states value","paths/~1content~1search/get/responses/422/content/application~1json/examples/Incomplete folder filter"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content/searchcontent"}],"panels":[]}]},"httpPath":"/content/search"}],"content":{"contentType":"group","meta":{"name":"Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and operations over Knowledge Hub content — articles, snippets, external pages, uploaded files, and internal articles."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/content/bulk_actions","summary":"Run a bulk action on Knowledge Hub content","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content/bulkcontentactions","deprecated":false},{"title":"/content/search","summary":"Search knowledge base contents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content/searchcontent","deprecated":false}]}]}]}]}},{"type":"group","label":"Content Snippets","link":"/docs/references/rest-api/api.intercom.io/content-snippets","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets","items":[{"label":"List all content snippets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/listcontentsnippets","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/listcontentsnippets","metadata":{"seo":{"title":"List all content snippets","description":"You can fetch a list of all content snippets for a workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContentSnippets","name":"List all content snippets","isWebhook":false,"pointer":"/paths/~1content_snippets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all content snippets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all content snippets for a workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1205","description":"The page of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_1206","description":"The number of results to return per page. Max value of 50."}],"pointer":"/paths/~1content_snippets/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/content_snippets","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1205"},{"name":"per_page","in":"query","required":false,"example":20,"schemaId":"schema_1206"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/content_snippets","href":"content-snippets/listcontentsnippets","openApiOperationId":"listContentSnippets","summary":"List all content snippets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet_list","exampleIds":["paths/~1content_snippets/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/content_snippet_list","exampleIds":["paths/~1content_snippets/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1content_snippets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_snippet_list","exampleIds":["paths/~1content_snippets/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet_list","exampleIds":["paths/~1content_snippets/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/listcontentsnippets"}],"panels":[]}]},"httpPath":"/content_snippets"},{"label":"Create a content snippet","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/createcontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/createcontentsnippet","metadata":{"seo":{"title":"Create a content snippet","description":"You can create a new content snippet."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContentSnippet","name":"Create a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new content snippet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is listed as required, but a missing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted and the snippet is created with a blank title. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted or blank, the snippet is created with a single empty paragraph."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/content_snippet_create_request","exampleIds":["paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet"]}},"schemaId":"components/schemas/content_snippet_create_request","exampleIds":["paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet"],"pointer":"/paths/~1content_snippets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/content_snippets","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/content_snippet_create_request","exampleIds":["paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet"]}},"responseCodes":["201","400","401","404","422"],"pointer":"/content_snippets","href":"content-snippets/createcontentsnippet","openApiOperationId":"createContentSnippet","summary":"Create a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/content_snippet_create_request","exampleIds":["paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/content_snippet_create_request","exampleIds":["paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Content snippet created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets/post/responses/201/content/application~1json/examples/Content snippet created"]}},"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets/post/responses/201/content/application~1json/examples/Content snippet created"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid availability flag or audience_ids"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets/post/responses/400/content/application~1json/examples/Malformed audience_ids"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets/post/responses/400/content/application~1json/examples/Malformed audience_ids"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Unknown audience IDs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/404/content/application~1json/examples/Unknown audience IDs"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error, or body_markdown sent with json_blocks"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided"]}],"pointer":"/paths/~1content_snippets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets/post/responses/201/content/application~1json/examples/Content snippet created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets/post/responses/201/content/application~1json/examples/Content snippet created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets/post/responses/400/content/application~1json/examples/Malformed audience_ids"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets/post/responses/400/content/application~1json/examples/Malformed audience_ids"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/404/content/application~1json/examples/Unknown audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/createcontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets"},{"label":"Retrieve a content snippet","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/getcontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/getcontentsnippet","metadata":{"seo":{"title":"Retrieve a content snippet","description":"You can fetch a single content snippet by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContentSnippet","name":"Retrieve a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a single content snippet by its id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1207","description":"The unique identifier for the content snippet.","required":true}],"pointer":"/paths/~1content_snippets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/content_snippets/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1207"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/content_snippets/{id}","href":"content-snippets/getcontentsnippet","openApiOperationId":"getContentSnippet","summary":"Retrieve a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content snippet not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/404/content/application~1json/examples/Content snippet not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/404/content/application~1json/examples/Content snippet not found"]}],"pointer":"/paths/~1content_snippets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/404/content/application~1json/examples/Content snippet not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/get/responses/404/content/application~1json/examples/Content snippet not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/getcontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{id}"},{"label":"Update a content snippet","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/updatecontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/updatecontentsnippet","metadata":{"seo":{"title":"Update a content snippet","description":"You can update an existing content snippet."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContentSnippet","name":"Update a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing content snippet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1207","description":"The unique identifier for the content snippet.","required":true}],"pointer":"/paths/~1content_snippets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/content_snippet_update_request","exampleIds":["paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet"]}},"schemaId":"components/schemas/content_snippet_update_request","exampleIds":["paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet"],"pointer":"/paths/~1content_snippets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/content_snippets/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1207"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/content_snippet_update_request","exampleIds":["paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/content_snippets/{id}","href":"content-snippets/updatecontentsnippet","openApiOperationId":"updateContentSnippet","summary":"Update a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/content_snippet_update_request","exampleIds":["paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/content_snippet_update_request","exampleIds":["paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content snippet updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/put/responses/200/content/application~1json/examples/Content snippet updated"]}},"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/put/responses/200/content/application~1json/examples/Content snippet updated"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid availability flag or audience_ids"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Malformed audience_ids"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Malformed audience_ids"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content snippet or audience ID not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error, body_markdown sent with json_blocks, or the snippet is in a release running a live experiment"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"]}],"pointer":"/paths/~1content_snippets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/put/responses/200/content/application~1json/examples/Content snippet updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/content_snippet","exampleIds":["paths/~1content_snippets~1{id}/put/responses/200/content/application~1json/examples/Content snippet updated"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Malformed audience_ids"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Invalid availability flag","paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Malformed audience_ids"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/updatecontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{id}"},{"label":"Delete a content snippet","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/deletecontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/deletecontentsnippet","metadata":{"seo":{"title":"Delete a content snippet","description":"You can delete a single content snippet by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContentSnippet","name":"Delete a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single content snippet by its id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1207","description":"The unique identifier for the content snippet.","required":true}],"pointer":"/paths/~1content_snippets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/content_snippets/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1207"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404","422"],"pointer":"/content_snippets/{id}","href":"content-snippets/deletecontentsnippet","openApiOperationId":"deleteContentSnippet","summary":"Delete a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Content snippet deleted"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Content snippet not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found"]},{"code":"422","description":"Content snippet has procedure dependencies, or is in a release running a live experiment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies","paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies","paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"]}],"pointer":"/paths/~1content_snippets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies","paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies","paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/deletecontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{id}"},{"label":"Add a tag to a content snippet","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/attachtagtocontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/attachtagtocontentsnippet","metadata":{"seo":{"title":"Add a tag to a content snippet","description":"Apply an existing tag to a content snippet. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToContentSnippet","name":"Add a tag to a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to a content snippet. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_snippet_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content snippet.","required":true,"example":"123"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/content_snippets/{content_snippet_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"content_snippet_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/content_snippets/{content_snippet_id}/tags","href":"content-snippets/attachtagtocontentsnippet","openApiOperationId":"attachTagToContentSnippet","summary":"Add a tag to a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Content snippet, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/attachtagtocontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{content_snippet_id}/tags"},{"label":"Remove a tag from a content snippet","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/content-snippets/detachtagfromcontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/detachtagfromcontentsnippet","metadata":{"seo":{"title":"Remove a tag from a content snippet","description":"Remove a tag from a content snippet. Returns the tag that was removed, withnull applied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromContentSnippet","name":"Remove a tag from a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from a content snippet. Returns the tag that was removed, with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_snippet_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content snippet.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"admin_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional id of a teammate. The id is checked, and an unknown teammate returns a 404 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error, but the removal is not recorded against the teammate."},"children":[]}]}]}],"example":"1234"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/content_snippets/{content_snippet_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"content_snippet_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[{"name":"admin_id","in":"query","required":false,"example":"1234","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/content_snippets/{content_snippet_id}/tags/{id}","href":"content-snippets/detachtagfromcontentsnippet","openApiOperationId":"detachTagFromContentSnippet","summary":"Remove a tag from a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Content snippet, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-snippets/detachtagfromcontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{content_snippet_id}/tags/{id}"},{"type":"link","label":"Content Snippet","link":"/docs/references/rest-api/api.intercom.io/content-snippets/content_snippet","routeSlug":"/docs/references/rest-api/api.intercom.io/content-snippets/content_snippet","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_snippet"},"seo":{"title":"Content Snippet"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Snippet","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_snippet"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Content Snippets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Snippets","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Content Snippets"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Content Snippet","link":"/content-snippets/content_snippet","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/content_snippets","summary":"List all content snippets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-snippets/listcontentsnippets","deprecated":false},{"title":"/content_snippets","summary":"Create a content snippet","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-snippets/createcontentsnippet","deprecated":false},{"title":"/content_snippets/{id}","summary":"Retrieve a content snippet","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-snippets/getcontentsnippet","deprecated":false},{"title":"/content_snippets/{id}","summary":"Update a content snippet","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-snippets/updatecontentsnippet","deprecated":false},{"title":"/content_snippets/{id}","summary":"Delete a content snippet","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/content-snippets/deletecontentsnippet","deprecated":false},{"title":"/content_snippets/{content_snippet_id}/tags","summary":"Add a tag to a content snippet","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-snippets/attachtagtocontentsnippet","deprecated":false},{"title":"/content_snippets/{content_snippet_id}/tags/{id}","summary":"Remove a tag from a content snippet","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/content-snippets/detachtagfromcontentsnippet","deprecated":false}]}]}]}]}},{"type":"group","label":"Conversations","link":"/docs/references/rest-api/api.intercom.io/conversations","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations","items":[{"label":"Add tag to a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/attachtagtoconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/attachtagtoconversation","metadata":{"seo":{"title":"Add tag to a conversation","description":"You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToConversation","name":"Add tag to a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag to a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"]}},"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/{conversation_id}/tags","href":"conversations/attachtagtoconversation","openApiOperationId":"attachTagToConversation","summary":"Add tag to a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/attachtagtoconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/tags"},{"label":"Remove tag from a conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/detachtagfromconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/detachtagfromconversation","metadata":{"seo":{"title":"Remove tag from a conversation","description":"You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromConversation","name":"Remove tag from a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"},{"name":"tag_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag_id"},"children":[]}]}]}],"required":true,"example":"7522907"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/{conversation_id}/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/{conversation_id}/tags/{tag_id}","href":"conversations/detachtagfromconversation","openApiOperationId":"detachTagFromConversation","summary":"Remove tag from a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/detachtagfromconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/tags/{tag_id}"},{"label":"List all conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/listconversations","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/listconversations","metadata":{"seo":{"title":"List all conversations","description":"You can fetch a list of all conversations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConversations","name":"List all conversations","isWebhook":false,"pointer":"/paths/~1conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all conversations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can optionally request the result page size and the cursor to start after to fetch the result."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Pagination"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1210","description":"How many results per page"},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":"String used to get the next page of conversations."},{"name":"include_monitors","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitor_evaluations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on each conversation with the latest QA monitor evaluation for each monitor that has evaluated it."},"children":[]}]}]}],"example":true},{"name":"include_scorecards","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scorecards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on each conversation with any QA scorecard results."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1conversations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1210"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"},{"name":"include_monitors","in":"query","required":false,"example":true,"schemaId":"schema_1191"},{"name":"include_scorecards","in":"query","required":false,"example":true,"schemaId":"schema_1191"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/conversations","href":"conversations/listconversations","openApiOperationId":"listConversations","summary":"List all conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid starting_after"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid starting_after"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/403/content/application~1json/examples/API plan restricted"]}],"pointer":"/paths/~1conversations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid starting_after"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid starting_after"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/get/responses/403/content/application~1json/examples/API plan restricted"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listconversations"}],"panels":[]}]},"httpPath":"/conversations"},{"label":"Creates a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/createconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/createconversation","metadata":{"seo":{"title":"Creates a conversation","description":"You can create a conversation that has been initiated by a contact (ie. user or lead).The conversation can be an in-app message only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConversation","name":"Creates a conversation","isWebhook":false,"pointer":"/paths/~1conversations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a conversation that has been initiated by a contact (ie. user or lead)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversation can be an in-app message only."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Sending for visitors"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send a message from a visitor by specifying their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, along with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This visitor will be automatically converted to a contact with a lead role once the conversation is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return the Message model that has been created."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_request","exampleIds":["paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created","paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found"]}},"schemaId":"components/schemas/create_conversation_request","exampleIds":["paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created","paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found"],"pointer":"/paths/~1conversations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_conversation_request","exampleIds":["paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created","paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/conversations","href":"conversations/createconversation","openApiOperationId":"createConversation","summary":"Creates a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_conversation_request","exampleIds":["paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created","paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_request","exampleIds":["paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created","paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"conversation created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1211","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]}},"schemaId":"schema_1211","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/400/content/application~1json/examples/Sender missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/400/content/application~1json/examples/Sender missing"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Contact Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/404/content/application~1json/examples/Contact Not Found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/422/content/application~1json/examples/Message too long"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/422/content/application~1json/examples/Message too long"]}],"pointer":"/paths/~1conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1211","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1211","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/400/content/application~1json/examples/Sender missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/400/content/application~1json/examples/Sender missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/404/content/application~1json/examples/Contact Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/404/content/application~1json/examples/Contact Not Found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/422/content/application~1json/examples/Message too long"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations/post/responses/422/content/application~1json/examples/Message too long"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/createconversation"}],"panels":[]}]},"httpPath":"/conversations"},{"label":"Retrieve a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/retrieveconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/retrieveconversation","metadata":{"seo":{"title":"Retrieve a conversation","description":"You can fetch the details of a single conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveConversation","name":"Retrieve a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a single Conversation model with all its conversation parts."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Hard limit of 500 parts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid feature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1150","description":"The id of the conversation to target","required":true,"example":123}],"pointer":"/paths/~1conversations~1{conversation_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"display_as","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label (url)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", preserving the link URL alongside the visible text. Line breaks inside a paragraph are rendered as newlines."},"children":[]}]}]}],"example":"plaintext"},{"name":"include_translations","in":"query","schemaId":"schema_1156","description":"If set to true, conversation parts will be translated to the detected language of the conversation.","example":true},{"name":"include_email_history","in":"query","schemaId":"schema_1156","description":"If set to true, the source of the conversation will include the email history, for conversations started by email.","example":true},{"name":"parts_created_after","in":"query","schemaId":"schema_1150","description":"Only include conversation parts created at or after this time, as a Unix timestamp in seconds.","example":1700000000},{"name":"parts_created_before","in":"query","schemaId":"schema_1150","description":"Only include conversation parts created at or before this time, as a Unix timestamp in seconds.","example":1700086400},{"name":"include_monitors","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitor_evaluations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array with the latest QA monitor evaluation for each monitor that has evaluated this conversation."},"children":[]}]}]}],"example":true},{"name":"include_scorecards","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scorecards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array with any QA scorecard results for this conversation."},"children":[]}]}]}],"example":true},{"name":"include_part_types","in":"query","schemaId":"schema_1212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma-separated list of conversation part types to return, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_part_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"comment,note"},{"name":"exclude_part_types","in":"query","schemaId":"schema_1212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma-separated list of conversation part types to leave out, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_part_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"assignment"},{"name":"page","in":"query","schemaId":"schema_1213","description":"The page of conversation parts to return. When sent, parts are paginated oldest first, so page 1 holds the oldest parts. A page past the end returns an empty list.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1214","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of conversation parts per page, between 1 and 500. Only used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent."},"children":[]}]}]}],"example":50}],"pointer":"/paths/~1conversations~1{conversation_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/{conversation_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_1152"},{"name":"include_translations","in":"query","required":false,"example":true,"schemaId":"schema_1156"},{"name":"include_email_history","in":"query","required":false,"example":true,"schemaId":"schema_1156"},{"name":"parts_created_after","in":"query","required":false,"example":1700000000,"schemaId":"schema_1150"},{"name":"parts_created_before","in":"query","required":false,"example":1700086400,"schemaId":"schema_1150"},{"name":"include_monitors","in":"query","required":false,"example":true,"schemaId":"schema_1191"},{"name":"include_scorecards","in":"query","required":false,"example":true,"schemaId":"schema_1191"},{"name":"include_part_types","in":"query","required":false,"example":"comment,note","schemaId":"schema_1212","style":"form","explode":false},{"name":"exclude_part_types","in":"query","required":false,"example":"assignment","schemaId":"schema_1212","style":"form","explode":false},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1213"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1214"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/conversations/{conversation_id}","href":"conversations/retrieveconversation","openApiOperationId":"retrieveConversation","summary":"Retrieve a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"conversation found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/200/content/application~1json/examples/conversation found"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/200/content/application~1json/examples/conversation found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/200/content/application~1json/examples/conversation found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/200/content/application~1json/examples/conversation found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/get/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/retrieveconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}"},{"label":"Update a conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/updateconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/updateconversation","metadata":{"seo":{"title":"Update a conversation","description":"You can update an existing conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConversation","name":"Update a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Replying and other actions"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint handles both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom object associations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update a conversation with an association to a custom object instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request/response examples to see the custom object association format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"danger","name":"Breaking change: duplicate custom attribute names"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /conversations/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint now returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 INVALID_PARAMETER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and your workspace contains multiple non-archived conversation custom attributes with the same name. Previously, the update would silently apply to a non-deterministic attribute. To resolve, rename or archive the duplicate attribute in your workspace settings, then retry the request."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1150","description":"The id of the conversation to target","required":true,"example":123}],"pointer":"/paths/~1conversations~1{conversation_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"display_as","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label (url)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", preserving the link URL alongside the visible text. Line breaks inside a paragraph are rendered as newlines."},"children":[]}]}]}],"example":"plaintext"}],"pointer":"/paths/~1conversations~1{conversation_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{conversation_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/conversations/{conversation_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/conversations/{conversation_id}","href":"conversations/updateconversation","openApiOperationId":"updateConversation","summary":"Update a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"update a conversation with an association to a custom object instance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/updateconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}"},{"label":"Delete a conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/deleteconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/deleteconversation","metadata":{"seo":{"title":"Delete a conversation","description":"Deleting a conversation is permanent and cannot be reversed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConversation","name":"Delete a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Irreversible operation"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a conversation is permanent and cannot be reversed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single conversation. The behavior depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain_metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain_metrics=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deletes the conversation while retaining reporting data. The conversation will still appear in reporting, though some data may be incomplete due to the deletion."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain_metrics=false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deletes the conversation and all associated reporting data. The conversation will be completely removed from both the inbox and all reporting."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Required scope for retain_metrics=false"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain_metrics=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete_conversations_and_metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more info, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.intercom.com/help/en/articles/13885146-deleting-a-conversation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this help center article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1150","description":"id","required":true}],"pointer":"/paths/~1conversations~1{conversation_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"retain_metrics","in":"query","schemaId":"schema_1156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true (default), deletes the conversation while retaining reporting data. If false, deletes the conversation and all associated reporting data. Setting to false requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete_conversations_and_metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1conversations~1{conversation_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/{conversation_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"schemaId":"schema_1150"}],"query":[{"name":"retain_metrics","in":"query","required":false,"example":true,"schemaId":"schema_1156"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/conversations/{conversation_id}","href":"conversations/deleteconversation","openApiOperationId":"deleteConversation","summary":"Delete a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_deleted","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/conversation_deleted","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Side conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/400/content/application~1json/examples/Side conversation"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/400/content/application~1json/examples/Side conversation"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}],"pointer":"/paths/~1conversations~1{conversation_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_deleted","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_deleted","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/400/content/application~1json/examples/Side conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/400/content/application~1json/examples/Side conversation"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/deleteconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}"},{"label":"Search conversations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/searchconversations","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/searchconversations","metadata":{"seo":{"title":"Search conversations","description":"You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchConversations","name":"Search conversations","isWebhook":false,"pointer":"/paths/~1conversations~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To search for conversations, you need to send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/conversations/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will accept a query object in the body which will define your filters in order to search for conversations."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Optimizing search queries"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search queries can be complex, so optimizing them can help the performance of your search."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators to combine multiple filters to get the exact results you need and utilize"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page and maximum is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"conversations/searchconversations/request/nesting-and-limitations","deepLinkHash":"/conversations/searchconversations#conversations/searchconversations/request/nesting-and-limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nesting & Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are some limitations to the amount of multiple's there can be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 2 nested filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 15 filters for each AND or OR group"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"conversations/searchconversations/request/accepted-fields","deepLinkHash":"/conversations/searchconversations#conversations/searchconversations/request/accepted-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a date, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be a string such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"foorbar\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"I need support\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body - the query should contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"support\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for such conversation to be returned. A query with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"need support\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value will not yield a result."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted fields are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instagram"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_call"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_switch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"push"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twitter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.delivered_as"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.subject"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.body"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.author.id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.author.type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.author.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.author.email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source.url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teammate_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin_assignee_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team_assignee_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel_initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"open"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting_since"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snoozed_until"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.time_to_assignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.time_to_admin_reply"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.time_to_first_close"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.time_to_last_close"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.median_time_to_reply"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.first_contact_reply_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.first_assignment_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.first_admin_reply_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.first_close_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.last_assignment_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.last_assignment_admin_reply_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.last_contact_reply_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.last_admin_reply_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.last_close_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.last_closed_by_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.count_reopens"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.count_assignments"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"statistics.count_conversation_parts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_rating.requested_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_rating.replied_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_rating.score"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_rating.remark"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_rating.contact_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_rating.admin_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent_participated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent.resolution_state"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent.last_answer_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent.rating"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent.rating_remark"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent.source_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent.source_title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"conversations/searchconversations/request/accepted-operators","deepLinkHash":"/conversations/searchconversations#conversations/searchconversations/request/accepted-operators"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Operators"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The table below shows the operators you can use to define how you want to search for the value.  The operator should be put in as a string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"=\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The operator has to be compatible with the field's type  (eg. you cannot search with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a given string value as it's only compatible for integer's and dates)."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In  Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries  Values most be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not In  Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR !"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries  Values must be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer  Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer  Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than or equal to"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer  Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower than"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer  Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower than or equal to"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Contain"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"^"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts With"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ends With"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"conversations/searchconversations/request/sorting","deepLinkHash":"/conversations/searchconversations#conversations/searchconversations/request/sorting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", newest first. To sort differently, add a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object to the request body with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ascending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required whenever "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent, and must be one of the fields in the table above, other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.author.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.author.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.author.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.author.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_rating.remark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai_agent.rating_remark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai_agent.source_title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which can't be sorted. A missing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or one that isn't searchable, returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_monitors","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitor_evaluations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on each conversation with the latest QA monitor evaluation for each monitor that has evaluated it."},"children":[]}]}]}],"example":true},{"name":"include_scorecards","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scorecards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on each conversation with any QA scorecard results."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1conversations~1search/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/search_request","exampleIds":["paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/search_request","exampleIds":["paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1conversations~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"include_monitors","in":"query","required":false,"example":true,"schemaId":"schema_1191"},{"name":"include_scorecards","in":"query","required":false,"example":true,"schemaId":"schema_1191"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/search_request","exampleIds":["paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401"],"pointer":"/conversations/search","href":"conversations/searchconversations","openApiOperationId":"searchConversations","summary":"Search conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/search_request","exampleIds":["paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/search_request","exampleIds":["paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid starting_after"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid starting_after"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1conversations~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_list","exampleIds":["paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid starting_after"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid per_page","paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid starting_after"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/searchconversations"}],"panels":[]}]},"httpPath":"/conversations/search"},{"label":"Reply to a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/replyconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/replyconversation","metadata":{"seo":{"title":"Reply to a conversation","description":"You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replyConversation","name":"Reply to a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1reply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reply to a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Bot replies to inbound email"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, bot or Operator replies to an inbound email conversation aren't sent to your customer. The reply is stored as an unnotifiable bot comment, and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receipt is generated until an email is actually delivered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To send these replies as outbound emails, reach out to your accounts team to enable the email-reply feature flag for your workspace."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Managing a conversation"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To close, open, snooze or assign a conversation, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/conversations/manageconversation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage a conversation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Intercom provisioned identifier for the conversation, or the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the most recent conversation of a contact. With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", also send the contact's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body, whatever type of request you send. A contact that can't be found returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error, and a contact with no conversations returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"required":true,"example":"123 or \"last\""}],"pointer":"/paths/~1conversations~1{conversation_id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"]}},"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"],"pointer":"/paths/~1conversations~1{conversation_id}~1reply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/reply","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"123 or \"last\"","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/conversations/{conversation_id}/reply","href":"conversations/replyconversation","openApiOperationId":"replyConversation","summary":"Reply to a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply","paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User last conversation reply","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply with a Note","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply to send Quick Reply Options","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply with a Note","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply to send Quick Reply Options","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Unsupported message type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Unsupported message type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/Admin lacks permission"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/Admin lacks permission"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Contact not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/No conversation for the contact","paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/Message too long"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/No conversation for the contact","paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/Message too long"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1reply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply with a Note","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply to send Quick Reply Options","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply with a Note","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply to send Quick Reply Options","paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Unsupported message type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Unsupported message type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/Admin lacks permission"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/Admin lacks permission"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/No conversation for the contact","paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/Message too long"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/No conversation for the contact","paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/Message too long"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/replyconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/reply"},{"label":"Manage a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/manageconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/manageconversation","metadata":{"seo":{"title":"Manage a conversation","description":"For managing conversations you can:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"manageConversation","name":"Manage a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1parts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For managing conversations you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Close a conversation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snooze a conversation to reopen on a future date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open a conversation which is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snoozed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign a conversation to an admin and/or team."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Sending messages"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To send a comment, note or quick reply, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/conversations/replyconversation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reply to a conversation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the conversation as given by Intercom, or the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the most recent conversation of a contact. With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", also send the contact's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body, whatever type of request you send. A contact that can't be found returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error, and a contact with no conversations returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{conversation_id}~1parts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1parts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1215","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"schema_1215","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1parts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/parts","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1215","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/conversations/{conversation_id}/parts","href":"conversations/manageconversation","openApiOperationId":"manageConversation","summary":"Manage a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1215","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1215","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assign a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Unsupported message type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Unsupported message type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/Admin lacks permission"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/Admin lacks permission"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Contact not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Snooze time not in the future","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Already assigned","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Message too long"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Snooze time not in the future","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Already assigned","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Message too long"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1parts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Unsupported message type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Unsupported message type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/Admin lacks permission"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/Admin lacks permission"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found","paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Snooze time not in the future","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Already assigned","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Message too long"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Snooze time not in the future","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Already assigned","paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Message too long"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/manageconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/parts"},{"label":"Attach a contact to a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/attachcontacttoconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/attachcontacttoconversation","metadata":{"seo":{"title":"Attach a contact to a conversation","description":"You can add participants who are contacts to a conversation, on behalf of either another contact or an admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachContactToConversation","name":"Attach a contact to a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a contact to a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add participants who are contacts to a conversation, on behalf of either another contact or an admin."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Contacts without an email"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{conversation_id}~1customers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1customers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/attach_contact_to_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/attach_contact_to_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/customers","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/attach_contact_to_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/conversations/{conversation_id}/customers","href":"conversations/attachcontacttoconversation","openApiOperationId":"attachContactToConversation","summary":"Attach a contact to a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/attach_contact_to_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/attach_contact_to_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attach a contact to a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"]}},"schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"]},{"code":"400","description":"Side conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/400/content/application~1json/examples/Side conversation"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/400/content/application~1json/examples/Side conversation"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/400/content/application~1json/examples/Side conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/400/content/application~1json/examples/Side conversation"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/attachcontacttoconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/customers"},{"label":"Detach a contact from a group conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/detachcontactfromconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/detachcontactfromconversation","metadata":{"seo":{"title":"Detach a contact from a group conversation","description":"You can remove participants who are contacts from a group conversation, on behalf of an admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachContactFromConversation","name":"Detach a contact from a group conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach a contact from a group conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can remove participants who are contacts from a group conversation, on behalf of an admin."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Removing the last participant"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot remove the last remaining contact from a conversation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"},{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The identifier for the contact as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/detach_contact_from_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer"]}},"schemaId":"components/schemas/detach_contact_from_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer"],"pointer":"/paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/{conversation_id}/customers/{contact_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"contact_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/detach_contact_from_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/conversations/{conversation_id}/customers/{contact_id}","href":"conversations/detachcontactfromconversation","openApiOperationId":"detachContactFromConversation","summary":"Detach a contact from a group conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/detach_contact_from_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/detach_contact_from_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Detach a contact from a group conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/200/content/application~1json/examples/Detach a contact from a group conversation"]}},"schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/200/content/application~1json/examples/Detach a contact from a group conversation"]},{"code":"400","description":"Side conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/400/content/application~1json/examples/Side conversation"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/400/content/application~1json/examples/Side conversation"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"]},{"code":"422","description":"Last customer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/422/content/application~1json/examples/Last customer"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/422/content/application~1json/examples/Last customer"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/200/content/application~1json/examples/Detach a contact from a group conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_participants_response","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/200/content/application~1json/examples/Detach a contact from a group conversation"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/400/content/application~1json/examples/Side conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/400/content/application~1json/examples/Side conversation"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/422/content/application~1json/examples/Last customer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/422/content/application~1json/examples/Last customer"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/detachcontactfromconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/customers/{contact_id}"},{"label":"List handling events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/listhandlingevents","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/listhandlingevents","metadata":{"seo":{"title":"List handling events","description":"List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listHandlingEvents","name":"List handling events","isWebhook":false,"pointer":"/paths/~1conversations~1{id}~1handling_events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List handling events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1handling_events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{id}~1handling_events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/{id}/handling_events","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/conversations/{id}/handling_events","href":"conversations/listhandlingevents","openApiOperationId":"listHandlingEvents","summary":"List handling events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/handling_event_list","exampleIds":["paths/~1conversations~1{id}~1handling_events/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/handling_event_list","exampleIds":["paths/~1conversations~1{id}~1handling_events/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Conversation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1conversations~1{id}~1handling_events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/handling_event_list","exampleIds":["paths/~1conversations~1{id}~1handling_events/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/handling_event_list","exampleIds":["paths/~1conversations~1{id}~1handling_events/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listhandlingevents"}],"panels":[]}]},"httpPath":"/conversations/{id}/handling_events"},{"label":"List HITL events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/listhitlevents","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/listhitlevents","metadata":{"seo":{"title":"List HITL events","description":"List the human-in-the-loop (HITL) events for a conversation. When Fin is unsure of an answer it can consult a teammate before replying, proposing a draft that the teammate approves, steers with free-text feedback, or takes over. Each consultation is returned as a series of events, oldest first, across every consultation on the conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listHitlEvents","name":"List HITL events","isWebhook":false,"pointer":"/paths/~1conversations~1{id}~1hitl_events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List HITL events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the human-in-the-loop (HITL) events for a conversation. When Fin is unsure of an answer it can consult a teammate before replying, proposing a draft that the teammate approves, steers with free-text feedback, or takes over. Each consultation is returned as a series of events, oldest first, across every consultation on the conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope, and the caller must be able to access the conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events are only recorded once a consultation has ended, so a consultation still awaiting a teammate does not appear."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which fields appear in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_consultation_started"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_threshold_percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidence_percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sharp_ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ask_rationale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issue_summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_question"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_proposed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_teammate_input_received"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"round_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teammate_input"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewer_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regeneration_outcome"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_revised"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"round_index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revised_draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regeneration_outcome"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_consultation_finished"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved_draft_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"final_draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewer_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rounds_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload_truncated"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A consultation always produces a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_consultation_started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_consultation_finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_proposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears when Fin proposed a draft. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_teammate_input_received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears once per round of teammate feedback, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_revised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once per round where Fin produced a revised draft in response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes on interpreting the response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hitl_cycle_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies the consultation, so it is the same on every event of one consultation. It is not unique per event. A conversation can hold several consultations — a consultation that replaces an outstanding one finishes with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outcome"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"superseded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_part_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" links an event to a conversation part where one exists. It is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in ordinary cases: teammate feedback given through the inbox creates no conversation part, a revised draft has no part of its own, and a consultation that escalated or was superseded sent no reply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_proposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is approximate. It reports when the consultation started, which is when the draft was proposed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_threshold_percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are recorded when the consultation begins and are not updated afterwards, so a rule that has since been renamed or retuned will not match its current settings. They are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for consultations not triggered by a rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewer_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies the teammate involved in that event: on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_teammate_input_received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the teammate who gave the feedback, and on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_consultation_finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the teammate who approved the draft or took over. On a consultation with several rounds these can be different teammates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rounds_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counts every round of teammate feedback the consultation had. Only the ten most recent rounds are retained, so a heavily steered consultation returns fewer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_teammate_input_received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rounds_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redacting a conversation removes this data. Depending on how it was redacted, the conversation either returns no events or returns events whose text fields are all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1hitl_events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{id}~1hitl_events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/{id}/hitl_events","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/conversations/{id}/hitl_events","href":"conversations/listhitlevents","openApiOperationId":"listHitlEvents","summary":"List HITL events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/hitl_event_list","exampleIds":["paths/~1conversations~1{id}~1hitl_events/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/hitl_event_list","exampleIds":["paths/~1conversations~1{id}~1hitl_events/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Conversation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1conversations~1{id}~1hitl_events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/hitl_event_list","exampleIds":["paths/~1conversations~1{id}~1hitl_events/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/hitl_event_list","exampleIds":["paths/~1conversations~1{id}~1hitl_events/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listhitlevents"}],"panels":[]}]},"httpPath":"/conversations/{id}/hitl_events"},{"label":"List side conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/listsideconversations","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/listsideconversations","metadata":{"seo":{"title":"List side conversations","description":"List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSideConversations","name":"List side conversations","isWebhook":false,"pointer":"/paths/~1conversations~1{id}~1side_conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List side conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each side conversation includes its conversation parts (messages). Results are paginated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1side_conversations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1153","description":"The page number of results to return (starting from 1)."},{"name":"per_page","in":"query","schemaId":"schema_1216","description":"The number of side conversations to return per page (max 50)."}],"pointer":"/paths/~1conversations~1{id}~1side_conversations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{id}~1side_conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/{id}/side_conversations","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_1153"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1216"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/conversations/{id}/side_conversations","href":"conversations/listsideconversations","openApiOperationId":"listSideConversations","summary":"List side conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/side_conversation_list","exampleIds":["paths/~1conversations~1{id}~1side_conversations/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/side_conversation_list","exampleIds":["paths/~1conversations~1{id}~1side_conversations/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Conversation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1conversations~1{id}~1side_conversations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/side_conversation_list","exampleIds":["paths/~1conversations~1{id}~1side_conversations/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/side_conversation_list","exampleIds":["paths/~1conversations~1{id}~1side_conversations/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listsideconversations"}],"panels":[]}]},"httpPath":"/conversations/{id}/side_conversations"},{"label":"Rate a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/rateconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/rateconversation","metadata":{"seo":{"title":"Rate a conversation","description":"Record a contact's CSAT rating, and an optional remark, on the latest rating request Intercom sent for a conversation. The rating counts in your CSAT reports for the teammate, Fin or workflow that was rated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rateConversation","name":"Rate a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1rating/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record a contact's CSAT rating, and an optional remark, on the latest rating request Intercom sent for a conversation. The rating counts in your CSAT reports for the teammate, Fin or workflow that was rated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the contact the request was sent to can answer. Pass their Intercom ID as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending the same rating and remark again returns the current rating without changing it, so it is safe to retry. A different "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces the earlier one while the rating request still accepts answers. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be added to a rating that has none. Once a remark is set, the rating and the remark can no longer be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the conversation.","required":true,"example":"215471234567890"}],"pointer":"/paths/~1conversations~1{conversation_id}~1rating/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1rating/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rate_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/rate_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1conversations~1{conversation_id}~1rating/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/rating","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"215471234567890","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/rate_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/conversations/{conversation_id}/rating","href":"conversations/rateconversation","openApiOperationId":"rateConversation","summary":"Rate a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/rate_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rate_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rating recorded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rated_conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/rated_conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Resource not available","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Invalid parameter type","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Rating out of range"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Resource not available","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Invalid parameter type","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Rating out of range"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Different contact","paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Conversation access restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Different contact","paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Conversation access restricted"]},{"code":"404","description":"The conversation was not found, or the endpoint is not enabled for the workspace","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/404/content/application~1json/examples/Conversation not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/404/content/application~1json/examples/Conversation not found"]},{"code":"422","description":"Rating not accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/No rating request","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating locked"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/No rating request","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating locked"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1rating/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rated_conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rated_conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Resource not available","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Invalid parameter type","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Rating out of range"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Resource not available","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Invalid parameter type","paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Rating out of range"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Different contact","paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Conversation access restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Different contact","paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Conversation access restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/404/content/application~1json/examples/Conversation not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/404/content/application~1json/examples/Conversation not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/No rating request","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating locked"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/No rating request","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating locked"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/rateconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/rating"},{"label":"Redact a conversation part","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/redactconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/redactconversation","metadata":{"seo":{"title":"Redact a conversation part","description":"You can redact a conversation part or the source message of a conversation (as seen in the source object)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"redactConversation","name":"Redact a conversation part","isWebhook":false,"pointer":"/paths/~1conversations~1redact/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redact a conversation part","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can redact a conversation part or the source message of a conversation (as seen in the source object)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Redacting parts and messages"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are redacting a conversation part, it must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you are redacting a source message, it must have been created by a contact. We will return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_part_not_redactable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error if these criteria are not met."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1redact/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/redact_conversation_request","exampleIds":["paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part","paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/redact_conversation_request","exampleIds":["paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part","paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1redact/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/redact","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/redact_conversation_request","exampleIds":["paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part","paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/redact","href":"conversations/redactconversation","openApiOperationId":"redactConversation","summary":"Redact a conversation part"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/redact_conversation_request","exampleIds":["paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part","paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/redact_conversation_request","exampleIds":["paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part","paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Redact a conversation part","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1redact/post/responses/200/content/application~1json/examples/Redact a conversation part"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1redact/post/responses/200/content/application~1json/examples/Redact a conversation part"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1redact/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1redact/post/responses/200/content/application~1json/examples/Redact a conversation part"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1redact/post/responses/200/content/application~1json/examples/Redact a conversation part"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1redact/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/redactconversation"}],"panels":[]}]},"httpPath":"/conversations/redact"},{"label":"Merge a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/mergeconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/mergeconversation","metadata":{"seo":{"title":"Merge a conversation","description":"Merge a secondary (source) conversation into a primary (target) conversation.The secondary conversation is closed and linked to the primary, whichbecomes the surviving thread. Returns the primary conversation on success."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mergeConversation","name":"Merge a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{id}~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge a secondary (source) conversation into a primary (target) conversation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The secondary conversation is closed and linked to the primary, which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"becomes the surviving thread. Returns the primary conversation on success."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The identifier for the secondary (source) conversation to merge away.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1merge/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{id}~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_conversations_request","exampleIds":["paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation"]}},"schemaId":"components/schemas/merge_conversations_request","exampleIds":["paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation"],"pointer":"/paths/~1conversations~1{id}~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{id}/merge","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/merge_conversations_request","exampleIds":["paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/conversations/{id}/merge","href":"conversations/mergeconversation","openApiOperationId":"mergeConversation","summary":"Merge a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/merge_conversations_request","exampleIds":["paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_conversations_request","exampleIds":["paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conversation merged","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/200/content/application~1json/examples/Conversation merged"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/200/content/application~1json/examples/Conversation merged"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/400/content/application~1json/examples/Bad request"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/400/content/application~1json/examples/Bad request"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"422","description":"Merge failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Primary not found","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Already merged","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Self-merge"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Primary not found","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Already merged","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Self-merge"]}],"pointer":"/paths/~1conversations~1{id}~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/200/content/application~1json/examples/Conversation merged"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/200/content/application~1json/examples/Conversation merged"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/400/content/application~1json/examples/Bad request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/400/content/application~1json/examples/Bad request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Primary not found","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Already merged","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Self-merge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Primary not found","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Already merged","paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Self-merge"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/mergeconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}/merge"},{"label":"Convert a conversation to a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/convertconversationtoticket","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/convertconversationtoticket","metadata":{"seo":{"title":"Convert a conversation to a ticket","description":"You can convert a conversation to a ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"convertConversationToTicket","name":"Convert a conversation to a ticket","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1convert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert a conversation to a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can convert a conversation to a ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1150","description":"The id of the conversation to target","required":true,"example":123}],"pointer":"/paths/~1conversations~1{conversation_id}~1convert/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1convert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/convert_conversation_to_ticket_request","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request"]}},"schemaId":"components/schemas/convert_conversation_to_ticket_request","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request"],"pointer":"/paths/~1conversations~1{conversation_id}~1convert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/convert","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/convert_conversation_to_ticket_request","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request"]}},"responseCodes":["200","400"],"pointer":"/conversations/{conversation_id}/convert","href":"conversations/convertconversationtoticket","openApiOperationId":"convertConversationToTicket","summary":"Convert a conversation to a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/convert_conversation_to_ticket_request","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/convert_conversation_to_ticket_request","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Bad request","paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Side conversation"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Bad request","paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Side conversation"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1convert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Bad request","paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Side conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Bad request","paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Side conversation"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/convertconversationtoticket"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/convert"},{"label":"List all deleted conversation IDs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/listdeletedconversationids","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/listdeletedconversationids","metadata":{"seo":{"title":"List all deleted conversation IDs","description":"List all deleted conversation IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDeletedConversationIds","name":"List all deleted conversation IDs","isWebhook":false,"pointer":"/paths/~1conversations~1deleted/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all deleted conversation IDs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all deleted conversation IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Pagination"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page. You can navigate to next pages using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_1217","description":"How many results per page"},{"name":"order","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns the conversation IDs in ascending or descending order. Defaults to desc"},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1conversations~1deleted/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1deleted/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/deleted","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1217"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/conversations/deleted","href":"conversations/listdeletedconversationids","openApiOperationId":"listDeletedConversationIds","summary":"List all deleted conversation IDs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"View all deleted conversation IDs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_conversation_list","exampleIds":["paths/~1conversations~1deleted/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_conversation_list","exampleIds":["paths/~1conversations~1deleted/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Resource not available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/400/content/application~1json/examples/Resource not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/400/content/application~1json/examples/Resource not available"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/403/content/application~1json/examples/API plan restricted"]}],"pointer":"/paths/~1conversations~1deleted/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_conversation_list","exampleIds":["paths/~1conversations~1deleted/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_conversation_list","exampleIds":["paths/~1conversations~1deleted/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/400/content/application~1json/examples/Resource not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/400/content/application~1json/examples/Resource not available"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1deleted/get/responses/403/content/application~1json/examples/API plan restricted"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listdeletedconversationids"}],"panels":[]}]},"httpPath":"/conversations/deleted"},{"label":"Create a conversation stream token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/createconversationstreamtoken","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/createconversationstreamtoken","metadata":{"seo":{"title":"Create a conversation stream token","description":"Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConversationStreamToken","name":"Create a conversation stream token","isWebhook":false,"pointer":"/paths/~1conversations~1stream~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a conversation stream token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issue a token that a contact's client uses to subscribe to a realtime stream of that contact's conversation events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens are short-lived, so call this endpoint again before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get a fresh one. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoke"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link in the response to end every active token for the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1stream~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_stream_token_request","exampleIds":["paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/create_conversation_stream_token_request","exampleIds":["paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1conversations~1stream~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/stream/token","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_conversation_stream_token_request","exampleIds":["paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/conversations/stream/token","href":"conversations/createconversationstreamtoken","openApiOperationId":"createConversationStreamToken","summary":"Create a conversation stream token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_conversation_stream_token_request","exampleIds":["paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_stream_token_request","exampleIds":["paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token issued","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_stream_token","exampleIds":["paths/~1conversations~1stream~1token/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/conversation_stream_token","exampleIds":["paths/~1conversations~1stream~1token/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing"},"children":[]}]}]}]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"The access token is limited to the conversations of the teammate who installed the app"},{"code":"404","description":"The contact was not found, or the conversation stream is not available for the workspace"}],"pointer":"/paths/~1conversations~1stream~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_stream_token","exampleIds":["paths/~1conversations~1stream~1token/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_stream_token","exampleIds":["paths/~1conversations~1stream~1token/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/createconversationstreamtoken"}],"panels":[]}]},"httpPath":"/conversations/stream/token"},{"label":"Revoke conversation stream tokens","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/revokeconversationstreamtokens","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/revokeconversationstreamtokens","metadata":{"seo":{"title":"Revoke conversation stream tokens","description":"Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revokeConversationStreamTokens","name":"Revoke conversation stream tokens","isWebhook":false,"pointer":"/paths/~1conversations~1stream~1token/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke conversation stream tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Realtime streaming of conversation events uses Server-Sent Events (SSE). It is an opt-in feature, enabled per workspace. Contact Intercom to turn it on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revoke every active conversation stream token for a contact. Call this when the contact signs out or you suspect a token has been exposed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_id","in":"query","schemaId":"schema_1152","description":"The external ID of the contact whose tokens to revoke.","required":true,"example":"contact-1234"}],"pointer":"/paths/~1conversations~1stream~1token/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1stream~1token/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/stream/token","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"external_id","in":"query","required":true,"example":"contact-1234","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","502"],"pointer":"/conversations/stream/token","href":"conversations/revokeconversationstreamtokens","openApiOperationId":"revokeConversationStreamTokens","summary":"Revoke conversation stream tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Tokens revoked"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing"},"children":[]}]}]}]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"The access token is limited to the conversations of the teammate who installed the app"},{"code":"404","description":"The contact was not found, or the conversation stream is not available for the workspace"},{"code":"502","description":"The realtime provider did not confirm the revocation. Retry the request."}],"pointer":"/paths/~1conversations~1stream~1token/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1stream~1token/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403"},{"code":"404"},{"code":"502"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/revokeconversationstreamtokens"}],"panels":[]}]},"httpPath":"/conversations/stream/token"},{"label":"List team handling segments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations/listteamhandlingsegments","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/listteamhandlingsegments","metadata":{"seo":{"title":"List team handling segments","description":"Shows the time teammates spent actively working on a conversation, and which team the conversation was assigned to while they did. Each period covers a single team assignment, and never continues across a team change. team is null for time when no team was assigned. The response doesn't say which teammate did the work."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTeamHandlingSegments","name":"List team handling segments","isWebhook":false,"pointer":"/paths/~1conversations~1{id}~1team_handling_segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List team handling segments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows the time teammates spent actively working on a conversation, and which team the conversation was assigned to while they did. Each period covers a single team assignment, and never continues across a team change. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for time when no team was assigned. The response doesn't say which teammate did the work."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Moving a conversation to another team usually unassigns the teammate as well. Their period then ends with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the next period starts, with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when a teammate picks the conversation up again. You'll only see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team_change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the team changes and the same teammate keeps working without a break, for example when round robin assigns the conversation back to the teammate who already had it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Periods with no team assigned are returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ended_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while a period is still open."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope, and the caller must be able to access the conversation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1team_handling_segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{id}~1team_handling_segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/{id}/team_handling_segments","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/conversations/{id}/team_handling_segments","href":"conversations/listteamhandlingsegments","openApiOperationId":"listTeamHandlingSegments","summary":"List team handling segments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team_handling_segment_list","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/team_handling_segment_list","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Requested resource is not available in current API version","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"403","description":"The teammate cannot access the conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Conversation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1conversations~1{id}~1team_handling_segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team_handling_segment_list","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team_handling_segment_list","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1team_handling_segments/get/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"403","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listteamhandlingsegments"}],"panels":[]}]},"httpPath":"/conversations/{id}/team_handling_segments"},{"type":"link","label":"Conversation","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation"},"seo":{"title":"Conversation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation"},"children":[]}]}]}},{"type":"link","label":"Conversation List Item","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_list_item","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_list_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_list_item"},"seo":{"title":"Conversation List Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation List Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_list_item"},"children":[]}]}]}},{"type":"link","label":"Conversation Monitor Evaluation","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_monitor_evaluation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_monitor_evaluation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_monitor_evaluation"},"seo":{"title":"Conversation Monitor Evaluation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Monitor Evaluation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_monitor_evaluation"},"children":[]}]}]}},{"type":"link","label":"Conversation Scorecard","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard"},"seo":{"title":"Conversation Scorecard"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Scorecard","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard"},"children":[]}]}]}},{"type":"link","label":"Conversation Scorecard Evaluator","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_evaluator","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_evaluator","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_evaluator"},"seo":{"title":"Conversation Scorecard Evaluator"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Scorecard Evaluator","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_evaluator"},"children":[]}]}]}},{"type":"link","label":"Evaluator Reason","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_evaluator_reason","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_evaluator_reason","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_evaluator_reason"},"seo":{"title":"Evaluator Reason"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evaluator Reason","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_evaluator_reason"},"children":[]}]}]}},{"type":"link","label":"Conversation Scorecard Evaluator Result","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_evaluator_result","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_evaluator_result","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_evaluator_result"},"seo":{"title":"Conversation Scorecard Evaluator Result"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Scorecard Evaluator Result","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_evaluator_result"},"children":[]}]}]}},{"type":"link","label":"Scorecard Note","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_note","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_note","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_note"},"seo":{"title":"Scorecard Note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scorecard Note","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_note"},"children":[]}]}]}},{"type":"link","label":"Note Author","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_note_author","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_note_author","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_note_author"},"seo":{"title":"Note Author"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Note Author","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_note_author"},"children":[]}]}]}},{"type":"link","label":"Reviewed Teammate","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_reviewed_teammate","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_reviewed_teammate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_reviewed_teammate"},"seo":{"title":"Reviewed Teammate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviewed Teammate","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_reviewed_teammate"},"children":[]}]}]}},{"type":"link","label":"Reviewer","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_reviewer","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_reviewer","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_reviewer"},"seo":{"title":"Reviewer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviewer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_reviewer"},"children":[]}]}]}},{"type":"link","label":"Revised By","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_revised_by","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_revised_by","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_revised_by"},"seo":{"title":"Revised By"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revised By","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_revised_by"},"children":[]}]}]}},{"type":"link","label":"Submitted By","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_submitted_by","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_scorecard_submitted_by","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_scorecard_submitted_by"},"seo":{"title":"Submitted By"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submitted By","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_scorecard_submitted_by"},"children":[]}]}]}},{"type":"link","label":"Conversation stream token","link":"/docs/references/rest-api/api.intercom.io/conversations/conversation_stream_token","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/conversation_stream_token","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_stream_token"},"seo":{"title":"Conversation stream token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation stream token","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_stream_token"},"children":[]}]}]}},{"type":"link","label":"Merge Conversations Request","link":"/docs/references/rest-api/api.intercom.io/conversations/merge_conversations_request","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/merge_conversations_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_conversations_request"},"seo":{"title":"Merge Conversations Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Conversations Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_conversations_request"},"children":[]}]}]}},{"type":"link","label":"Rated conversation","link":"/docs/references/rest-api/api.intercom.io/conversations/rated_conversation","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations/rated_conversation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"rated_conversation"},"seo":{"title":"Rated conversation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rated conversation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/rated_conversation"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Conversations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversations","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Conversations"},{"nodeType":"external-docs","url":"https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation","description":"What is a conversation?"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Conversation","link":"/conversations/conversation","deprecated":false},{"title":"Conversation List Item","link":"/conversations/conversation_list_item","deprecated":false},{"title":"Conversation Monitor Evaluation","link":"/conversations/conversation_monitor_evaluation","deprecated":false},{"title":"Conversation Scorecard","link":"/conversations/conversation_scorecard","deprecated":false},{"title":"Conversation Scorecard Evaluator","link":"/conversations/conversation_scorecard_evaluator","deprecated":false},{"title":"Evaluator Reason","link":"/conversations/conversation_scorecard_evaluator_reason","deprecated":false},{"title":"Conversation Scorecard Evaluator Result","link":"/conversations/conversation_scorecard_evaluator_result","deprecated":false},{"title":"Scorecard Note","link":"/conversations/conversation_scorecard_note","deprecated":false},{"title":"Note Author","link":"/conversations/conversation_scorecard_note_author","deprecated":false},{"title":"Reviewed Teammate","link":"/conversations/conversation_scorecard_reviewed_teammate","deprecated":false},{"title":"Reviewer","link":"/conversations/conversation_scorecard_reviewer","deprecated":false},{"title":"Revised By","link":"/conversations/conversation_scorecard_revised_by","deprecated":false},{"title":"Submitted By","link":"/conversations/conversation_scorecard_submitted_by","deprecated":false},{"title":"Conversation stream token","link":"/conversations/conversation_stream_token","deprecated":false},{"title":"Merge Conversations Request","link":"/conversations/merge_conversations_request","deprecated":false},{"title":"Rated conversation","link":"/conversations/rated_conversation","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/conversations/{conversation_id}/tags","summary":"Add tag to a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/attachtagtoconversation","deprecated":false},{"title":"/conversations/{conversation_id}/tags/{tag_id}","summary":"Remove tag from a conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations/detachtagfromconversation","deprecated":false},{"title":"/conversations","summary":"List all conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listconversations","deprecated":false},{"title":"/conversations","summary":"Creates a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/createconversation","deprecated":false},{"title":"/conversations/{conversation_id}","summary":"Retrieve a conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/retrieveconversation","deprecated":false},{"title":"/conversations/{conversation_id}","summary":"Update a conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/updateconversation","deprecated":false},{"title":"/conversations/{conversation_id}","summary":"Delete a conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations/deleteconversation","deprecated":false},{"title":"/conversations/search","summary":"Search conversations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/searchconversations","deprecated":false},{"title":"/conversations/{conversation_id}/reply","summary":"Reply to a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/replyconversation","deprecated":false},{"title":"/conversations/{conversation_id}/parts","summary":"Manage a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/manageconversation","deprecated":false},{"title":"/conversations/{conversation_id}/customers","summary":"Attach a contact to a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/attachcontacttoconversation","deprecated":false},{"title":"/conversations/{conversation_id}/customers/{contact_id}","summary":"Detach a contact from a group conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations/detachcontactfromconversation","deprecated":false},{"title":"/conversations/{id}/handling_events","summary":"List handling events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listhandlingevents","deprecated":false},{"title":"/conversations/{id}/hitl_events","summary":"List HITL events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listhitlevents","deprecated":false},{"title":"/conversations/{id}/side_conversations","summary":"List side conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listsideconversations","deprecated":false},{"title":"/conversations/{conversation_id}/rating","summary":"Rate a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/rateconversation","deprecated":false},{"title":"/conversations/redact","summary":"Redact a conversation part","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/redactconversation","deprecated":false},{"title":"/conversations/{id}/merge","summary":"Merge a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/mergeconversation","deprecated":false},{"title":"/conversations/{conversation_id}/convert","summary":"Convert a conversation to a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/convertconversationtoticket","deprecated":false},{"title":"/conversations/deleted","summary":"List all deleted conversation IDs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listdeletedconversationids","deprecated":false},{"title":"/conversations/stream/token","summary":"Create a conversation stream token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/createconversationstreamtoken","deprecated":false},{"title":"/conversations/stream/token","summary":"Revoke conversation stream tokens","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations/revokeconversationstreamtokens","deprecated":false},{"title":"/conversations/{id}/team_handling_segments","summary":"List team handling segments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listteamhandlingsegments","deprecated":false}]}]}]}]}},{"type":"group","label":"Conversations Attributes","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes","items":[{"label":"List all conversation attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/listconversationattributes","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/listconversationattributes","metadata":{"seo":{"title":"List all conversation attributes","description":"You can fetch a list of all conversation attributes for your workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConversationAttributes","name":"List all conversation attributes","isWebhook":false,"pointer":"/paths/~1conversations~1attributes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all conversation attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of all conversation attributes for your workspace."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_archived","in":"query","schemaId":"schema_1156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include archived attributes in the list. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false}],"pointer":"/paths/~1conversations~1attributes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/attributes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"include_archived","in":"query","required":false,"example":false,"schemaId":"schema_1156"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/conversations/attributes","href":"conversations-attributes/listconversationattributes","openApiOperationId":"listConversationAttributes","summary":"List all conversation attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute_list","exampleIds":["paths/~1conversations~1attributes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute_list","exampleIds":["paths/~1conversations~1attributes/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1conversations~1attributes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute_list","exampleIds":["paths/~1conversations~1attributes/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute_list","exampleIds":["paths/~1conversations~1attributes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/listconversationattributes"}],"panels":[]}]},"httpPath":"/conversations/attributes"},{"label":"Create a conversation attribute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/createconversationattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/createconversationattribute","metadata":{"seo":{"title":"Create a conversation attribute","description":"Create a new conversation attribute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConversationAttribute","name":"Create a conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new conversation attribute."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute"]}},"schemaId":"components/schemas/create_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute"],"pointer":"/paths/~1conversations~1attributes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/attributes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute"]}},"responseCodes":["200","401","422"],"pointer":"/conversations/attributes","href":"conversations-attributes/createconversationattribute","openApiOperationId":"createConversationAttribute","summary":"Create a conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List without options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List with too few options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Relationship without object_type_id","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Name already exists"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List without options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List with too few options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Relationship without object_type_id","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Name already exists"]}],"pointer":"/paths/~1conversations~1attributes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List without options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List with too few options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Relationship without object_type_id","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Name already exists"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List without options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List with too few options","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Relationship without object_type_id","paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Name already exists"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/createconversationattribute"}],"panels":[]}]},"httpPath":"/conversations/attributes"},{"label":"Get a conversation attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/getconversationattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/getconversationattribute","metadata":{"seo":{"title":"Get a conversation attribute","description":"Retrieve a single conversation attribute by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationAttribute","name":"Get a conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single conversation attribute by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The conversation attribute id","required":true,"example":3}],"pointer":"/paths/~1conversations~1attributes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conversations/attributes/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":3,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/conversations/attributes/{id}","href":"conversations-attributes/getconversationattribute","openApiOperationId":"getConversationAttribute","summary":"Get a conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation attribute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1attributes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/get/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/getconversationattribute"}],"panels":[]}]},"httpPath":"/conversations/attributes/{id}"},{"label":"Update a conversation attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/updateconversationattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/updateconversationattribute","metadata":{"seo":{"title":"Update a conversation attribute","description":"Update an existing conversation attribute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConversationAttribute","name":"Update a conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing conversation attribute."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The conversation attribute id","required":true,"example":8}],"pointer":"/paths/~1conversations~1attributes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name"]}},"schemaId":"components/schemas/update_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name"],"pointer":"/paths/~1conversations~1attributes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/conversations/attributes/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":8,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name"]}},"responseCodes":["200","401","404","422"],"pointer":"/conversations/attributes/{id}","href":"conversations-attributes/updateconversationattribute","openApiOperationId":"updateConversationAttribute","summary":"Update a conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_attribute_request","exampleIds":["paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation attribute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Options not allowed on update","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name already exists","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name too long"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Options not allowed on update","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name already exists","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name too long"]}],"pointer":"/paths/~1conversations~1attributes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Options not allowed on update","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name already exists","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name too long"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Options not allowed on update","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name already exists","paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name too long"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/updateconversationattribute"}],"panels":[]}]},"httpPath":"/conversations/attributes/{id}"},{"label":"Delete (archive) a conversation attribute","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/deleteconversationattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/deleteconversationattribute","metadata":{"seo":{"title":"Delete (archive) a conversation attribute","description":"Archive a conversation attribute (soft delete). The attribute is marked as archived but not permanently deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConversationAttribute","name":"Delete (archive) a conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete (archive) a conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive a conversation attribute (soft delete). The attribute is marked as archived but not permanently deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The conversation attribute id","required":true,"example":8}],"pointer":"/paths/~1conversations~1attributes~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/attributes/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":8,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/conversations/attributes/{id}","href":"conversations-attributes/deleteconversationattribute","openApiOperationId":"deleteConversationAttribute","summary":"Delete (archive) a conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation attribute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/404/content/application~1json/examples/Not found"]},{"code":"422","description":"Attribute has dependent objects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/422/content/application~1json/examples/Dependent objects"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/422/content/application~1json/examples/Dependent objects"]}],"pointer":"/paths/~1conversations~1attributes~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/404/content/application~1json/examples/Not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/422/content/application~1json/examples/Dependent objects"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}/delete/responses/422/content/application~1json/examples/Dependent objects"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/deleteconversationattribute"}],"panels":[]}]},"httpPath":"/conversations/attributes/{id}"},{"label":"Add an option to a list conversation attribute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/createconversationattributeoption","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/createconversationattributeoption","metadata":{"seo":{"title":"Add an option to a list conversation attribute","description":"Add a new option to a list-type conversation attribute. Returns the full attribute with the updated options array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConversationAttributeOption","name":"Add an option to a list conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes~1{id}~1options/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an option to a list conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a new option to a list-type conversation attribute. Returns the full attribute with the updated options array."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The conversation attribute id","required":true,"example":2}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option"]}},"schemaId":"components/schemas/create_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option"],"pointer":"/paths/~1conversations~1attributes~1{id}~1options/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/attributes/{id}/options","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":2,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option"]}},"responseCodes":["200","401","404","422"],"pointer":"/conversations/attributes/{id}/options","href":"conversations-attributes/createconversationattributeoption","openApiOperationId":"createConversationAttributeOption","summary":"Add an option to a list conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation attribute not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/404/content/application~1json/examples/Not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Unexpected key in body"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Unexpected key in body"]}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Unexpected key in body"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Unexpected key in body"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/createconversationattributeoption"}],"panels":[]}]},"httpPath":"/conversations/attributes/{id}/options"},{"label":"Update an option on a list conversation attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/updateconversationattributeoption","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/updateconversationattributeoption","metadata":{"seo":{"title":"Update an option on a list conversation attribute","description":"Update the label of a single option on a list-type conversation attribute. Returns the full attribute with the updated options array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConversationAttributeOption","name":"Update an option on a list conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an option on a list conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the label of a single option on a list-type conversation attribute. Returns the full attribute with the updated options array."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The conversation attribute id","required":true,"example":2},{"name":"option_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UUID of the list option to update (from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the options array)"},"children":[]}]}]}],"required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option"]}},"schemaId":"components/schemas/update_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option"],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/conversations/attributes/{id}/options/{option_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":2,"schemaId":"schema_1150"},{"name":"option_id","in":"path","required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option"]}},"responseCodes":["200","401","404","422"],"pointer":"/conversations/attributes/{id}/options/{option_id}","href":"conversations-attributes/updateconversationattributeoption","openApiOperationId":"updateConversationAttributeOption","summary":"Update an option on a list conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_attribute_option_request","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation attribute or option not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Option not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Option not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Unexpected key in body"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Unexpected key in body"]}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Option not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Option not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Unexpected key in body"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label required","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label not a string","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Unexpected key in body"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/updateconversationattributeoption"}],"panels":[]}]},"httpPath":"/conversations/attributes/{id}/options/{option_id}"},{"label":"Archive an option on a list conversation attribute","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/deleteconversationattributeoption","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/deleteconversationattributeoption","metadata":{"seo":{"title":"Archive an option on a list conversation attribute","description":"Archive a single option on a list-type conversation attribute (soft delete). The option remains in the response with archived: true. Returns the full attribute with the updated options array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConversationAttributeOption","name":"Archive an option on a list conversation attribute","isWebhook":false,"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive an option on a list conversation attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archive a single option on a list-type conversation attribute (soft delete). The option remains in the response with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns the full attribute with the updated options array."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The conversation attribute id","required":true,"example":2},{"name":"option_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UUID of the list option to archive (from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the options array)"},"children":[]}]}]}],"required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/attributes/{id}/options/{option_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":2,"schemaId":"schema_1150"},{"name":"option_id","in":"path","required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/conversations/attributes/{id}/options/{option_id}","href":"conversations-attributes/deleteconversationattributeoption","openApiOperationId":"deleteConversationAttributeOption","summary":"Archive an option on a list conversation attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation attribute or option not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Option not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Option not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Minimum options"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Minimum options"]}],"pointer":"/paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation_attribute","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Option not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Attribute not found","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Option not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Minimum options"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Not a list type","paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Minimum options"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations-attributes/deleteconversationattributeoption"}],"panels":[]}]},"httpPath":"/conversations/attributes/{id}/options/{option_id}"},{"type":"link","label":"Conversation Attribute","link":"/docs/references/rest-api/api.intercom.io/conversations-attributes/conversation_attribute","routeSlug":"/docs/references/rest-api/api.intercom.io/conversations-attributes/conversation_attribute","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute"},"seo":{"title":"Conversation Attribute"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Conversations Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversations Attributes","showPageActions":true},{"nodeType":"markdoc","content":"Manage custom attributes for conversations"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Conversation Attribute","link":"/conversations-attributes/conversation_attribute","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/conversations/attributes","summary":"List all conversation attributes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations-attributes/listconversationattributes","deprecated":false},{"title":"/conversations/attributes","summary":"Create a conversation attribute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations-attributes/createconversationattribute","deprecated":false},{"title":"/conversations/attributes/{id}","summary":"Get a conversation attribute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations-attributes/getconversationattribute","deprecated":false},{"title":"/conversations/attributes/{id}","summary":"Update a conversation attribute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations-attributes/updateconversationattribute","deprecated":false},{"title":"/conversations/attributes/{id}","summary":"Delete (archive) a conversation attribute","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations-attributes/deleteconversationattribute","deprecated":false},{"title":"/conversations/attributes/{id}/options","summary":"Add an option to a list conversation attribute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations-attributes/createconversationattributeoption","deprecated":false},{"title":"/conversations/attributes/{id}/options/{option_id}","summary":"Update an option on a list conversation attribute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations-attributes/updateconversationattributeoption","deprecated":false},{"title":"/conversations/attributes/{id}/options/{option_id}","summary":"Archive an option on a list conversation attribute","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations-attributes/deleteconversationattributeoption","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Object Instances","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances","items":[{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/updatecontact","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/updatecontact","metadata":{"seo":{"title":"Update a contact","description":"You can update an existing contact (ie. user or lead)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateContact","name":"Update a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing contact (ie. user or lead)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint handles both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom object associations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update a contact with an association to a custom object instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request/response examples to see the custom object association format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"id","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_1191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the contact's merge history in the response. Returned for contacts of any role, with at most the 10 most recent merges."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1{contact_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"]}},"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"],"pointer":"/paths/~1contacts~1{contact_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{contact_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_1191"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/contacts/{contact_id}","href":"custom-object-instances/updatecontact","openApiOperationId":"UpdateContact","summary":"Update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1192","exampleIds":["paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"]}},"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"]}],"pointer":"/paths/~1contacts~1{contact_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1193","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes","paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/updatecontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}"},{"label":"Update a conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/updateconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/updateconversation","metadata":{"seo":{"title":"Update a conversation","description":"You can update an existing conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConversation","name":"Update a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update an existing conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Replying and other actions"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint handles both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom object associations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update a conversation with an association to a custom object instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request/response examples to see the custom object association format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"danger","name":"Breaking change: duplicate custom attribute names"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /conversations/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint now returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 INVALID_PARAMETER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and your workspace contains multiple non-archived conversation custom attributes with the same name. Previously, the update would silently apply to a non-deterministic attribute. To resolve, rename or archive the duplicate attribute in your workspace settings, then retry the request."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1150","description":"The id of the conversation to target","required":true,"example":123}],"pointer":"/paths/~1conversations~1{conversation_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"display_as","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. Inline links are rendered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label (url)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", preserving the link URL alongside the visible text. Line breaks inside a paragraph are rendered as newlines."},"children":[]}]}]}],"example":"plaintext"}],"pointer":"/paths/~1conversations~1{conversation_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{conversation_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/conversations/{conversation_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/conversations/{conversation_id}","href":"custom-object-instances/updateconversation","openApiOperationId":"updateConversation","summary":"Update a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance","paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"update a conversation with an association to a custom object instance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found","paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation","paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/updateconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}"},{"label":"Create or Update a Custom Object Instance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/createcustomobjectinstances","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/createcustomobjectinstances","metadata":{"seo":{"title":"Create or Update a Custom Object Instance","description":"Create or update a custom object instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomObjectInstances","name":"Create or Update a Custom Object Instance","isWebhook":false,"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update a Custom Object Instance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create or update a custom object instance"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_custom_object_instances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_1152","description":"The unique identifier of the custom object type that defines the structure of the custom object instance.","required":true,"example":"Order"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_or_update_custom_object_instance_request","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/create_or_update_custom_object_instance_request","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_object_instances/{custom_object_type_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_or_update_custom_object_instance_request","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/custom_object_instances/{custom_object_type_identifier}","href":"custom-object-instances/createcustomobjectinstances","openApiOperationId":"createCustomObjectInstances","summary":"Create or Update a Custom Object Instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_or_update_custom_object_instance_request","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_or_update_custom_object_instance_request","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_object_instance","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/custom_object_instance","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Reserved external_id","paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Value does not match the attribute type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Reserved external_id","paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Value does not match the attribute type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/404/content/application~1json/examples/TypeNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/404/content/application~1json/examples/TypeNotFound"]}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom_object_instance","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_object_instance","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Reserved external_id","paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Value does not match the attribute type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Reserved external_id","paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Value does not match the attribute type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/404/content/application~1json/examples/TypeNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/404/content/application~1json/examples/TypeNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/createcustomobjectinstances"}],"panels":[]}]},"httpPath":"/custom_object_instances/{custom_object_type_identifier}"},{"label":"List Custom Object Instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/listcustomobjectinstances","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/listcustomobjectinstances","metadata":{"seo":{"title":"List Custom Object Instances","description":"List instances of a custom object type. Three modes are supported:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomObjectInstances","name":"List Custom Object Instances","isWebhook":false,"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Custom Object Instances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List instances of a custom object type. Three modes are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns all instances for the type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"references_contact_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns instances associated with the given contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"references_conversation_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns instances associated with the given conversation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, returns a single matching instance (not a list). If no instance matches, the response is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the same body the single-instance endpoint returns for a miss."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_custom_object_instances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_1152","description":"The unique identifier of the custom object type that defines the structure of the custom object instance.","required":true,"example":"Order"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"references_contact_id","in":"query","schemaId":"schema_1152","description":"Return instances associated with the given contact ID."},{"name":"references_conversation_id","in":"query","schemaId":"schema_1152","description":"Return instances associated with the given conversation ID."},{"name":"external_id","in":"query","schemaId":"schema_1152","description":"Return the single instance with this external ID. When provided, the response is a single object rather than a list."},{"name":"page","in":"query","schemaId":"schema_1150","description":"Page number of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_1218","description":"Number of results per page. Maximum 150."}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_object_instances/{custom_object_type_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_1152"}],"query":[{"name":"references_contact_id","in":"query","required":false,"schemaId":"schema_1152"},{"name":"references_conversation_id","in":"query","required":false,"schemaId":"schema_1152"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_1152"},{"name":"page","in":"query","required":false,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1218"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/custom_object_instances/{custom_object_type_identifier}","href":"custom-object-instances/listcustomobjectinstances","openApiOperationId":"listCustomObjectInstances","summary":"List Custom Object Instances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1219","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_1219","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/400/content/application~1json/examples/Both reference filters given"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/400/content/application~1json/examples/Both reference filters given"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/404/content/application~1json/examples/TypeNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/404/content/application~1json/examples/TypeNotFound"]}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1219","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1219","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/400/content/application~1json/examples/Both reference filters given"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/400/content/application~1json/examples/Both reference filters given"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/404/content/application~1json/examples/TypeNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/404/content/application~1json/examples/TypeNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/listcustomobjectinstances"}],"panels":[]}]},"httpPath":"/custom_object_instances/{custom_object_type_identifier}"},{"label":"Delete a Custom Object Instance by External ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/deletecustomobjectinstancesbyexternalid","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/deletecustomobjectinstancesbyexternalid","metadata":{"seo":{"title":"Delete a Custom Object Instance by External ID","description":"Delete a single Custom Object instance by external_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomObjectInstancesByExternalId","name":"Delete a Custom Object Instance by External ID","isWebhook":false,"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Custom Object Instance by External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a single Custom Object instance by external_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_custom_object_instances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_1152","description":"The unique identifier of the custom object type that defines the structure of the custom object instance.","required":true,"example":"Order"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_id","in":"query","schemaId":"schema_1220","required":true}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_object_instances/{custom_object_type_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_1152"}],"query":[{"name":"external_id","in":"query","required":true,"schemaId":"schema_1220","style":"form"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/custom_object_instances/{custom_object_type_identifier}","href":"custom-object-instances/deletecustomobjectinstancesbyexternalid","openApiOperationId":"deleteCustomObjectInstancesByExternalId","summary":"Delete a Custom Object Instance by External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Custom object type or instance not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Type not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Type not found"]}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Type not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Type not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/deletecustomobjectinstancesbyexternalid"}],"panels":[]}]},"httpPath":"/custom_object_instances/{custom_object_type_identifier}"},{"label":"Get Custom Object Instance by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/getcustomobjectinstancesbyid","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/getcustomobjectinstancesbyid","metadata":{"seo":{"title":"Get Custom Object Instance by ID","description":"Fetch a Custom Object Instance by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomObjectInstancesById","name":"Get Custom Object Instance by ID","isWebhook":false,"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Custom Object Instance by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch a Custom Object Instance by id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_custom_object_instances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_object_instance_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Intercom defined id of the custom object instance. An external id here is not looked up; to find an instance by its external id, call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /custom_object_instances/{custom_object_type_identifier}?external_id="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_1152","description":"The unique identifier of the custom object type that defines the structure of the custom object instance.","required":true,"example":"Order"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"custom_object_instance_id","in":"path","required":true,"schemaId":"schema_1152"},{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}","href":"custom-object-instances/getcustomobjectinstancesbyid","openApiOperationId":"getCustomObjectInstancesById","summary":"Get Custom Object Instance by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful. If the custom object type exists but no instance matches, the response is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"found: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1221","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/not_found_instance"]}},"schemaId":"schema_1221","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/not_found_instance"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/TypeNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/TypeNotFound"]}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1221","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/not_found_instance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1221","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/not_found_instance"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/TypeNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/TypeNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/getcustomobjectinstancesbyid"}],"panels":[]}]},"httpPath":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}"},{"label":"Delete a Custom Object Instance by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/deletecustomobjectinstancesbyid","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/deletecustomobjectinstancesbyid","metadata":{"seo":{"title":"Delete a Custom Object Instance by ID","description":"Delete a single Custom Object instance using the Intercom defined id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomObjectInstancesById","name":"Delete a Custom Object Instance by ID","isWebhook":false,"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Custom Object Instance by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a single Custom Object instance using the Intercom defined id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_custom_object_instances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_object_instance_id","in":"path","schemaId":"schema_1152","description":"The Intercom defined id of the custom object instance","required":true},{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_1152","description":"The unique identifier of the custom object type that defines the structure of the custom object instance.","required":true,"example":"Order"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"custom_object_instance_id","in":"path","required":true,"schemaId":"schema_1152"},{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}","href":"custom-object-instances/deletecustomobjectinstancesbyid","openApiOperationId":"deleteCustomObjectInstancesById","summary":"Delete a Custom Object Instance by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Custom object type or instance not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Type not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Type not found"]}],"pointer":"/paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_object_instance_deleted","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Type not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Instance not found","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Type not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/deletecustomobjectinstancesbyid"}],"panels":[]}]},"httpPath":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}"},{"type":"link","label":"Custom Object Instance","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/custom_object_instance","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/custom_object_instance","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_object_instance"},"seo":{"title":"Custom Object Instance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Instance","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_object_instance"},"children":[]}]}]}},{"type":"link","label":"Custom Object Instances","link":"/docs/references/rest-api/api.intercom.io/custom-object-instances/custom_object_instances_paginated_list","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/custom_object_instances_paginated_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_object_instances_paginated_list"},"seo":{"title":"Custom Object Instances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Instances","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_object_instances_paginated_list"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Custom Object Instances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Instances","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Everything about your Custom Object instances."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Permission Requirements"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From now on, to access this endpoint, you need additional permissions. Please head over to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.intercom.com/a/apps/_/developer-hub"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developer Hub"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" app package authentication settings to configure the required permissions."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Custom Object Instance","link":"/custom-object-instances/custom_object_instance","deprecated":false},{"title":"Custom Object Instances","link":"/custom-object-instances/custom_object_instances_paginated_list","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts/{contact_id}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-object-instances/updatecontact","deprecated":false},{"title":"/conversations/{conversation_id}","summary":"Update a conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-object-instances/updateconversation","deprecated":false},{"title":"/custom_object_instances/{custom_object_type_identifier}","summary":"Create or Update a Custom Object Instance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-object-instances/createcustomobjectinstances","deprecated":false},{"title":"/custom_object_instances/{custom_object_type_identifier}","summary":"List Custom Object Instances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-instances/listcustomobjectinstances","deprecated":false},{"title":"/custom_object_instances/{custom_object_type_identifier}","summary":"Delete a Custom Object Instance by External ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-object-instances/deletecustomobjectinstancesbyexternalid","deprecated":false},{"title":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}","summary":"Get Custom Object Instance by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-object-instances/getcustomobjectinstancesbyid","deprecated":false},{"title":"/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}","summary":"Delete a Custom Object Instance by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-object-instances/deletecustomobjectinstancesbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Attributes","link":"/docs/references/rest-api/api.intercom.io/data-attributes","routeSlug":"/docs/references/rest-api/api.intercom.io/data-attributes","items":[{"label":"List all data attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-attributes/lisdataattributes","routeSlug":"/docs/references/rest-api/api.intercom.io/data-attributes/lisdataattributes","metadata":{"seo":{"title":"List all data attributes","description":"You can fetch a list of all data attributes belonging to a workspace for contacts or companies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lisDataAttributes","name":"List all data attributes","isWebhook":false,"pointer":"/paths/~1data_attributes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all data attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all data attributes belonging to a workspace for contacts or companies."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversation attributes are no longer returned by this endpoint. Calling without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter no longer includes them, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model=conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /conversations/attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"model","in":"query","schemaId":"schema_1222","description":"Specify the data attribute model to return. For conversation attributes, use GET /conversations/attributes instead.","example":"company"},{"name":"include_archived","in":"query","schemaId":"schema_1156","description":"Include archived attributes in the list. By default we return only non archived data attributes.","example":false}],"pointer":"/paths/~1data_attributes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_attributes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_attributes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"model","in":"query","required":false,"example":"company","schemaId":"schema_1222"},{"name":"include_archived","in":"query","required":false,"example":false,"schemaId":"schema_1156"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/data_attributes","href":"data-attributes/lisdataattributes","openApiOperationId":"lisDataAttributes","summary":"List all data attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_attribute_list","exampleIds":["paths/~1data_attributes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/data_attribute_list","exampleIds":["paths/~1data_attributes/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable entity - model=conversation is no longer supported"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/422/content/application~1json/examples/Deprecated conversation model"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/422/content/application~1json/examples/Deprecated conversation model"]}],"pointer":"/paths/~1data_attributes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_attribute_list","exampleIds":["paths/~1data_attributes/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_attribute_list","exampleIds":["paths/~1data_attributes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/422/content/application~1json/examples/Deprecated conversation model"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/422/content/application~1json/examples/Deprecated conversation model"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-attributes/lisdataattributes"}],"panels":[]}]},"httpPath":"/data_attributes"},{"label":"Create a data attribute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-attributes/createdataattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/data-attributes/createdataattribute","metadata":{"seo":{"title":"Create a data attribute","description":"You can create a data attributes for a contact or a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDataAttribute","name":"Create a data attribute","isWebhook":false,"pointer":"/paths/~1data_attributes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a data attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a data attributes for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_attributes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_attribute_request","exampleIds":["paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful","paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name","paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type","paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list"]}},"schemaId":"components/schemas/create_data_attribute_request","exampleIds":["paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful","paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name","paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type","paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list"],"pointer":"/paths/~1data_attributes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data_attributes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_data_attribute_request","exampleIds":["paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful","paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name","paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type","paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list"]}},"responseCodes":["200","400","401","422"],"pointer":"/data_attributes","href":"data-attributes/createdataattribute","openApiOperationId":"createDataAttribute","summary":"Create a data attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_data_attribute_request","exampleIds":["paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful","paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name","paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type","paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_attribute_request","exampleIds":["paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful","paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name","paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists","paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type","paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes/post/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/400/content/application~1json/examples/Same name already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid name","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Attribute already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid Data Type","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Too few options for list"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/400/content/application~1json/examples/Same name already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid name","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Attribute already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid Data Type","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Too few options for list"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/422/content/application~1json/examples/Relationship data type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/422/content/application~1json/examples/Relationship data type"]}],"pointer":"/paths/~1data_attributes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/400/content/application~1json/examples/Same name already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid name","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Attribute already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid Data Type","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Too few options for list"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/400/content/application~1json/examples/Same name already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid name","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Attribute already exists","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid Data Type","paths/~1data_attributes/post/responses/400/content/application~1json/examples/Too few options for list"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/422/content/application~1json/examples/Relationship data type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/422/content/application~1json/examples/Relationship data type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-attributes/createdataattribute"}],"panels":[]}]},"httpPath":"/data_attributes"},{"label":"Update a data attribute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-attributes/updatedataattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/data-attributes/updatedataattribute","metadata":{"seo":{"title":"Update a data attribute","description":"You can update a data attribute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDataAttribute","name":"Update a data attribute","isWebhook":false,"pointer":"/paths/~1data_attributes~1{data_attribute_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a data attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a data attribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧 Updating the data type is not possible"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send this request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it behaves the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"data_attribute_id","in":"path","schemaId":"schema_1150","description":"The data attribute id","required":true,"example":1}],"pointer":"/paths/~1data_attributes~1{data_attribute_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_attributes~1{data_attribute_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_data_attribute_request","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object"]}},"schemaId":"components/schemas/update_data_attribute_request","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object"],"pointer":"/paths/~1data_attributes~1{data_attribute_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/data_attributes/{data_attribute_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"data_attribute_id","in":"path","required":true,"example":1,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_data_attribute_request","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/data_attributes/{data_attribute_id}","href":"data-attributes/updatedataattribute","openApiOperationId":"updateDataAttribute","summary":"Update a data attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_data_attribute_request","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_data_attribute_request","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Too few options in list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/400/content/application~1json/examples/Too few options in list"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/400/content/application~1json/examples/Too few options in list"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Attribute Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/404/content/application~1json/examples/Attribute Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/404/content/application~1json/examples/Attribute Not Found"]},{"code":"422","description":"Has Dependant Object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/422/content/application~1json/examples/Has Dependant Object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/422/content/application~1json/examples/Has Dependant Object"]}],"pointer":"/paths/~1data_attributes~1{data_attribute_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/400/content/application~1json/examples/Too few options in list"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/400/content/application~1json/examples/Too few options in list"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/404/content/application~1json/examples/Attribute Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/404/content/application~1json/examples/Attribute Not Found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/422/content/application~1json/examples/Has Dependant Object"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/422/content/application~1json/examples/Has Dependant Object"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-attributes/updatedataattribute"}],"panels":[]}]},"httpPath":"/data_attributes/{data_attribute_id}"},{"type":"link","label":"Data Attribute","link":"/docs/references/rest-api/api.intercom.io/data-attributes/data_attribute","routeSlug":"/docs/references/rest-api/api.intercom.io/data-attributes/data_attribute","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_attribute"},"seo":{"title":"Data Attribute"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Attribute","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_attribute"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Data Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Attributes","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Data Attributes"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Data Attribute","link":"/data-attributes/data_attribute","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data_attributes","summary":"List all data attributes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-attributes/lisdataattributes","deprecated":false},{"title":"/data_attributes","summary":"Create a data attribute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-attributes/createdataattribute","deprecated":false},{"title":"/data_attributes/{data_attribute_id}","summary":"Update a data attribute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-attributes/updatedataattribute","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Connectors","link":"/docs/references/rest-api/api.intercom.io/data-connectors","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors","items":[{"label":"List all data connectors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectors","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectors","metadata":{"seo":{"title":"List all data connectors","description":"Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. Data connectors allow workflows and AI agents to make HTTP requests to external APIs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDataConnectors","name":"List all data connectors","isWebhook":false,"pointer":"/paths/~1data_connectors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all data connectors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of all data connectors for the workspace, ordered by most recently updated first. Data connectors allow workflows and AI agents to make HTTP requests to external APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_workflow_connector_execution_result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1167","description":"The number of results to return per page. Defaults to 20, minimum 1, maximum 50."},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next.starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous response. Used to paginate through results."},"children":[]}]}]}]}],"pointer":"/paths/~1data_connectors/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_connectors","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1167"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/data_connectors","href":"data-connectors/listdataconnectors","openApiOperationId":"listDataConnectors","summary":"List all data connectors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_list","exampleIds":["paths/~1data_connectors/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_connector_list","exampleIds":["paths/~1data_connectors/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/400/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/400/content/application~1json/examples/Invalid cursor"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1data_connectors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_list","exampleIds":["paths/~1data_connectors/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_list","exampleIds":["paths/~1data_connectors/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/400/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/400/content/application~1json/examples/Invalid cursor"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/listdataconnectors"}],"panels":[]}]},"httpPath":"/data_connectors"},{"label":"Create a data connector","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/createdataconnector","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/createdataconnector","metadata":{"seo":{"title":"Create a data connector","description":"Create a new data connector. The connector is created in draft state. Configure its URL, headers, data inputs, and other settings, then set it to live when ready."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDataConnector","name":"Create a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new data connector. The connector is created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. Configure its URL, headers, data inputs, and other settings, then set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when ready."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_connector_request","exampleIds":["paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created","paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal","paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response"]}},"schemaId":"components/schemas/create_data_connector_request","exampleIds":["paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created","paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal","paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response"],"pointer":"/paths/~1data_connectors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/data_connectors","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_data_connector_request","exampleIds":["paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created","paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal","paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response"]}},"responseCodes":["201","400","401","422"],"pointer":"/data_connectors","href":"data-connectors/createdataconnector","openApiOperationId":"createDataConnector","summary":"Create a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_data_connector_request","exampleIds":["paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created","paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal","paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_connector_request","exampleIds":["paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created","paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal","paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Data connector created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors/post/responses/201/content/application~1json/examples/Data connector created"]}},"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors/post/responses/201/content/application~1json/examples/Data connector created"]},{"code":"400","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors/post/responses/400/content/application~1json/examples/Audiences is not an array"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors/post/responses/400/content/application~1json/examples/Audiences is not an array"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/422/content/application~1json/examples/Missing name","paths/~1data_connectors/post/responses/422/content/application~1json/examples/Invalid audiences"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/422/content/application~1json/examples/Missing name","paths/~1data_connectors/post/responses/422/content/application~1json/examples/Invalid audiences"]}],"pointer":"/paths/~1data_connectors/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors/post/responses/201/content/application~1json/examples/Data connector created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors/post/responses/201/content/application~1json/examples/Data connector created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors/post/responses/400/content/application~1json/examples/Audiences is not an array"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors/post/responses/400/content/application~1json/examples/Audiences is not an array"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/422/content/application~1json/examples/Missing name","paths/~1data_connectors/post/responses/422/content/application~1json/examples/Invalid audiences"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/422/content/application~1json/examples/Missing name","paths/~1data_connectors/post/responses/422/content/application~1json/examples/Invalid audiences"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/createdataconnector"}],"panels":[]}]},"httpPath":"/data_connectors"},{"label":"Retrieve a data connector","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnector","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnector","metadata":{"seo":{"title":"Retrieve a data connector","description":"You can retrieve the full detail of a single data connector by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveDataConnector","name":"Retrieve a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the full detail of a single data connector by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes configuration, data inputs, response fields, and object mappings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_workflow_connector_execution_result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the data connector.","required":true,"example":"12345"}],"pointer":"/paths/~1data_connectors~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state_version","in":"query","schemaId":"schema_1223","description":"Which version of the data connector to return. Defaults to live."}],"pointer":"/paths/~1data_connectors~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_connectors/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1152"}],"query":[{"name":"state_version","in":"query","required":false,"schemaId":"schema_1223"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/data_connectors/{id}","href":"data-connectors/retrievedataconnector","openApiOperationId":"RetrieveDataConnector","summary":"Retrieve a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data connector found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/get/responses/200/content/application~1json/examples/Data connector found"]}},"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/get/responses/200/content/application~1json/examples/Data connector found"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid state_version parameter"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/400/content/application~1json/examples/Invalid state_version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/400/content/application~1json/examples/Invalid state_version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/404/content/application~1json/examples/Data connector not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/404/content/application~1json/examples/Data connector not found"]}],"pointer":"/paths/~1data_connectors~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/get/responses/200/content/application~1json/examples/Data connector found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/get/responses/200/content/application~1json/examples/Data connector found"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/400/content/application~1json/examples/Invalid state_version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/400/content/application~1json/examples/Invalid state_version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/404/content/application~1json/examples/Data connector not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/404/content/application~1json/examples/Data connector not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/retrievedataconnector"}],"panels":[]}]},"httpPath":"/data_connectors/{id}"},{"label":"Delete a data connector","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/deletedataconnector","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/deletedataconnector","metadata":{"seo":{"title":"Delete a data connector","description":"Delete an existing data connector. The connector must be in draft state and must not be in use by any workflows or AI agents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDataConnector","name":"Delete a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an existing data connector. The connector must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state and must not be in use by any workflows or AI agents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the data connector","required":true,"example":"12345"}],"pointer":"/paths/~1data_connectors~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/data_connectors/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","409"],"pointer":"/data_connectors/{id}","href":"data-connectors/deletedataconnector","openApiOperationId":"deleteDataConnector","summary":"Delete a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data connector deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_data_connector_object","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/200/content/application~1json/examples/Data connector deleted"]}},"schemaId":"components/schemas/deleted_data_connector_object","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/200/content/application~1json/examples/Data connector deleted"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/404/content/application~1json/examples/Data connector not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/404/content/application~1json/examples/Data connector not found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector in use","paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector not in draft"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector in use","paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector not in draft"]}],"pointer":"/paths/~1data_connectors~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_data_connector_object","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/200/content/application~1json/examples/Data connector deleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_data_connector_object","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/200/content/application~1json/examples/Data connector deleted"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/404/content/application~1json/examples/Data connector not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/404/content/application~1json/examples/Data connector not found"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector in use","paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector not in draft"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector in use","paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector not in draft"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/deletedataconnector"}],"panels":[]}]},"httpPath":"/data_connectors/{id}"},{"label":"Update a data connector","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/updatedataconnector","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/updatedataconnector","metadata":{"seo":{"title":"Update a data connector","description":"Update an existing data connector. Only provided fields are changed. Set state to live or draft to change the connector's state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDataConnector","name":"Update a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing data connector. Only provided fields are changed. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change the connector's state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the data connector.","required":true,"example":"12345"}],"pointer":"/paths/~1data_connectors~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_data_connector_request","exampleIds":["paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response"]}},"schemaId":"components/schemas/update_data_connector_request","exampleIds":["paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response"],"pointer":"/paths/~1data_connectors~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/data_connectors/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_data_connector_request","exampleIds":["paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response"]}},"responseCodes":["200","400","401","404","409","422"],"pointer":"/data_connectors/{id}","href":"data-connectors/updatedataconnector","openApiOperationId":"updateDataConnector","summary":"Update a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_data_connector_request","exampleIds":["paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_data_connector_request","exampleIds":["paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft","paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data connector updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/200/content/application~1json/examples/Data connector updated"]}},"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/200/content/application~1json/examples/Data connector updated"]},{"code":"400","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Audiences is not an array"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Audiences is not an array"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/404/content/application~1json/examples/Data connector not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/404/content/application~1json/examples/Data connector not found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/409/content/application~1json/examples/Data connector in use"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/409/content/application~1json/examples/Data connector in use"]},{"code":"422","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid audiences","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid field value","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid state"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid audiences","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid field value","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid state"]}],"pointer":"/paths/~1data_connectors~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/200/content/application~1json/examples/Data connector updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_detail","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/200/content/application~1json/examples/Data connector updated"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Audiences is not an array"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Unpermitted property in headers","paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Audiences is not an array"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/404/content/application~1json/examples/Data connector not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/404/content/application~1json/examples/Data connector not found"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/409/content/application~1json/examples/Data connector in use"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/409/content/application~1json/examples/Data connector in use"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid audiences","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid field value","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid state"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid audiences","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid field value","paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid state"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/updatedataconnector"}],"panels":[]}]},"httpPath":"/data_connectors/{id}"},{"label":"List execution results for a data connector","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectorexecutionresults","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectorexecutionresults","metadata":{"seo":{"title":"List execution results for a data connector","description":"Retrieve paginated execution logs for a specific data connector.Results from the last hour are returned by default. Use start_ts and end_ts to customize the time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDataConnectorExecutionResults","name":"List execution results for a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List execution results for a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve paginated execution logs for a specific data connector."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results from the last hour are returned by default. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_ts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_ts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to customize the time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request/response bodies are excluded by default. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_bodies=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_workflow_connector_execution_result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"data_connector_id","in":"path","schemaId":"schema_1224","description":"The unique identifier for the data connector.","required":true}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1225","description":"The number of results per page (1-30, default 10)."},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor for pagination. Use the value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next.starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous response."},"children":[]}]}]}]},{"name":"success","in":"query","schemaId":"schema_1226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by success status. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or omit for all."},"children":[]}]}]}]},{"name":"error_type","in":"query","schemaId":"schema_1227","description":"Filter by error type."},{"name":"start_ts","in":"query","schemaId":"schema_1150","description":"Unix timestamp for start of time range (default 1 hour ago)."},{"name":"end_ts","in":"query","schemaId":"schema_1150","description":"Unix timestamp for end of time range (default now)."},{"name":"include_bodies","in":"query","schemaId":"schema_1226","description":"Include request/response bodies in the response (default false)."}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_connectors/{data_connector_id}/execution_results","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"data_connector_id","in":"path","required":true,"example":"12345","schemaId":"schema_1224"}],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1225"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"},{"name":"success","in":"query","required":false,"schemaId":"schema_1226"},{"name":"error_type","in":"query","required":false,"schemaId":"schema_1227"},{"name":"start_ts","in":"query","required":false,"schemaId":"schema_1150"},{"name":"end_ts","in":"query","required":false,"schemaId":"schema_1150"},{"name":"include_bodies","in":"query","required":false,"schemaId":"schema_1226"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/data_connectors/{data_connector_id}/execution_results","href":"data-connectors/listdataconnectorexecutionresults","openApiOperationId":"listDataConnectorExecutionResults","summary":"List execution results for a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_execution_result_list","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_connector_execution_result_list","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid error_type","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid error_type","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid cursor"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/404/content/application~1json/examples/Data connector not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/404/content/application~1json/examples/Data connector not found"]}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_execution_result_list","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_execution_result_list","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid error_type","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid error_type","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid timestamp","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid cursor"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/404/content/application~1json/examples/Data connector not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/404/content/application~1json/examples/Data connector not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/listdataconnectorexecutionresults"}],"panels":[]}]},"httpPath":"/data_connectors/{data_connector_id}/execution_results"},{"label":"Retrieve an execution result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/showdataconnectorexecutionresult","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/showdataconnectorexecutionresult","metadata":{"seo":{"title":"Retrieve an execution result","description":"Retrieve details for a specific data connector execution result.Includes the request/response bodies and sanitised request URL when they are available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showDataConnectorExecutionResult","name":"Retrieve an execution result","isWebhook":false,"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an execution result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve details for a specific data connector execution result."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes the request/response bodies and sanitised request URL when they are available."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_workflow_connector_execution_result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"data_connector_id","in":"path","schemaId":"schema_1224","description":"The unique identifier for the data connector.","required":true},{"name":"id","in":"path","schemaId":"schema_1228","description":"The unique identifier for the execution result.","required":true}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_connectors/{data_connector_id}/execution_results/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"data_connector_id","in":"path","required":true,"example":"12345","schemaId":"schema_1224"},{"name":"id","in":"path","required":true,"example":"99001","schemaId":"schema_1228"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/data_connectors/{data_connector_id}/execution_results/{id}","href":"data-connectors/showdataconnectorexecutionresult","openApiOperationId":"showDataConnectorExecutionResult","summary":"Retrieve an execution result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_execution_result","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_connector_execution_result","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Execution result not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Execution result not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Execution result not found"]}],"pointer":"/paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_execution_result","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_execution_result","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Execution result not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Execution result not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/showdataconnectorexecutionresult"}],"panels":[]}]},"httpPath":"/data_connectors/{data_connector_id}/execution_results/{id}"},{"label":"List versions of a data connector","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectorversions","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectorversions","metadata":{"seo":{"title":"List versions of a data connector","description":"Retrieve the version history of a data connector, newest first. Each entry is a point-in-time snapshot of the connector's configuration, with the status it has today and an optional note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDataConnectorVersions","name":"List versions of a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors~1{id}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List versions of a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the version history of a data connector, newest first. Each entry is a point-in-time snapshot of the connector's configuration, with the status it has today and an optional note."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are paginated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted on the last page. A data connector that has never been published returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_data_connector_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connector_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1224","description":"The unique identifier for the data connector.","required":true}],"pointer":"/paths/~1data_connectors~1{id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1167","description":"The number of results per page (1-50, default 20). Values outside this range are clamped, so values below 1 are treated as 1. A non-integer value falls back to the default of 20."},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor for pagination. Use the value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next.starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous response."},"children":[]}]}]}]}],"pointer":"/paths/~1data_connectors~1{id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{id}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_connectors/{id}/versions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1224"}],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_1167"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/data_connectors/{id}/versions","href":"data-connectors/listdataconnectorversions","openApiOperationId":"listDataConnectorVersions","summary":"List versions of a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_version_list","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_connector_version_list","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/400/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/400/content/application~1json/examples/Invalid cursor"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/404/content/application~1json/examples/Data connector not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/404/content/application~1json/examples/Data connector not found"]}],"pointer":"/paths/~1data_connectors~1{id}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_version_list","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_version_list","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/400/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/400/content/application~1json/examples/Invalid cursor"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/404/content/application~1json/examples/Data connector not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions/get/responses/404/content/application~1json/examples/Data connector not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/listdataconnectorversions"}],"panels":[]}]},"httpPath":"/data_connectors/{id}/versions"},{"label":"Retrieve a version of a data connector","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnectorversion","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnectorversion","metadata":{"seo":{"title":"Retrieve a version of a data connector","description":"Retrieve a single version of a data connector, including the connector configuration as it was at that version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveDataConnectorVersion","name":"Retrieve a version of a data connector","isWebhook":false,"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a version of a data connector","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a single version of a data connector, including the connector configuration as it was at that version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_data_connector_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connector_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1224","description":"The unique identifier for the data connector.","required":true},{"name":"version_id","in":"path","schemaId":"schema_1229","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_version_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the version, as returned by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectorversions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List versions of a data connector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data_connectors/{id}/versions/{version_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1224"},{"name":"version_id","in":"path","required":true,"example":9821,"schemaId":"schema_1229"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/data_connectors/{id}/versions/{version_id}","href":"data-connectors/retrievedataconnectorversion","openApiOperationId":"retrieveDataConnectorVersion","summary":"Retrieve a version of a data connector"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector or version not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Version not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Version not found"]}],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Version not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Version not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/retrievedataconnectorversion"}],"panels":[]}]},"httpPath":"/data_connectors/{id}/versions/{version_id}"},{"label":"Update the note on a data connector version","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-connectors/updatedataconnectorversion","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/updatedataconnectorversion","metadata":{"seo":{"title":"Update the note on a data connector version","description":"Update the note on a data connector version. The note is the only field that can be changed. This does not publish the version or roll the connector back to it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDataConnectorVersion","name":"Update the note on a data connector version","isWebhook":false,"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the note on a data connector version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the note on a data connector version. The note is the only field that can be changed. This does not publish the version or roll the connector back to it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send an empty string to clear the note."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_data_connector_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1224","description":"The unique identifier for the data connector.","required":true},{"name":"version_id","in":"path","schemaId":"schema_1229","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_version_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the version, as returned by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/data-connectors/listdataconnectorversions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List versions of a data connector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_data_connector_version_request","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note"]}},"schemaId":"components/schemas/update_data_connector_version_request","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note"],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/data_connectors/{id}/versions/{version_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1224"},{"name":"version_id","in":"path","required":true,"example":9821,"schemaId":"schema_1229"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_data_connector_version_request","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note"]}},"responseCodes":["200","400","401","404"],"pointer":"/data_connectors/{id}/versions/{version_id}","href":"data-connectors/updatedataconnectorversion","openApiOperationId":"updateDataConnectorVersion","summary":"Update the note on a data connector version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_data_connector_version_request","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_data_connector_version_request","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Version updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Invalid parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note missing","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note has the wrong type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note missing","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note has the wrong type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Data connector or version not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Version not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Version not found"]}],"pointer":"/paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_connector_version","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note missing","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note has the wrong type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note missing","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note has the wrong type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Unauthorized","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Version not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Data connector not found","paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Version not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-connectors/updatedataconnectorversion"}],"panels":[]}]},"httpPath":"/data_connectors/{id}/versions/{version_id}"},{"type":"link","label":"Data Connector","link":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector"},"seo":{"title":"Data Connector"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector"},"children":[]}]}]}},{"type":"link","label":"Data Connector (Detail)","link":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector_detail","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector_detail","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector_detail"},"seo":{"title":"Data Connector (Detail)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector (Detail)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector_detail"},"children":[]}]}]}},{"type":"link","label":"Data Connector Execution Result","link":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector_execution_result","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector_execution_result","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector_execution_result"},"seo":{"title":"Data Connector Execution Result"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector Execution Result","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector_execution_result"},"children":[]}]}]}},{"type":"link","label":"Data Connector Version","link":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector_version","routeSlug":"/docs/references/rest-api/api.intercom.io/data-connectors/data_connector_version","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector_version"},"seo":{"title":"Data Connector Version"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector Version","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector_version"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Data Connectors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connectors","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Data Connectors"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Data Connector","link":"/data-connectors/data_connector","deprecated":false},{"title":"Data Connector (Detail)","link":"/data-connectors/data_connector_detail","deprecated":false},{"title":"Data Connector Execution Result","link":"/data-connectors/data_connector_execution_result","deprecated":false},{"title":"Data Connector Version","link":"/data-connectors/data_connector_version","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data_connectors","summary":"List all data connectors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-connectors/listdataconnectors","deprecated":false},{"title":"/data_connectors","summary":"Create a data connector","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-connectors/createdataconnector","deprecated":false},{"title":"/data_connectors/{id}","summary":"Retrieve a data connector","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-connectors/retrievedataconnector","deprecated":false},{"title":"/data_connectors/{id}","summary":"Delete a data connector","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-connectors/deletedataconnector","deprecated":false},{"title":"/data_connectors/{id}","summary":"Update a data connector","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/data-connectors/updatedataconnector","deprecated":false},{"title":"/data_connectors/{data_connector_id}/execution_results","summary":"List execution results for a data connector","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-connectors/listdataconnectorexecutionresults","deprecated":false},{"title":"/data_connectors/{data_connector_id}/execution_results/{id}","summary":"Retrieve an execution result","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-connectors/showdataconnectorexecutionresult","deprecated":false},{"title":"/data_connectors/{id}/versions","summary":"List versions of a data connector","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-connectors/listdataconnectorversions","deprecated":false},{"title":"/data_connectors/{id}/versions/{version_id}","summary":"Retrieve a version of a data connector","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-connectors/retrievedataconnectorversion","deprecated":false},{"title":"/data_connectors/{id}/versions/{version_id}","summary":"Update the note on a data connector version","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/data-connectors/updatedataconnectorversion","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Events","link":"/docs/references/rest-api/api.intercom.io/data-events","routeSlug":"/docs/references/rest-api/api.intercom.io/data-events","items":[{"label":"Submit a data event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-events/createdataevent","routeSlug":"/docs/references/rest-api/api.intercom.io/data-events/createdataevent","metadata":{"seo":{"title":"Submit a data event","description":"You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDataEvent","name":"Submit a data event","isWebhook":false,"pointer":"/paths/~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a data event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using the JavaScript API, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adding the code to your app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" makes the Events API available. Once added, you can submit an event using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trackEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Ruby client you pass a hash describing the event to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Intercom::Event.create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"track_user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method directly on the current user object (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.track_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NB: For the JSON object types, please note that we do not currently support nested JSON structure."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is a JSON String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"source\":\"desktop\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is a JSON Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"load\": 3.67"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key ends with the String "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value is a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://en.wikipedia.org/wiki/Unix_time"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", assumed to be in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://en.wikipedia.org/wiki/Coordinated_Universal_Time"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timezone."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"contact_date\": 1392036272"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is a HTTP or HTTPS URI."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"article\": \"https://example.org/ab1de.html\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rich Link"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is a JSON object that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monetary Amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is a JSON object that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"price\": {\"amount\": 34999, \"currency\": \"eur\"}"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lead Events"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When submitting events for Leads, you will need to specify the Lead's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata behaviour"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We currently limit the number of tracked metadata keys to 20 per event name. The limit counts every key ever recorded for that event name, not the keys in a single request, so it is reached cumulatively as you send more events with the same name. Once the quota is reached, we ignore any further keys we receive. The keys that count towards the quota are determined by the order in which they are sent in with the event."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There might be up to 24 hrs delay when you send a new metadata for an existing event."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event de-duplication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"strongly recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send a second granularity Unix timestamp in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicated events are responded to using the normal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"data-events/createdataevent/request/http-api-responses","deepLinkHash":"/data-events/createdataevent#data-events/createdataevent/request/http-api-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP API Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful responses to submitted events return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorised access will be rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events sent about users that cannot be found will return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event lists containing duplicate events will have those duplicates ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Server errors will return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response code and may contain an error message in the body."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_event_request"}},"schemaId":"components/schemas/create_data_event_request","pointer":"/paths/~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_data_event_request"}},"responseCodes":["202","400","401","404","422"],"pointer":"/events","href":"data-events/createdataevent","openApiOperationId":"createDataEvent","summary":"Submit a data event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_data_event_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_event_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"successful"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/Missing a required field","paths/~1events/post/responses/400/content/application~1json/examples/Null event name","paths/~1events/post/responses/400/content/application~1json/examples/Metadata is not an object","paths/~1events/post/responses/400/content/application~1json/examples/Bad type parameter"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/Missing a required field","paths/~1events/post/responses/400/content/application~1json/examples/Null event name","paths/~1events/post/responses/400/content/application~1json/examples/Metadata is not an object","paths/~1events/post/responses/400/content/application~1json/examples/Bad type parameter"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/404/content/application~1json/examples/User not found","paths/~1events/post/responses/404/content/application~1json/examples/Lead not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/404/content/application~1json/examples/User not found","paths/~1events/post/responses/404/content/application~1json/examples/Lead not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/422/content/application~1json/examples/Event name too long","paths/~1events/post/responses/422/content/application~1json/examples/Metadata too long","paths/~1events/post/responses/422/content/application~1json/examples/Invalid timestamp"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/422/content/application~1json/examples/Event name too long","paths/~1events/post/responses/422/content/application~1json/examples/Metadata too long","paths/~1events/post/responses/422/content/application~1json/examples/Invalid timestamp"]}],"pointer":"/paths/~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/Missing a required field","paths/~1events/post/responses/400/content/application~1json/examples/Null event name","paths/~1events/post/responses/400/content/application~1json/examples/Metadata is not an object","paths/~1events/post/responses/400/content/application~1json/examples/Bad type parameter"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/Missing a required field","paths/~1events/post/responses/400/content/application~1json/examples/Null event name","paths/~1events/post/responses/400/content/application~1json/examples/Metadata is not an object","paths/~1events/post/responses/400/content/application~1json/examples/Bad type parameter"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/404/content/application~1json/examples/User not found","paths/~1events/post/responses/404/content/application~1json/examples/Lead not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/404/content/application~1json/examples/User not found","paths/~1events/post/responses/404/content/application~1json/examples/Lead not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/422/content/application~1json/examples/Event name too long","paths/~1events/post/responses/422/content/application~1json/examples/Metadata too long","paths/~1events/post/responses/422/content/application~1json/examples/Invalid timestamp"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/422/content/application~1json/examples/Event name too long","paths/~1events/post/responses/422/content/application~1json/examples/Metadata too long","paths/~1events/post/responses/422/content/application~1json/examples/Invalid timestamp"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-events/createdataevent"}],"panels":[]}]},"httpPath":"/events"},{"label":"List all data events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-events/lisdataevents","routeSlug":"/docs/references/rest-api/api.intercom.io/data-events/lisdataevents","metadata":{"seo":{"title":"List all data events","description":"🚧Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lisDataEvents","name":"List all data events","isWebhook":false,"pointer":"/paths/~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all data events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The events belonging to a customer can be listed by sending a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a user or lead identifier along with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The identifier parameter can be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"anonymous_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/events?type=user&user_id={user_id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/events?type=user&email={email}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/events?type=user&intercom_user_id={id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (this call can be used to list leads)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you send is matched against the lead's anonymous id instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value should be "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://en.wikipedia.org/wiki/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url encoded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can optionally define the result page size as well with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1230","required":true},{"name":"type","in":"query","schemaId":"schema_1231","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"per_page","in":"query","schemaId":"schema_1150","description":"The number of events to return per page."},{"name":"since","in":"query","schemaId":"schema_1232","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only return events created after this time, as a Unix timestamp in milliseconds. Take the value from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"since"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object of a previous response."},"children":[]}]}]}]},{"name":"before","in":"query","schemaId":"schema_1232","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only return events created before this time, as a Unix timestamp in milliseconds. Take the value from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object of a previous response."},"children":[]}]}]}]},{"name":"summary","in":"query","schemaId":"schema_1156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to return an event summary ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event.summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") instead of the list of events. Omit for the paginated event list ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"pointer":"/paths/~1events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"schemaId":"schema_1230","style":"form","explode":true},{"name":"type","in":"query","required":true,"schemaId":"schema_1231"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1150"},{"name":"since","in":"query","required":false,"schemaId":"schema_1232"},{"name":"before","in":"query","required":false,"schemaId":"schema_1232"},{"name":"summary","in":"query","required":false,"schemaId":"schema_1156"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/events","href":"data-events/lisdataevents","openApiOperationId":"lisDataEvents","summary":"List all data events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1233","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Summary (summary=true)","paths/~1events/get/responses/200/content/application~1json/examples/Event list (default)"]}},"schemaId":"schema_1233","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Summary (summary=true)","paths/~1events/get/responses/200/content/application~1json/examples/Event list (default)"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/404/content/application~1json/examples/User not found","paths/~1events/get/responses/404/content/application~1json/examples/Lead not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/404/content/application~1json/examples/User not found","paths/~1events/get/responses/404/content/application~1json/examples/Lead not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/422/content/application~1json/examples/Unsupported type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/422/content/application~1json/examples/Unsupported type"]}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1233","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Summary (summary=true)","paths/~1events/get/responses/200/content/application~1json/examples/Event list (default)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1233","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Summary (summary=true)","paths/~1events/get/responses/200/content/application~1json/examples/Event list (default)"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1events/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/404/content/application~1json/examples/User not found","paths/~1events/get/responses/404/content/application~1json/examples/Lead not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/404/content/application~1json/examples/User not found","paths/~1events/get/responses/404/content/application~1json/examples/Lead not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/422/content/application~1json/examples/Unsupported type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/422/content/application~1json/examples/Unsupported type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-events/lisdataevents"}],"panels":[]}]},"httpPath":"/events"},{"label":"Create event summaries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-events/dataeventsummaries","routeSlug":"/docs/references/rest-api/api.intercom.io/data-events/dataeventsummaries","metadata":{"seo":{"title":"Create event summaries","description":"Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dataEventSummaries","name":"Create event summaries","isWebhook":false,"pointer":"/paths/~1events~1summaries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create event summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify the user with one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If more than one is sent, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used first, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1events~1summaries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_event_summaries_request"}},"schemaId":"components/schemas/create_data_event_summaries_request","pointer":"/paths/~1events~1summaries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events/summaries","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_data_event_summaries_request"}},"responseCodes":["200","400","401","404"],"pointer":"/events/summaries","href":"data-events/dataeventsummaries","openApiOperationId":"dataEventSummaries","summary":"Create event summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_data_event_summaries_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_event_summaries_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No user identifier","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No summaries","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/Summary field has the wrong type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No user identifier","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No summaries","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/Summary field has the wrong type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/404/content/application~1json/examples/User not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/404/content/application~1json/examples/User not found"]}],"pointer":"/paths/~1events~1summaries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No user identifier","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No summaries","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/Summary field has the wrong type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No user identifier","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No summaries","paths/~1events~1summaries/post/responses/400/content/application~1json/examples/Summary field has the wrong type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/404/content/application~1json/examples/User not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/404/content/application~1json/examples/User not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-events/dataeventsummaries"}],"panels":[]}]},"httpPath":"/events/summaries"},{"type":"link","label":"Data Event","link":"/docs/references/rest-api/api.intercom.io/data-events/data_event","routeSlug":"/docs/references/rest-api/api.intercom.io/data-events/data_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_event"},"seo":{"title":"Data Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_event"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Data Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Events","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Data Events"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Data Event","link":"/data-events/data_event","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"Submit a data event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-events/createdataevent","deprecated":false},{"title":"/events","summary":"List all data events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-events/lisdataevents","deprecated":false},{"title":"/events/summaries","summary":"Create event summaries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-events/dataeventsummaries","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Export","link":"/docs/references/rest-api/api.intercom.io/data-export","routeSlug":"/docs/references/rest-api/api.intercom.io/data-export","items":[{"label":"Create content data export","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-export/createdataexport","routeSlug":"/docs/references/rest-api/api.intercom.io/data-export/createdataexport","metadata":{"seo":{"title":"Create content data export","description":"To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDataExport","name":"Create content data export","isWebhook":false,"pointer":"/paths/~1export~1content~1data/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create content data export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create your export job, you need to send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the export endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/export/content/data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint exports "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message delivery and engagement data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported data includes who received each message, when they received it, and how they engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). It does not export raw message or conversation content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The only parameters you need to provide are the range of dates that you want exported. The range cannot be longer than 90 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧 Limit of two active jobs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only have two active jobs per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 2 pending content data export jobs if you attempt to create a third concurrent job."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❗️ Updated_at not included"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 Date ranges are inclusive"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_content_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1content~1data/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_exports_request","exampleIds":["paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/create_data_exports_request","exampleIds":["paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1export~1content~1data/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/export/content/data","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_data_exports_request","exampleIds":["paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","422","429","500"],"pointer":"/export/content/data","href":"data-export/createdataexport","openApiOperationId":"createDataExport","summary":"Create content data export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_data_exports_request","exampleIds":["paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_data_exports_request","exampleIds":["paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Missing date","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Date is not an integer","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Dates out of order","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Unknown parameter"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Missing date","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Date is not an integer","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Dates out of order","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Unknown parameter"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/422/content/application~1json/examples/Range too long"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/422/content/application~1json/examples/Range too long"]},{"code":"429","description":"Too many concurrent jobs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/429/content/application~1json/examples/Concurrent job limit reached"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/429/content/application~1json/examples/Concurrent job limit reached"]},{"code":"500","description":"Content data export disabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/500/content/application~1json/examples/Export disabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/500/content/application~1json/examples/Export disabled"]}],"pointer":"/paths/~1export~1content~1data/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Missing date","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Date is not an integer","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Dates out of order","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Unknown parameter"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Missing date","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Date is not an integer","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Dates out of order","paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Unknown parameter"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/422/content/application~1json/examples/Range too long"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/422/content/application~1json/examples/Range too long"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/429/content/application~1json/examples/Concurrent job limit reached"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/429/content/application~1json/examples/Concurrent job limit reached"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/500/content/application~1json/examples/Export disabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data/post/responses/500/content/application~1json/examples/Export disabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-export/createdataexport"}],"panels":[]}]},"httpPath":"/export/content/data"},{"label":"Show content data export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-export/getdataexport","routeSlug":"/docs/references/rest-api/api.intercom.io/data-export/getdataexport","metadata":{"seo":{"title":"Show content data export","description":"You can view the status of your job by sending a GET request to the URLhttps://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataExport","name":"Show content data export","isWebhook":false,"pointer":"/paths/~1export~1content~1data~1{job_identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show content data export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can view the status of your job by sending a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the URL"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/export/content/data/{job_identifier}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{job_identifier}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧 Jobs expire after one week"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of one week from when the export job was created. After this, the data will no longer be available."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A job that failed is returned with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"504"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status code and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A job left in progress for more than a day is marked failed when you poll it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_content_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_identifier","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job_identifier"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1export~1content~1data~1{job_identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1content~1data~1{job_identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/export/content/data/{job_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"job_identifier","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","504"],"pointer":"/export/content/data/{job_identifier}","href":"data-export/getdataexport","openApiOperationId":"getDataExport","summary":"Show content data export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Export job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"]},{"code":"504","description":"The job failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/504/content/application~1json/examples/Failed job"]}},"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/504/content/application~1json/examples/Failed job"]}],"pointer":"/paths/~1export~1content~1data~1{job_identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"]}}},{"code":"504","schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/504/content/application~1json/examples/Failed job"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1content~1data~1{job_identifier}/get/responses/504/content/application~1json/examples/Failed job"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-export/getdataexport"}],"panels":[]}]},"httpPath":"/export/content/data/{job_identifier}"},{"label":"Cancel content data export","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-export/canceldataexport","routeSlug":"/docs/references/rest-api/api.intercom.io/data-export/canceldataexport","metadata":{"seo":{"title":"Cancel content data export","description":"You can cancel your job. A job that has already reached a terminal state is returned unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelDataExport","name":"Cancel content data export","isWebhook":false,"pointer":"/paths/~1export~1cancel~1{job_identifier}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel content data export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can cancel your job. A job that has already reached a terminal state is returned unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_content_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_identifier","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job_identifier"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1export~1cancel~1{job_identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1cancel~1{job_identifier}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/export/cancel/{job_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"job_identifier","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/export/cancel/{job_identifier}","href":"data-export/canceldataexport","openApiOperationId":"cancelDataExport","summary":"Cancel content data export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Export job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/404/content/application~1json/examples/Job not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/404/content/application~1json/examples/Job not found"]},{"code":"500","description":"Content data export disabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/500/content/application~1json/examples/Export disabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/500/content/application~1json/examples/Export disabled"]}],"pointer":"/paths/~1export~1cancel~1{job_identifier}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_export","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/404/content/application~1json/examples/Job not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/404/content/application~1json/examples/Job not found"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/500/content/application~1json/examples/Export disabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1cancel~1{job_identifier}/post/responses/500/content/application~1json/examples/Export disabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-export/canceldataexport"}],"panels":[]}]},"httpPath":"/export/cancel/{job_identifier}"},{"label":"Download content data export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/data-export/downloaddataexport","routeSlug":"/docs/references/rest-api/api.intercom.io/data-export/downloaddataexport","metadata":{"seo":{"title":"Download content data export","description":"When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadDataExport","name":"Download content data export","isWebhook":false,"pointer":"/paths/~1download~1content~1data~1{job_identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download content data export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your exported message data is returned as a ZIP archive containing one CSV file per data group. The response is sent with the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 Octet header required"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will have to specify the header Accept: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when hitting this endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_content_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_identifier","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job_identifier"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1download~1content~1data~1{job_identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1download~1content~1data~1{job_identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/download/content/data/{job_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"job_identifier","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/download/content/data/{job_identifier}","href":"data-export/downloaddataexport","openApiOperationId":"downloadDataExport","summary":"Download content data export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Export job not found or not complete","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"]},{"code":"500","description":"Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Download failed","paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Export disabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Download failed","paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Export disabled"]}],"pointer":"/paths/~1download~1content~1data~1{job_identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Download failed","paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Export disabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Download failed","paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Export disabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-export/downloaddataexport"}],"panels":[]}]},"httpPath":"/download/content/data/{job_identifier}"},{"type":"link","label":"Data Export","link":"/docs/references/rest-api/api.intercom.io/data-export/data_export","routeSlug":"/docs/references/rest-api/api.intercom.io/data-export/data_export","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_export"},"seo":{"title":"Data Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Export","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_export"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Data Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Export","showPageActions":true},{"nodeType":"markdoc","content":"Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Data Export","link":"/data-export/data_export","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/export/content/data","summary":"Create content data export","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-export/createdataexport","deprecated":false},{"title":"/export/content/data/{job_identifier}","summary":"Show content data export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-export/getdataexport","deprecated":false},{"title":"/export/cancel/{job_identifier}","summary":"Cancel content data export","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-export/canceldataexport","deprecated":false},{"title":"/download/content/data/{job_identifier}","summary":"Download content data export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-export/downloaddataexport","deprecated":false}]}]}]}]}},{"type":"group","label":"Ecommerce Connectors","link":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors","routeSlug":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors","items":[{"label":"Upload a product catalog","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors/uploadecommercecatalog","routeSlug":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors/uploadecommercecatalog","metadata":{"seo":{"title":"Upload a product catalog","description":"Upload a product catalog to an ecommerce connector. The catalog must be a JSONarray of product objects. There are two upload modes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadEcommerceCatalog","name":"Upload a product catalog","isWebhook":false,"pointer":"/paths/~1ecommerce~1connectors~1{id}~1catalog/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a product catalog","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a product catalog to an ecommerce connector. The catalog must be a JSON"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of product objects. There are two upload modes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-file upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — POST a single catalog file (up to 99 MB per request)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sync has started."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — For catalogs that must be split across multiple requests:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST the first part with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalize=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST each subsequent part with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalize=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from step 1,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the previous response. Each part must be ≤ 99 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalize=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to complete the upload and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start the sync. No catalog file is required in the finalization request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Part uploads are idempotent — retrying the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a duplicate. If a response is lost, retry with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"ecommerce-connectors/uploadecommercecatalog/request/product-object-structure","deepLinkHash":"/ecommerce-connectors/uploadecommercecatalog#ecommerce-connectors/uploadecommercecatalog/request/product-object-structure"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product object structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The catalog file must be a JSON array where each element is a product object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required — all other fields are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your unique product identifier. Used to match products on re-upload so only changed products are re-indexed. Also the delete key — any product ID absent from a new upload is removed from Fin's knowledge. Must be stable across uploads."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product name. Used by Fin when searching for and recommending products."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical product page URL shown in Fin's product recommendations. Must be a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product description that Fin reads to understand what the product is. HTML formatting is supported and safely sanitized ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description_html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence if both are provided). This is the primary field Fin uses to match products to shopper questions — a richer description leads to better recommendations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary product image shown in Fin's recommendation cards. Falls back to the first entry of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided. If no valid image can be resolved for a variant, that variant's card is not shown to the shopper."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_urls"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional product images. Used as a fallback when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is absent or when a variant has no specific image."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_min"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lowest price across all variants. If omitted, derived automatically from variant prices. Fin uses this to filter products when a shopper mentions a budget (e.g. \"under $100\"). Displayed as a range alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or as a single value if both are equal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_max"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Highest price across all variants. If omitted, derived from variant prices. Used alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for budget filtering and price display."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency code (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"USD\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"EUR\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"GBP\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Defaults to USD if omitted. Used to format prices with the correct symbol in Fin's responses and product cards."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_stock"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product is available to purchase. If omitted, derived from variant stock — the product is in stock if at least one variant has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_stock: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Products with no in-stock variants are hidden from Fin entirely."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category_path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string or string[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strongly recommended"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchical category breadcrumb (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"Clothing\", \"Outerwear\", \"Jackets\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Fin understands the hierarchy — a shopper asking about \"Clothing\" sees products from all subcategories underneath it. The most specific category is shown in search results."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strongly recommended"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections or groupings this product belongs to in your store. Fin uses collections to understand your catalog's structure and answer questions like \"what's in the sale collection?\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form keywords matching how shoppers phrase needs in chat (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"waterproof\", \"gift\", \"plus-size\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Complements "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category_path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available_options"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option types and their possible values (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"name\": \"Size\", \"values\": [\"S\", \"M\", \"L\"]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Fin uses these to understand what choices a shopper can make and to correctly filter variants when asked for a specific size, colour, or other attribute."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional_data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom attributes for your business. Fin uses these to show each customer only relevant products. All keys must be consistent across all products in your catalog — the attribute schema is read from the first product in the file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variants"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual purchasable variants. Fin recommends specific variants (not just products), so populating variants with accurate stock, price, and option data leads to more precise recommendations. See the variant table below."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ecommerce-connectors/uploadecommercecatalog/request/variant-object-structure","deepLinkHash":"/ecommerce-connectors/uploadecommercecatalog#ecommerce-connectors/uploadecommercecatalog/request/variant-object-structure"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant object structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array may contain:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✓"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this variant within the product."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant display name shown to shoppers (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Small / Blue\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of this specific variant. Fin uses variant prices for precise budget filtering and displays the variant price in recommendation cards."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compare_at_price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original price before a discount. When provided, Fin will naturally mention the saving (e.g. \"down from $129 to $99\")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_stock"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this variant is currently available. Out-of-stock variants are not shown in Fin's recommendation cards and Fin will not suggest them to shoppers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image specific to this variant. Takes precedence over the product's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no valid image can be resolved, this variant's recommendation card will not be shown."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected_options"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific option values that define this variant (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[{\"name\": \"Size\", \"value\": \"Small\"}, {\"name\": \"Color\", \"value\": \"Blue\"}]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Fin uses these to match shopper requests like \"do you have this in medium?\" to the correct variant."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct link to this variant's page. Takes precedence over the product URL in recommendation cards. If omitted, constructed automatically as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{product_url}?variant={id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ecommerce-connectors/uploadecommercecatalog/request/example-catalog-file","deepLinkHash":"/ecommerce-connectors/uploadecommercecatalog#ecommerce-connectors/uploadecommercecatalog/request/example-catalog-file"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example catalog file"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"id\": \"prod-12345\",\n    \"title\": \"Classic Cotton T-Shirt\",\n    \"url\": \"https://example.com/products/classic-cotton-t-shirt\",\n    \"description\": \"A comfortable everyday t-shirt.\",\n    \"featured_image_url\": \"https://cdn.example.com/images/t-shirt.jpg\",\n    \"price_min\": 19.99,\n    \"price_max\": 29.99,\n    \"currency\": \"USD\",\n    \"in_stock\": true,\n    \"tags\": [\"organic\", \"bestseller\"],\n    \"collections\": [\"Summer Collection\"],\n    \"category_path\": \"Clothing > T-Shirts\",\n    \"available_options\": [\n      {\"name\": \"Size\", \"values\": [\"S\", \"M\", \"L\"]},\n      {\"name\": \"Color\", \"values\": [\"White\", \"Blue\"]}\n    ],\n    \"variants\": [\n      {\n        \"id\": \"var-001\",\n        \"title\": \"S / White\",\n        \"price\": 19.99,\n        \"in_stock\": true,\n        \"selected_options\": [\n          {\"name\": \"Size\", \"value\": \"S\"},\n          {\"name\": \"Color\", \"value\": \"White\"}\n        ]\n      },\n      {\n        \"id\": \"var-002\",\n        \"title\": \"M / Blue\",\n        \"price\": 29.99,\n        \"in_stock\": true,\n        \"selected_options\": [\n          {\"name\": \"Size\", \"value\": \"M\"},\n          {\"name\": \"Color\", \"value\": \"Blue\"}\n        ]\n      }\n    ],\n    \"additional_data\": {\n      \"sku\": \"TSHIRT-WHT-S\",\n      \"vendor\": \"Acme Apparel\"\n    }\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"id\": \"prod-12345\",\n    \"title\": \"Classic Cotton T-Shirt\",\n    \"url\": \"https://example.com/products/classic-cotton-t-shirt\",\n    \"description\": \"A comfortable everyday t-shirt.\",\n    \"featured_image_url\": \"https://cdn.example.com/images/t-shirt.jpg\",\n    \"price_min\": 19.99,\n    \"price_max\": 29.99,\n    \"currency\": \"USD\",\n    \"in_stock\": true,\n    \"tags\": [\"organic\", \"bestseller\"],\n    \"collections\": [\"Summer Collection\"],\n    \"category_path\": \"Clothing > T-Shirts\",\n    \"available_options\": [\n      {\"name\": \"Size\", \"values\": [\"S\", \"M\", \"L\"]},\n      {\"name\": \"Color\", \"values\": [\"White\", \"Blue\"]}\n    ],\n    \"variants\": [\n      {\n        \"id\": \"var-001\",\n        \"title\": \"S / White\",\n        \"price\": 19.99,\n        \"in_stock\": true,\n        \"selected_options\": [\n          {\"name\": \"Size\", \"value\": \"S\"},\n          {\"name\": \"Color\", \"value\": \"White\"}\n        ]\n      },\n      {\n        \"id\": \"var-002\",\n        \"title\": \"M / Blue\",\n        \"price\": 29.99,\n        \"in_stock\": true,\n        \"selected_options\": [\n          {\"name\": \"Size\", \"value\": \"M\"},\n          {\"name\": \"Color\", \"value\": \"Blue\"}\n        ]\n      }\n    ],\n    \"additional_data\": {\n      \"sku\": \"TSHIRT-WHT-S\",\n      \"vendor\": \"Acme Apparel\"\n    }\n  }\n]\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1234","description":"The unique identifier of the ecommerce connector.","required":true}],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1catalog/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1catalog/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_1235","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize"]}},"schemaId":"schema_1235","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize"],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ecommerce/connectors/{id}/catalog","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"42939","schemaId":"schema_1234"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_1235","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize"]}},"responseCodes":["200","202","400","401","404","409","422","503"],"pointer":"/ecommerce/connectors/{id}/catalog","href":"ecommerce-connectors/uploadecommercecatalog","openApiOperationId":"uploadEcommerceCatalog","summary":"Upload a product catalog"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1235","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_1235","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part","paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Multipart catalog part uploaded successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_catalog_upload_part_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/200/content/application~1json/examples/Part uploaded"]}},"schemaId":"components/schemas/ecommerce_catalog_upload_part_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/200/content/application~1json/examples/Part uploaded"]},{"code":"202","description":"Catalog accepted and sync has started.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_catalog_upload_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/202/content/application~1json/examples/Sync started"]}},"schemaId":"components/schemas/ecommerce_catalog_upload_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/202/content/application~1json/examples/Sync started"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Missing catalog file","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Catalog is not a file"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Missing catalog file","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Catalog is not a file"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Feature not available","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Upload session not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Feature not available","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Upload session not found"]},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Sync already in progress","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Multipart session already exists","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Session cannot be finalized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Sync already in progress","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Multipart session already exists","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Session cannot be finalized"]},{"code":"422","description":"Unprocessable content.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog is not a JSON array","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog items are not objects","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Part number is not a positive integer","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Out-of-sequence part number","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/File exceeds size limit","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/import_job_id required for multipart"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog is not a JSON array","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog items are not objects","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Part number is not a positive integer","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Out-of-sequence part number","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/File exceeds size limit","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/import_job_id required for multipart"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/503/content/application~1json/examples/Storage error"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/503/content/application~1json/examples/Storage error"]}],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ecommerce_catalog_upload_part_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/200/content/application~1json/examples/Part uploaded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_catalog_upload_part_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/200/content/application~1json/examples/Part uploaded"]}}},{"code":"202","schemaId":"components/schemas/ecommerce_catalog_upload_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/202/content/application~1json/examples/Sync started"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_catalog_upload_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/202/content/application~1json/examples/Sync started"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Missing catalog file","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Catalog is not a file"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Missing catalog file","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Catalog is not a file"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Feature not available","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Upload session not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Feature not available","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Upload session not found"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Sync already in progress","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Multipart session already exists","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Session cannot be finalized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Sync already in progress","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Multipart session already exists","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Session cannot be finalized"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog is not a JSON array","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog items are not objects","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Part number is not a positive integer","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Out-of-sequence part number","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/File exceeds size limit","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/import_job_id required for multipart"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog is not a JSON array","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog items are not objects","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Part number is not a positive integer","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Out-of-sequence part number","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/File exceeds size limit","paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/import_job_id required for multipart"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/503/content/application~1json/examples/Storage error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/503/content/application~1json/examples/Storage error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ecommerce-connectors/uploadecommercecatalog"}],"panels":[]}]},"httpPath":"/ecommerce/connectors/{id}/catalog"},{"label":"Submit a product event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors/submitecommerceproductevent","routeSlug":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors/submitecommerceproductevent","metadata":{"seo":{"title":"Submit a product event","description":"Send a single product change to an ecommerce connector. Use product events to keepFin's product knowledge current between full catalog uploads. Each request carriesone event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitEcommerceProductEvent","name":"Submit a product event","isWebhook":false,"pointer":"/paths/~1ecommerce~1connectors~1{id}~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a product event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a single product change to an ecommerce connector. Use product events to keep"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's product knowledge current between full catalog uploads. Each request carries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full catalog must be uploaded with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/ecommerce-connectors/uploadecommercecatalog"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a product catalog"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before you send events. Until then, this endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"ecommerce-connectors/submitecommerceproductevent/request/event-types","deepLinkHash":"/ecommerce-connectors/submitecommerceproductevent#ecommerce-connectors/submitecommerceproductevent/request/event-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effect"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds the product, or updates it if a product with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the product with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or adds it if it does not exist yet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes the product from Fin's knowledge."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", send the full product object, not only the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields that changed. It uses the same fields as a catalog product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_product"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecommerce_catalog_product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plus a required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. The product is matched by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The serialized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product must be 60 KB or smaller."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", send only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required on every event and must be an ISO 8601 timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"ecommerce-connectors/submitecommerceproductevent/request/processing","deepLinkHash":"/ecommerce-connectors/submitecommerceproductevent#ecommerce-connectors/submitecommerceproductevent/request/processing"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the event is queued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing is asynchronous, so the change may take a short time to reach Fin."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1234","description":"The unique identifier of the ecommerce connector.","required":true}],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1events/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_request","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted"]}},"schemaId":"components/schemas/ecommerce_product_event_request","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted"],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ecommerce/connectors/{id}/events","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"42939","schemaId":"schema_1234"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_request","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted"]}},"responseCodes":["202","400","401","404","409"],"pointer":"/ecommerce/connectors/{id}/events","href":"ecommerce-connectors/submitecommerceproductevent","openApiOperationId":"submitEcommerceProductEvent","summary":"Submit a product event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/ecommerce_product_event_request","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_request","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated","paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Event accepted and queued for processing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/202/content/application~1json/examples/Event accepted"]}},"schemaId":"components/schemas/ecommerce_product_event_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/202/content/application~1json/examples/Event accepted"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event is invalid. All validation errors are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", separated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid type","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid product","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Missing product id on delete","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Product too large"]}},"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid type","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid product","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Missing product id on delete","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Product too large"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Feature not available"]}},"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Feature not available"]},{"code":"409","description":"No full catalog has been uploaded to this connector yet.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/409/content/application~1json/examples/Catalog not uploaded"]}},"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/409/content/application~1json/examples/Catalog not uploaded"]}],"pointer":"/paths/~1ecommerce~1connectors~1{id}~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/ecommerce_product_event_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/202/content/application~1json/examples/Event accepted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_response","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/202/content/application~1json/examples/Event accepted"]}}},{"code":"400","schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid type","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid product","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Missing product id on delete","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Product too large"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid type","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid product","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Missing product id on delete","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Product too large"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Feature not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Connector not found","paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Feature not available"]}}},{"code":"409","schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/409/content/application~1json/examples/Catalog not uploaded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ecommerce_product_event_error","exampleIds":["paths/~1ecommerce~1connectors~1{id}~1events/post/responses/409/content/application~1json/examples/Catalog not uploaded"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ecommerce-connectors/submitecommerceproductevent"}],"panels":[]}]},"httpPath":"/ecommerce/connectors/{id}/events"}],"content":{"contentType":"group","meta":{"name":"Ecommerce Connectors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Connectors","showPageActions":true},{"nodeType":"markdoc","content":"Upload and manage product catalogs via ecommerce connectors. Supports single-file\nuploads (up to 99 MB) and multipart uploads for larger catalogs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ecommerce/connectors/{id}/catalog","summary":"Upload a product catalog","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ecommerce-connectors/uploadecommercecatalog","deprecated":false},{"title":"/ecommerce/connectors/{id}/events","summary":"Submit a product event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ecommerce-connectors/submitecommerceproductevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Dynamic Content","link":"/docs/references/rest-api/api.intercom.io/dynamic-content","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content","items":[{"label":"List all dynamic content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/listdynamiccontents","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/listdynamiccontents","metadata":{"seo":{"title":"List all dynamic content","description":"You can fetch a list of all dynamic content for a workspace, most recently updated first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDynamicContents","name":"List all dynamic content","isWebhook":false,"pointer":"/paths/~1dynamic_contents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all dynamic content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all dynamic content for a workspace, most recently updated first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1205","description":"The page of results to fetch. Defaults to the first page. Values below 1 are treated as 1."},{"name":"per_page","in":"query","schemaId":"schema_1236","description":"The number of results to return per page. Defaults to 50. Values above 50 are reduced to 50, and values below 1 are treated as 1."}],"pointer":"/paths/~1dynamic_contents/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1dynamic_contents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dynamic_contents","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1205"},{"name":"per_page","in":"query","required":false,"example":20,"schemaId":"schema_1236"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/dynamic_contents","href":"dynamic-content/listdynamiccontents","openApiOperationId":"listDynamicContents","summary":"List all dynamic content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content_list","exampleIds":["paths/~1dynamic_contents/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/dynamic_content_list","exampleIds":["paths/~1dynamic_contents/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Dynamic content is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}],"pointer":"/paths/~1dynamic_contents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/dynamic_content_list","exampleIds":["paths/~1dynamic_contents/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content_list","exampleIds":["paths/~1dynamic_contents/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-content/listdynamiccontents"}],"panels":[]}]},"httpPath":"/dynamic_contents"},{"label":"Create dynamic content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/createdynamiccontent","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/createdynamiccontent","metadata":{"seo":{"title":"Create dynamic content","description":"You can create dynamic content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDynamicContent","name":"Create dynamic content","isWebhook":false,"pointer":"/paths/~1dynamic_contents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create dynamic content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create dynamic content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1dynamic_contents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dynamic_content_create_request","exampleIds":["paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content"]}},"schemaId":"components/schemas/dynamic_content_create_request","exampleIds":["paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content"],"pointer":"/paths/~1dynamic_contents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dynamic_contents","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/dynamic_content_create_request","exampleIds":["paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content"]}},"responseCodes":["201","400","401","403","422"],"pointer":"/dynamic_contents","href":"dynamic-content/createdynamiccontent","openApiOperationId":"createDynamicContent","summary":"Create dynamic content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/dynamic_content_create_request","exampleIds":["paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dynamic_content_create_request","exampleIds":["paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override","paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Dynamic content created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents/post/responses/201/content/application~1json/examples/Dynamic content created"]}},"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents/post/responses/201/content/application~1json/examples/Dynamic content created"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/400/content/application~1json/examples/Unknown field"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/400/content/application~1json/examples/Unknown field"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Dynamic content is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/403/content/application~1json/examples/Dynamic content is not enabled"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Name already in use","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing default locale variation","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing text content","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Unknown brand"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Name already in use","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing default locale variation","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing text content","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Unknown brand"]}],"pointer":"/paths/~1dynamic_contents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents/post/responses/201/content/application~1json/examples/Dynamic content created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents/post/responses/201/content/application~1json/examples/Dynamic content created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/400/content/application~1json/examples/Unknown field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/400/content/application~1json/examples/Unknown field"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/403/content/application~1json/examples/Dynamic content is not enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Name already in use","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing default locale variation","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing text content","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Unknown brand"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Name already in use","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing default locale variation","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing text content","paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Unknown brand"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-content/createdynamiccontent"}],"panels":[]}]},"httpPath":"/dynamic_contents"},{"label":"Retrieve dynamic content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/getdynamiccontent","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/getdynamiccontent","metadata":{"seo":{"title":"Retrieve dynamic content","description":"You can fetch a single dynamic content by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDynamicContent","name":"Retrieve dynamic content","isWebhook":false,"pointer":"/paths/~1dynamic_contents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve dynamic content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a single dynamic content by its id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1207","description":"The unique identifier for the dynamic content.","required":true}],"pointer":"/paths/~1dynamic_contents~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1dynamic_contents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dynamic_contents/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1207"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/dynamic_contents/{id}","href":"dynamic-content/getdynamiccontent","openApiOperationId":"getDynamicContent","summary":"Retrieve dynamic content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Dynamic content is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"]},{"code":"404","description":"Dynamic content not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/404/content/application~1json/examples/Dynamic content not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/404/content/application~1json/examples/Dynamic content not found"]}],"pointer":"/paths/~1dynamic_contents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/404/content/application~1json/examples/Dynamic content not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/get/responses/404/content/application~1json/examples/Dynamic content not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-content/getdynamiccontent"}],"panels":[]}]},"httpPath":"/dynamic_contents/{id}"},{"label":"Update dynamic content","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/updatedynamiccontent","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/updatedynamiccontent","metadata":{"seo":{"title":"Update dynamic content","description":"You can update existing dynamic content. Only the fields you provide are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDynamicContent","name":"Update dynamic content","isWebhook":false,"pointer":"/paths/~1dynamic_contents~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update dynamic content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update existing dynamic content. Only the fields you provide are changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send this request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it behaves the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1207","description":"The unique identifier for the dynamic content.","required":true}],"pointer":"/paths/~1dynamic_contents~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1dynamic_contents~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dynamic_content_update_request","exampleIds":["paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content"]}},"schemaId":"components/schemas/dynamic_content_update_request","exampleIds":["paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content"],"pointer":"/paths/~1dynamic_contents~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/dynamic_contents/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1207"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/dynamic_content_update_request","exampleIds":["paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/dynamic_contents/{id}","href":"dynamic-content/updatedynamiccontent","openApiOperationId":"updateDynamicContent","summary":"Update dynamic content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/dynamic_content_update_request","exampleIds":["paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dynamic_content_update_request","exampleIds":["paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dynamic content updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/200/content/application~1json/examples/Dynamic content updated"]}},"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/200/content/application~1json/examples/Dynamic content updated"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Dynamic content is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/403/content/application~1json/examples/Dynamic content is not enabled"]},{"code":"404","description":"Dynamic content not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/404/content/application~1json/examples/Dynamic content not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/404/content/application~1json/examples/Dynamic content not found"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Content type cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Key cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Empty variations","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Missing default locale variation"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Content type cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Key cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Empty variations","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Missing default locale variation"]}],"pointer":"/paths/~1dynamic_contents~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/200/content/application~1json/examples/Dynamic content updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dynamic_content","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/200/content/application~1json/examples/Dynamic content updated"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/400/content/application~1json/examples/Unknown field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/403/content/application~1json/examples/Dynamic content is not enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/404/content/application~1json/examples/Dynamic content not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/404/content/application~1json/examples/Dynamic content not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Content type cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Key cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Empty variations","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Missing default locale variation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Content type cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Key cannot change","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Empty variations","paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Missing default locale variation"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-content/updatedynamiccontent"}],"panels":[]}]},"httpPath":"/dynamic_contents/{id}"},{"label":"Delete dynamic content","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/deletedynamiccontent","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/deletedynamiccontent","metadata":{"seo":{"title":"Delete dynamic content","description":"You can delete a single dynamic content by its id. Dynamic content that is still used in an article can't be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDynamicContent","name":"Delete dynamic content","isWebhook":false,"pointer":"/paths/~1dynamic_contents~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete dynamic content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single dynamic content by its id. Dynamic content that is still used in an article can't be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1207","description":"The unique identifier for the dynamic content.","required":true}],"pointer":"/paths/~1dynamic_contents~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1dynamic_contents~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/dynamic_contents/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1207"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","422"],"pointer":"/dynamic_contents/{id}","href":"dynamic-content/deletedynamiccontent","openApiOperationId":"deleteDynamicContent","summary":"Delete dynamic content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Dynamic content deleted"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Dynamic content is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/403/content/application~1json/examples/Dynamic content is not enabled"]},{"code":"404","description":"Dynamic content not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/404/content/application~1json/examples/Dynamic content not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/404/content/application~1json/examples/Dynamic content not found"]},{"code":"422","description":"Dynamic content is still in use","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/422/content/application~1json/examples/Dynamic content is still in use"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/422/content/application~1json/examples/Dynamic content is still in use"]}],"pointer":"/paths/~1dynamic_contents~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/403/content/application~1json/examples/Dynamic content is not enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/403/content/application~1json/examples/Dynamic content is not enabled"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/404/content/application~1json/examples/Dynamic content not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/404/content/application~1json/examples/Dynamic content not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/422/content/application~1json/examples/Dynamic content is still in use"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1dynamic_contents~1{id}/delete/responses/422/content/application~1json/examples/Dynamic content is still in use"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dynamic-content/deletedynamiccontent"}],"panels":[]}]},"httpPath":"/dynamic_contents/{id}"},{"type":"link","label":"Dynamic Content","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/dynamic_content","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/dynamic_content","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"dynamic_content"},"seo":{"title":"Dynamic Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic Content","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/dynamic_content"},"children":[]}]}]}},{"type":"link","label":"Dynamic Content Variation","link":"/docs/references/rest-api/api.intercom.io/dynamic-content/dynamic_content_variation","routeSlug":"/docs/references/rest-api/api.intercom.io/dynamic-content/dynamic_content_variation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"dynamic_content_variation"},"seo":{"title":"Dynamic Content Variation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic Content Variation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/dynamic_content_variation"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Dynamic Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic Content","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Dynamic Content"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Dynamic Content","link":"/dynamic-content/dynamic_content","deprecated":false},{"title":"Dynamic Content Variation","link":"/dynamic-content/dynamic_content_variation","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dynamic_contents","summary":"List all dynamic content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-content/listdynamiccontents","deprecated":false},{"title":"/dynamic_contents","summary":"Create dynamic content","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dynamic-content/createdynamiccontent","deprecated":false},{"title":"/dynamic_contents/{id}","summary":"Retrieve dynamic content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dynamic-content/getdynamiccontent","deprecated":false},{"title":"/dynamic_contents/{id}","summary":"Update dynamic content","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dynamic-content/updatedynamiccontent","deprecated":false},{"title":"/dynamic_contents/{id}","summary":"Delete dynamic content","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/dynamic-content/deletedynamiccontent","deprecated":false}]}]}]}]}},{"type":"group","label":"Emails","link":"/docs/references/rest-api/api.intercom.io/emails","routeSlug":"/docs/references/rest-api/api.intercom.io/emails","items":[{"label":"List all email settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/emails/listemails","routeSlug":"/docs/references/rest-api/api.intercom.io/emails/listemails","metadata":{"seo":{"title":"List all email settings","description":"Lists all sender email address settings for the workspace"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEmails","name":"List all email settings","isWebhook":false,"pointer":"/paths/~1emails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all email settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all sender email address settings for the workspace"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1emails/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/emails","href":"emails/listemails","openApiOperationId":"listEmails","summary":"List all email settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email_list","exampleIds":["paths/~1emails/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/email_list","exampleIds":["paths/~1emails/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1emails/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1emails/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1emails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/email_list","exampleIds":["paths/~1emails/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email_list","exampleIds":["paths/~1emails/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1emails/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1emails/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/emails/listemails"}],"panels":[]}]},"httpPath":"/emails"},{"label":"Retrieve an email setting","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/emails/retrieveemail","routeSlug":"/docs/references/rest-api/api.intercom.io/emails/retrieveemail","metadata":{"seo":{"title":"Retrieve an email setting","description":"Fetches a specific email setting by its unique identifier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEmail","name":"Retrieve an email setting","isWebhook":false,"pointer":"/paths/~1emails~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an email setting","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a specific email setting by its unique identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the email setting","required":true}],"pointer":"/paths/~1emails~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1emails~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/emails/{id}","href":"emails/retrieveemail","openApiOperationId":"retrieveEmail","summary":"Retrieve an email setting"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email_setting","exampleIds":["paths/~1emails~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/email_setting","exampleIds":["paths/~1emails~1{id}/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Email setting not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/examples/Email setting not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/examples/Email setting not found"]}],"pointer":"/paths/~1emails~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/email_setting","exampleIds":["paths/~1emails~1{id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email_setting","exampleIds":["paths/~1emails~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/examples/Email setting not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1emails~1{id}/get/responses/404/content/application~1json/examples/Email setting not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/emails/retrieveemail"}],"panels":[]}]},"httpPath":"/emails/{id}"},{"type":"link","label":"Email List","link":"/docs/references/rest-api/api.intercom.io/emails/email_list","routeSlug":"/docs/references/rest-api/api.intercom.io/emails/email_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"email_list"},"seo":{"title":"Email List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/email_list"},"children":[]}]}]}},{"type":"link","label":"Email Setting","link":"/docs/references/rest-api/api.intercom.io/emails/email_setting","routeSlug":"/docs/references/rest-api/api.intercom.io/emails/email_setting","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"email_setting"},"seo":{"title":"Email Setting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Setting","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/email_setting"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Emails","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Email Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Email List","link":"/emails/email_list","deprecated":false},{"title":"Email Setting","link":"/emails/email_setting","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/emails","summary":"List all email settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/listemails","deprecated":false},{"title":"/emails/{id}","summary":"Retrieve an email setting","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/retrieveemail","deprecated":false}]}]}]}]}},{"type":"group","label":"Fin Agent","link":"/docs/references/rest-api/api.intercom.io/fin-agent","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent","items":[{"label":"Start a conversation with Fin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/startfinconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/startfinconversation","metadata":{"seo":{"title":"Start a conversation with Fin","description":"Initialize Fin by passing it the user's message along with conversation history and user details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startFinConversation","name":"Start a conversation with Fin","isWebhook":false,"pointer":"/paths/~1fin~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a conversation with Fin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initialize Fin by passing it the user's message along with conversation history and user details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once Fin is initialized, it progresses through a series of statuses such as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thinking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replying"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"awaiting_user_reply"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolved"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before ending with a status of "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During this workflow, the client should allow Fin to continue uninterrupted until a final "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status is returned via webhook, at which point control of the conversation passes back to the client."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1start/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1237","exampleIds":["paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments"]}},"schemaId":"schema_1237","exampleIds":["paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments"],"pointer":"/paths/~1fin~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/start","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1237","exampleIds":["paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/fin/start","href":"fin-agent/startfinconversation","openApiOperationId":"startFinConversation","summary":"Start a conversation with Fin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1237","exampleIds":["paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1237","exampleIds":["paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history","paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fin conversation started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1238","exampleIds":["paths/~1fin~1start/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1start/post/responses/200/content/application~1json/examples/Response with attribute errors"]}},"schemaId":"schema_1238","exampleIds":["paths/~1fin~1start/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1start/post/responses/200/content/application~1json/examples/Response with attribute errors"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1start/post/responses/401/content/application~1json/examples/Token not authorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1start/post/responses/401/content/application~1json/examples/Token not authorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Response format not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Response format not available"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. The response body maps each field name to its error message, or uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures. Values are usually strings. When a required field inside an object, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is missing or invalid, the error is a nested object keyed by the inner field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}},"schemaId":"schema_1239","exampleIds":["paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}],"pointer":"/paths/~1fin~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1238","exampleIds":["paths/~1fin~1start/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1start/post/responses/200/content/application~1json/examples/Response with attribute errors"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1238","exampleIds":["paths/~1fin~1start/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1start/post/responses/200/content/application~1json/examples/Response with attribute errors"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1start/post/responses/401/content/application~1json/examples/Token not authorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1start/post/responses/401/content/application~1json/examples/Token not authorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Response format not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1start/post/responses/403/content/application~1json/examples/Response format not available"]}}},{"code":"422","schemaId":"schema_1239","exampleIds":["paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1start/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/startfinconversation"}],"panels":[]}]},"httpPath":"/fin/start"},{"label":"Reply to Fin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/replytofin","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/replytofin","metadata":{"seo":{"title":"Reply to Fin","description":"Once Fin has returned a response to a user's message, its status will be awaiting_user_reply."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replyToFin","name":"Reply to Fin","isWebhook":false,"pointer":"/paths/~1fin~1reply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reply to Fin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once Fin has returned a response to a user's message, its status will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_user_reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user replies, use this endpoint to send this response to Fin."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1reply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1240","exampleIds":["paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply","paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments"]}},"schemaId":"schema_1240","exampleIds":["paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply","paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments"],"pointer":"/paths/~1fin~1reply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/reply","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1240","exampleIds":["paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply","paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/fin/reply","href":"fin-agent/replytofin","openApiOperationId":"replyToFin","summary":"Reply to Fin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1240","exampleIds":["paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply","paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1240","exampleIds":["paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply","paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reply sent successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1238","exampleIds":["paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Response with attribute errors"]}},"schemaId":"schema_1238","exampleIds":["paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Response with attribute errors"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Token not authorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Token not authorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Response format not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Response format not available"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. The response body maps each field name to its error message, or uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures. Values are usually strings. When a required field inside an object, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is missing or invalid, the error is a nested object keyed by the inner field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Too many user attributes"]}},"schemaId":"schema_1239","exampleIds":["paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Too many user attributes"]}],"pointer":"/paths/~1fin~1reply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1238","exampleIds":["paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Response with attribute errors"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1238","exampleIds":["paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Response with attribute errors"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Token not authorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Token not authorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Response format not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Response format not available"]}}},{"code":"422","schemaId":"schema_1239","exampleIds":["paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Too many user attributes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Too many user attributes"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/replytofin"}],"panels":[]}]},"httpPath":"/fin/reply"},{"label":"Submit a CSAT rating","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/submitfincsat","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/submitfincsat","metadata":{"seo":{"title":"Submit a CSAT rating","description":"Record a customer's satisfaction rating for a conversation, with an optional free-textremark."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitFinCsat","name":"Submit a CSAT rating","isWebhook":false,"pointer":"/paths/~1fin~1csat/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a CSAT rating","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record a customer's satisfaction rating for a conversation, with an optional free-text"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin decides "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ask for a rating — this reuses the CSAT settings on your Fin"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workflow, not this API. When Fin asks, it fires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csat_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event over webhooks"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carrying the rating options to show the user. Present those options, then submit the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user's choice here."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitting the same rating again, with no new remark, is a no-op and stays successful,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so an at-least-once client can safely retry. Submitting a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"different"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rating updates the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored rating while the update window is still open, and a first remark can be added to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an already-rated survey. Once a remark has been recorded the rating is locked and can no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"longer be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1csat/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1241","exampleIds":["paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating","paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark"]}},"schemaId":"schema_1241","exampleIds":["paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating","paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark"],"pointer":"/paths/~1fin~1csat/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/csat","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1241","exampleIds":["paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating","paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark"]}},"responseCodes":["200","401","403","422"],"pointer":"/fin/csat","href":"fin-agent/submitfincsat","openApiOperationId":"submitFinCsat","summary":"Submit a CSAT rating"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1241","exampleIds":["paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating","paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1241","exampleIds":["paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating","paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rating recorded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1242","exampleIds":["paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"schema_1242","exampleIds":["paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rating could not be recorded. Common causes: no conversation exists for the given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Fin never requested a rating for it, the rating window has closed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the rating is locked because a remark was already submitted, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not one of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the supported values."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1243","exampleIds":["paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/No rating requested","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating locked by a remark","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Invalid rating"]}},"schemaId":"schema_1243","exampleIds":["paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/No rating requested","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating locked by a remark","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Invalid rating"]}],"pointer":"/paths/~1fin~1csat/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1242","exampleIds":["paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1242","exampleIds":["paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}}},{"code":"422","schemaId":"schema_1243","exampleIds":["paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/No rating requested","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating locked by a remark","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Invalid rating"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1243","exampleIds":["paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/No rating requested","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating window closed","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating locked by a remark","paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Invalid rating"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/submitfincsat"}],"panels":[]}]},"httpPath":"/fin/csat"},{"label":"Discover Fin's capabilities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/listfincapabilities","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/listfincapabilities","metadata":{"seo":{"title":"Discover Fin's capabilities","description":"Return a machine-readable, per-user list of what Fin can do for a given end user, so anorchestrating agent can decide which endpoint to call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFinCapabilities","name":"Discover Fin's capabilities","isWebhook":false,"pointer":"/paths/~1fin~1capabilities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discover Fin's capabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return a machine-readable, per-user list of what Fin can do for a given end user, so an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orchestrating agent can decide which endpoint to call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is audience-matched to the supplied user: each live, API-triggerable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"procedure is checked against that user before being included, alongside the static"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1capabilities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1244","exampleIds":["paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user"]}},"schemaId":"schema_1244","exampleIds":["paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user"],"pointer":"/paths/~1fin~1capabilities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/capabilities","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1244","exampleIds":["paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/fin/capabilities","href":"fin-agent/listfincapabilities","openApiOperationId":"listFinCapabilities","summary":"Discover Fin's capabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1244","exampleIds":["paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1244","exampleIds":["paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Capabilities returned successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1245","exampleIds":["paths/~1fin~1capabilities/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"schema_1245","exampleIds":["paths/~1fin~1capabilities/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Token not authorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Token not authorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. The response body maps each field name to its error message, or uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures. Values are usually strings. When a required field inside an object, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is missing or invalid, the error is a nested object keyed by the inner field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1246","exampleIds":["paths/~1fin~1capabilities/post/responses/422/content/application~1json/examples/Too many user attributes"]}},"schemaId":"schema_1246","exampleIds":["paths/~1fin~1capabilities/post/responses/422/content/application~1json/examples/Too many user attributes"]}],"pointer":"/paths/~1fin~1capabilities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1245","exampleIds":["paths/~1fin~1capabilities/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1245","exampleIds":["paths/~1fin~1capabilities/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Token not authorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Token not authorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}}},{"code":"422","schemaId":"schema_1246","exampleIds":["paths/~1fin~1capabilities/post/responses/422/content/application~1json/examples/Too many user attributes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1246","exampleIds":["paths/~1fin~1capabilities/post/responses/422/content/application~1json/examples/Too many user attributes"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/listfincapabilities"}],"panels":[]}]},"httpPath":"/fin/capabilities"},{"label":"Ask Fin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/askfin","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/askfin","metadata":{"seo":{"title":"Ask Fin","description":"Ask Fin a single, self-contained question and receive one informational answer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"askFin","name":"Ask Fin","isWebhook":false,"pointer":"/paths/~1fin~1ask/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ask Fin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ask Fin a single, self-contained question and receive one informational answer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike a conversation, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-conversational: Fin will not ask follow-up"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"questions, will not run procedures, and will not decide to hand over to a human itself."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Escalation rules can still match, and the conversation can still be routed to a team or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"finish without resolution. You can also escalate one yourself with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /fin/escalate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the ask conversation is already closed after its one-shot answer, and escalation leaves"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it closed while routing the handoff separately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's answer is delivered asynchronously via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event. The conversation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ends with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status — there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_user_reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1ask/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1247","exampleIds":["paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question","paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes"]}},"schemaId":"schema_1247","exampleIds":["paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question","paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes"],"pointer":"/paths/~1fin~1ask/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/ask","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1247","exampleIds":["paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question","paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/fin/ask","href":"fin-agent/askfin","openApiOperationId":"askFin","summary":"Ask Fin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1247","exampleIds":["paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question","paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1247","exampleIds":["paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question","paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Question accepted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1248","exampleIds":["paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Response with attribute errors"]}},"schemaId":"schema_1248","exampleIds":["paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Response with attribute errors"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Token not authorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Token not authorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Response format not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Response format not available"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. The response body maps each field name to its error message, or uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures. Values are usually strings. When a required field inside an object, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is missing or invalid, the error is a nested object keyed by the inner field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}},"schemaId":"schema_1239","exampleIds":["paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}],"pointer":"/paths/~1fin~1ask/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1248","exampleIds":["paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Response with attribute errors"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1248","exampleIds":["paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Response with attribute errors"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Token not authorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Token not authorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Response format not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API","paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Response format not available"]}}},{"code":"422","schemaId":"schema_1239","exampleIds":["paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Message timestamp missing","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many user attributes","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many history items","paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/askfin"}],"panels":[]}]},"httpPath":"/fin/ask"},{"label":"Run a Fin procedure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/runfinprocedure","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/runfinprocedure","metadata":{"seo":{"title":"Run a Fin procedure","description":"Deterministically run a specific procedure on a new conversation. Calling this endpointguarantees that the named procedure runs — there is no non-deterministic routing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runFinProcedure","name":"Run a Fin procedure","isWebhook":false,"pointer":"/paths/~1fin~1procedures~1{procedure_id}~1run/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a Fin procedure","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deterministically run a specific procedure on a new conversation. Calling this endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guarantees that the named procedure runs — there is no non-deterministic routing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's progress is delivered asynchronously via events. If the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"procedure pauses for user input, the conversation status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_user_reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"send the user's response with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/fin-agent/replytofin"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/reply"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"procedure_id","in":"path","schemaId":"schema_1152","description":"The ID of the procedure to run.","required":true,"example":"12345"}],"pointer":"/paths/~1fin~1procedures~1{procedure_id}~1run/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1procedures~1{procedure_id}~1run/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1249","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run","paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes"]}},"schemaId":"schema_1249","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run","paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes"],"pointer":"/paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/procedures/{procedure_id}/run","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"procedure_id","in":"path","required":true,"example":"12345","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1249","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run","paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/fin/procedures/{procedure_id}/run","href":"fin-agent/runfinprocedure","openApiOperationId":"runFinProcedure","summary":"Run a Fin procedure"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1249","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run","paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1249","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run","paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Procedure run started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1250","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Response with attribute errors"]}},"schemaId":"schema_1250","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Response with attribute errors"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Token not authorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Token not authorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. The response body maps each field name to its error message, or uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures. Values are usually strings. When a required field inside an object, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is missing or invalid, the error is a nested object keyed by the inner field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not found","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not live","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available on the Fin Agent API channel","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available for this user","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/No Fin profile","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}},"schemaId":"schema_1239","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not found","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not live","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available on the Fin Agent API channel","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available for this user","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/No Fin profile","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}],"pointer":"/paths/~1fin~1procedures~1{procedure_id}~1run/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1250","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Response with attribute errors"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1250","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Successful response","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Response with attribute errors"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Token not authorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Token not authorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}}},{"code":"422","schemaId":"schema_1239","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not found","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not live","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available on the Fin Agent API channel","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available for this user","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/No Fin profile","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1239","exampleIds":["paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation ID missing","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not found","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not live","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available on the Fin Agent API channel","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available for this user","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/No Fin profile","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation already exists","paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/runfinprocedure"}],"panels":[]}]},"httpPath":"/fin/procedures/{procedure_id}/run"},{"label":"Escalate to a human","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/fin-agent/escalatefinconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/escalatefinconversation","metadata":{"seo":{"title":"Escalate to a human","description":"Hand a conversation off to a human teammate. If you use the Intercom Helpdesk, thehandoff lands in your team inbox."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"escalateFinConversation","name":"Escalate to a human","isWebhook":false,"pointer":"/paths/~1fin~1escalate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Escalate to a human","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hand a conversation off to a human teammate. If you use the Intercom Helpdesk, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"handoff lands in your team inbox."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — escalate an existing agent conversation, including one started"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On the Intercom Helpdesk, Fin by default summarises the conversation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and opens a new Helpdesk conversation that carries the summary as an internal note."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure an escalation Operator Workflow to change this default. Escalation closes the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"original agent conversation if it is open."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — escalate on behalf of a user with no prior agent conversation. Fin creates an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"agent conversation for the escalation and closes it once the handoff completes. On the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intercom Helpdesk, the teammate works in a separate new Helpdesk conversation. Not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported on Fin for Platforms — see below."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In both cases, pass the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to give the receiving teammate background your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orchestrating agent has and Fin does not. On the Intercom Helpdesk, it appears above the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"summary in the internal note of the new conversation the teammate picks up. It is never"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shown to the end user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Escalating an existing conversation also sets its AI Agent resolution state to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", readable as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai_agent.resolution_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the Conversations API. This is a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolution state, not a billable resolution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On Fin for Platforms, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not supported and is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected, because there is no Intercom Helpdesk in which to create a conversation. There"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is no Intercom inbox either, so an escalation that no workflow handles does not open a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Helpdesk conversation for a teammate. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not surfaced. The conversation is closed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as on the Intercom Helpdesk, and your platform hands the user off to a human."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are notified via webhooks with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"followed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status signals that Fin is done. By then the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"original agent conversation has been closed. An escalation Operator Workflow may act"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on it afterwards, but it is closed again once the workflow's first steps have run, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only steps that run later (for example after a wait) can reopen it. On the Intercom"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Helpdesk, the new human conversation remains open."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1fin~1escalate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1251","exampleIds":["paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation","paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user"]}},"schemaId":"schema_1251","exampleIds":["paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation","paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user"],"pointer":"/paths/~1fin~1escalate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fin/escalate","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1251","exampleIds":["paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation","paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user"]}},"responseCodes":["200","400","401","403","422"],"pointer":"/fin/escalate","href":"fin-agent/escalatefinconversation","openApiOperationId":"escalateFinConversation","summary":"Escalate to a human"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1251","exampleIds":["paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation","paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1251","exampleIds":["paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation","paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conversation escalated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1252","exampleIds":["paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/Existing conversation","paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/New conversation"]}},"schemaId":"schema_1252","exampleIds":["paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/Existing conversation","paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/New conversation"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Token not authorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Token not authorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. The response body maps each field name to its error message, or uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures. Values are usually strings. When a required field inside an object, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is missing or invalid, the error is a nested object keyed by the inner field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1253","exampleIds":["paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Neither identifier provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Both identifiers provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/User not supported on Fin for Platforms","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Context too long","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Deprecated message field"]}},"schemaId":"schema_1253","exampleIds":["paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Neither identifier provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Both identifiers provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/User not supported on Fin for Platforms","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Context too long","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Deprecated message field"]}],"pointer":"/paths/~1fin~1escalate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1252","exampleIds":["paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/Existing conversation","paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/New conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1252","exampleIds":["paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/Existing conversation","paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/New conversation"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Token not authorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Token not authorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Fin Agent API not enabled","paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"]}}},{"code":"422","schemaId":"schema_1253","exampleIds":["paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Neither identifier provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Both identifiers provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/User not supported on Fin for Platforms","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Context too long","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Deprecated message field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1253","exampleIds":["paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Neither identifier provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Both identifiers provided","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Conversation not found","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/User not supported on Fin for Platforms","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Context too long","paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Deprecated message field"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fin-agent/escalatefinconversation"}],"panels":[]}]},"httpPath":"/fin/escalate"},{"type":"link","label":"Fin Agent Attachment","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_attachment","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_attachment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_attachment"},"seo":{"title":"Fin Agent Attachment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Attachment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_attachment"},"children":[]}]}]}},{"type":"link","label":"Fin Agent Attribute Errors","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_attribute_errors","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_attribute_errors","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_attribute_errors"},"seo":{"title":"Fin Agent Attribute Errors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Attribute Errors","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_attribute_errors"},"children":[]}]}]}},{"type":"link","label":"Fin Agent Conversation Metadata","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_conversation_metadata","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_conversation_metadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_conversation_metadata"},"seo":{"title":"Fin Agent Conversation Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Conversation Metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_conversation_metadata"},"children":[]}]}]}},{"type":"link","label":"Fin Agent CSAT Requested Event","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_csat_requested_event","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_csat_requested_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_csat_requested_event"},"seo":{"title":"Fin Agent CSAT Requested Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent CSAT Requested Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_csat_requested_event"},"children":[]}]}]}},{"type":"link","label":"Fin Agent Message","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_message","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_message","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_message"},"seo":{"title":"Fin Agent Message"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Message","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_message"},"children":[]}]}]}},{"type":"link","label":"Fin Agent Replied Event","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_replied_event","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_replied_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_replied_event"},"seo":{"title":"Fin Agent Replied Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Replied Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_replied_event"},"children":[]}]}]}},{"type":"link","label":"Fin Agent Status Updated Event","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_status_updated_event","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_status_updated_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_status_updated_event"},"seo":{"title":"Fin Agent Status Updated Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Status Updated Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_status_updated_event"},"children":[]}]}]}},{"type":"link","label":"Fin Agent User","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_user","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_user","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_user"},"seo":{"title":"Fin Agent User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent User","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_user"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Fin Agent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access Fin programmatically via the Fin Agent API endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To request access to the Fin Agent API, go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings > Integrations > Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your workspace and tell us about your use case. Once access is granted, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin Agent API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appears under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin AI Agent > Deploy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration centres on the Fin Agent API endpoints — start a conversation with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and continue it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or drive Fin from your own agent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/capabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/procedures/{procedure_id}/run"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/escalate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — plus a set of events that notify your application of Fin's status and responses. Events are delivered via webhooks. You can also record a customer satisfaction rating with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/csat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure a webhook endpoint in the Fin Agent API settings to receive events. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/guides/fin-agent-api/setup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setup guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for configuration details."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_status_updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fired when Fin's status changes (awaiting_user_reply, escalated, resolved, complete)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fired when Fin sends a reply to the user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csat_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fired when Fin asks the user to rate the conversation (submit the choice with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /fin/csat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All webhook requests include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Fin-Agent-API-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for request validation."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Fin Agent Attachment","link":"/fin-agent/fin_agent_attachment","deprecated":false},{"title":"Fin Agent Attribute Errors","link":"/fin-agent/fin_agent_attribute_errors","deprecated":false},{"title":"Fin Agent Conversation Metadata","link":"/fin-agent/fin_agent_conversation_metadata","deprecated":false},{"title":"Fin Agent CSAT Requested Event","link":"/fin-agent/fin_agent_csat_requested_event","deprecated":false},{"title":"Fin Agent Message","link":"/fin-agent/fin_agent_message","deprecated":false},{"title":"Fin Agent Replied Event","link":"/fin-agent/fin_agent_replied_event","deprecated":false},{"title":"Fin Agent Status Updated Event","link":"/fin-agent/fin_agent_status_updated_event","deprecated":false},{"title":"Fin Agent User","link":"/fin-agent/fin_agent_user","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fin/start","summary":"Start a conversation with Fin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/startfinconversation","deprecated":false},{"title":"/fin/reply","summary":"Reply to Fin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/replytofin","deprecated":false},{"title":"/fin/csat","summary":"Submit a CSAT rating","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/submitfincsat","deprecated":false},{"title":"/fin/capabilities","summary":"Discover Fin's capabilities","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/listfincapabilities","deprecated":false},{"title":"/fin/ask","summary":"Ask Fin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/askfin","deprecated":false},{"title":"/fin/procedures/{procedure_id}/run","summary":"Run a Fin procedure","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/runfinprocedure","deprecated":false},{"title":"/fin/escalate","summary":"Escalate to a human","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fin-agent/escalatefinconversation","deprecated":false}]}]}]}]}},{"type":"group","label":"Folders","link":"/docs/references/rest-api/api.intercom.io/folders","routeSlug":"/docs/references/rest-api/api.intercom.io/folders","items":[{"label":"List all folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/folders/listfolders","routeSlug":"/docs/references/rest-api/api.intercom.io/folders/listfolders","metadata":{"seo":{"title":"List all folders","description":"You can fetch a list of all folders for organizing content by making a GET request to https://api.intercom.io/folders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFolders","name":"List all folders","isWebhook":false,"pointer":"/paths/~1folders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all folders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all folders for organizing content by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/folders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1205","description":"The page number"},{"name":"per_page","in":"query","schemaId":"schema_1254","description":"Number of results per page"},{"name":"parent_folder_id","in":"query","schemaId":"schema_1150","description":"Filter folders by parent folder ID. Use this to list only direct children of a specific folder.","example":1}],"pointer":"/paths/~1folders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1folders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folders","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_1205"},{"name":"per_page","in":"query","example":50,"schemaId":"schema_1254"},{"name":"parent_folder_id","in":"query","required":false,"example":1,"schemaId":"schema_1150"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/folders","href":"folders/listfolders","openApiOperationId":"listFolders","summary":"List all folders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned as strings when you send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request, and as integers otherwise."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1255","exampleIds":["paths/~1folders/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_1255","exampleIds":["paths/~1folders/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1folders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1255","exampleIds":["paths/~1folders/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1255","exampleIds":["paths/~1folders/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/listfolders"}],"panels":[]}]},"httpPath":"/folders"},{"label":"Create a folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/folders/createfolder","routeSlug":"/docs/references/rest-api/api.intercom.io/folders/createfolder","metadata":{"seo":{"title":"Create a folder","description":"You can create a new folder for organizing content by making a POST request to https://api.intercom.io/folders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFolder","name":"Create a folder","isWebhook":false,"pointer":"/paths/~1folders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new folder for organizing content by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/folders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1folders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1256","exampleIds":["paths/~1folders/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1256","exampleIds":["paths/~1folders/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1folders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/folders","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1256","exampleIds":["paths/~1folders/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401"],"pointer":"/folders","href":"folders/createfolder","openApiOperationId":"createFolder","summary":"Create a folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1256","exampleIds":["paths/~1folders/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1256","exampleIds":["paths/~1folders/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"folder created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1folders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/folder","exampleIds":["paths/~1folders/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/createfolder"}],"panels":[]}]},"httpPath":"/folders"},{"label":"Retrieve a folder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/folders/retrievefolder","routeSlug":"/docs/references/rest-api/api.intercom.io/folders/retrievefolder","metadata":{"seo":{"title":"Retrieve a folder","description":"You can fetch the details of a single folder by making a GET request to https://api.intercom.io/folders/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFolder","name":"Retrieve a folder","isWebhook":false,"pointer":"/paths/~1folders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single folder by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/folders/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the folder","required":true,"example":6}],"pointer":"/paths/~1folders~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1folders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/folders/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":6,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/folders/{id}","href":"folders/retrievefolder","openApiOperationId":"retrieveFolder","summary":"Retrieve a folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"folder found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid folder ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/get/responses/400/content/application~1json/examples/Invalid folder ID"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/get/responses/400/content/application~1json/examples/Invalid folder ID"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Folder not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1folders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/get/responses/400/content/application~1json/examples/Invalid folder ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/get/responses/400/content/application~1json/examples/Invalid folder ID"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/retrievefolder"}],"panels":[]}]},"httpPath":"/folders/{id}"},{"label":"Update a folder","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/folders/updatefolder","routeSlug":"/docs/references/rest-api/api.intercom.io/folders/updatefolder","metadata":{"seo":{"title":"Update a folder","description":"You can update a folder by making a PUT request to https://api.intercom.io/folders/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFolder","name":"Update a folder","isWebhook":false,"pointer":"/paths/~1folders~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a folder by making a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/folders/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields you leave out keep their current values. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_folder_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move the folder to the top level. Folder names longer than 191 characters are truncated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the folder","required":true,"example":6}],"pointer":"/paths/~1folders~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1folders~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1257","exampleIds":["paths/~1folders~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_1257","exampleIds":["paths/~1folders~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1folders~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/folders/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":6,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1257","exampleIds":["paths/~1folders~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/folders/{id}","href":"folders/updatefolder","openApiOperationId":"updateFolder","summary":"Update a folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1257","exampleIds":["paths/~1folders~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1257","exampleIds":["paths/~1folders~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"folder updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad request, for example an invalid folder ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/put/responses/400/content/application~1json/examples/Invalid folder ID"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/put/responses/400/content/application~1json/examples/Invalid folder ID"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Folder not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1folders~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/folder","exampleIds":["paths/~1folders~1{id}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/put/responses/400/content/application~1json/examples/Invalid folder ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/put/responses/400/content/application~1json/examples/Invalid folder ID"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/updatefolder"}],"panels":[]}]},"httpPath":"/folders/{id}"},{"label":"Delete a folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/folders/deletefolder","routeSlug":"/docs/references/rest-api/api.intercom.io/folders/deletefolder","metadata":{"seo":{"title":"Delete a folder","description":"You can delete a folder (if it contains no content) by making a DELETE request to https://api.intercom.io/folders/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFolder","name":"Delete a folder","isWebhook":false,"pointer":"/paths/~1folders~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a folder (if it contains no content) by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/folders/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the folder","required":true,"example":6}],"pointer":"/paths/~1folders~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1folders~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/folders/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":6,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","422"],"pointer":"/folders/{id}","href":"folders/deletefolder","openApiOperationId":"deleteFolder","summary":"Delete a folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"folder deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_folder_object","exampleIds":["paths/~1folders~1{id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/deleted_folder_object","exampleIds":["paths/~1folders~1{id}/delete/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid folder ID, or the folder is synced from an external source and cannot be deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Invalid folder ID","paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Synced folder"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Invalid folder ID","paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Synced folder"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"404","description":"Folder not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"422","description":"Folder contains content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1folders~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_folder_object","exampleIds":["paths/~1folders~1{id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_folder_object","exampleIds":["paths/~1folders~1{id}/delete/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Invalid folder ID","paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Synced folder"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Invalid folder ID","paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Synced folder"]}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"404","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/folders/deletefolder"}],"panels":[]}]},"httpPath":"/folders/{id}"},{"type":"link","label":"Folder","link":"/docs/references/rest-api/api.intercom.io/folders/folder","routeSlug":"/docs/references/rest-api/api.intercom.io/folders/folder","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"folder"},"seo":{"title":"Folder"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Folder","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/folder"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Folders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Folders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Folder","link":"/folders/folder","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/folders","summary":"List all folders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folders/listfolders","deprecated":false},{"title":"/folders","summary":"Create a folder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/folders/createfolder","deprecated":false},{"title":"/folders/{id}","summary":"Retrieve a folder","prefix":{"name":"get","color":"get"},"badges":[],"link":"/folders/retrievefolder","deprecated":false},{"title":"/folders/{id}","summary":"Update a folder","prefix":{"name":"put","color":"put"},"badges":[],"link":"/folders/updatefolder","deprecated":false},{"title":"/folders/{id}","summary":"Delete a folder","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/folders/deletefolder","deprecated":false}]}]}]}]}},{"type":"group","label":"Help Center","link":"/docs/references/rest-api/api.intercom.io/help-center","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center","items":[{"label":"List all redirects for a help center","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/listhelpcenterredirects","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/listhelpcenterredirects","metadata":{"seo":{"title":"List all redirects for a help center","description":"You can fetch a list of all URL redirects for a help center by making a GET request to https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listHelpCenterRedirects","name":"List all redirects for a help center","isWebhook":false,"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all redirects for a help center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all URL redirects for a help center by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redirects are returned in ascending alphabetical order of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_help_center_redirects_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"help_center_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the help center.","required":true,"example":"123"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":"The number of results to return per page. Defaults to 50, maximum 250.","example":50}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/help_centers/{help_center_id}/redirects","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"help_center_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/help_centers/{help_center_id}/redirects","href":"help-center/listhelpcenterredirects","openApiOperationId":"listHelpCenterRedirects","summary":"List all redirects for a help center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_redirect_list","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/help_center_redirect_list","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Help center not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/404/content/application~1json/examples/Not Found"]}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/help_center_redirect_list","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_redirect_list","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/404/content/application~1json/examples/Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/listhelpcenterredirects"}],"panels":[]}]},"httpPath":"/help_center/help_centers/{help_center_id}/redirects"},{"label":"Create a redirect","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/createhelpcenterredirect","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/createhelpcenterredirect","metadata":{"seo":{"title":"Create a redirect","description":"You can create a new URL redirect by making a POST request to https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createHelpCenterRedirect","name":"Create a redirect","isWebhook":false,"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a redirect","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new URL redirect by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_help_center_redirects_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"help_center_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the help center.","required":true,"example":"123"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_help_center_redirect_request","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created"]}},"schemaId":"components/schemas/create_help_center_redirect_request","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created"],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/help_center/help_centers/{help_center_id}/redirects","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"help_center_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_help_center_redirect_request","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created"]}},"responseCodes":["200","400","401","404","409","422"],"pointer":"/help_center/help_centers/{help_center_id}/redirects","href":"help-center/createhelpcenterredirect","openApiOperationId":"createHelpCenterRedirect","summary":"Create a redirect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_help_center_redirect_request","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_help_center_redirect_request","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"redirect created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/200/content/application~1json/examples/redirect created"]}},"schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/200/content/application~1json/examples/redirect created"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Invalid target_type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Invalid target_type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Help center not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/404/content/application~1json/examples/Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/409/content/application~1json/examples/Conflict"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Help center target mismatch"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Help center target mismatch"]}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/200/content/application~1json/examples/redirect created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/200/content/application~1json/examples/redirect created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Invalid target_type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Missing parameter","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Invalid target_type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/404/content/application~1json/examples/Not Found"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Help center target mismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data","paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Help center target mismatch"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/createhelpcenterredirect"}],"panels":[]}]},"httpPath":"/help_center/help_centers/{help_center_id}/redirects"},{"label":"Retrieve a redirect","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/retrievehelpcenterredirect","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/retrievehelpcenterredirect","metadata":{"seo":{"title":"Retrieve a redirect","description":"You can fetch the details of a single redirect by making a GET request to https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveHelpCenterRedirect","name":"Retrieve a redirect","isWebhook":false,"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a redirect","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single redirect by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_help_center_redirects_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"help_center_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the help center.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the redirect.","required":true,"example":"26"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/help_centers/{help_center_id}/redirects/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"help_center_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"26","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/help_centers/{help_center_id}/redirects/{id}","href":"help-center/retrievehelpcenterredirect","openApiOperationId":"retrieveHelpCenterRedirect","summary":"Retrieve a redirect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/404/content/application~1json/examples/Not Found"]}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_redirect","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/404/content/application~1json/examples/Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/retrievehelpcenterredirect"}],"panels":[]}]},"httpPath":"/help_center/help_centers/{help_center_id}/redirects/{id}"},{"label":"Delete a redirect","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/deletehelpcenterredirect","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/deletehelpcenterredirect","metadata":{"seo":{"title":"Delete a redirect","description":"You can delete a single redirect by making a DELETE request to https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteHelpCenterRedirect","name":"Delete a redirect","isWebhook":false,"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a redirect","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single redirect by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/help_centers/{help_center_id}/redirects/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_help_center_redirects_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"help_center_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the help center.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the redirect.","required":true,"example":"26"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/help_center/help_centers/{help_center_id}/redirects/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"help_center_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"26","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/help_centers/{help_center_id}/redirects/{id}","href":"help-center/deletehelpcenterredirect","openApiOperationId":"deleteHelpCenterRedirect","summary":"Delete a redirect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"redirect deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_help_center_redirect_object","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/200/content/application~1json/examples/redirect deleted"]}},"schemaId":"components/schemas/deleted_help_center_redirect_object","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/200/content/application~1json/examples/redirect deleted"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/404/content/application~1json/examples/Not Found"]}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_help_center_redirect_object","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/200/content/application~1json/examples/redirect deleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_help_center_redirect_object","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/200/content/application~1json/examples/redirect deleted"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/404/content/application~1json/examples/Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/deletehelpcenterredirect"}],"panels":[]}]},"httpPath":"/help_center/help_centers/{help_center_id}/redirects/{id}"},{"label":"List all collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/listallcollections","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/listallcollections","metadata":{"seo":{"title":"List all collections","description":"You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllCollections","name":"List all collections","isWebhook":false,"pointer":"/paths/~1help_center~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all collections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all collections by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_1162","description":"The number of results to return per page. Defaults to 20. Maximum is 250.","example":20},{"name":"help_center_id","in":"query","schemaId":"schema_1150","description":"Only return collections that belong to this Help Center.","example":123}],"pointer":"/paths/~1help_center~1collections/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1collections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/collections","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":20,"schemaId":"schema_1162"},{"name":"help_center_id","in":"query","required":false,"example":123,"schemaId":"schema_1150"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/help_center/collections","href":"help-center/listallcollections","openApiOperationId":"listAllCollections","summary":"List all collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection_list","exampleIds":["paths/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/collection_list","exampleIds":["paths/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Per page too large","paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Invalid help center"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Per page too large","paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Invalid help center"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1help_center~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection_list","exampleIds":["paths/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection_list","exampleIds":["paths/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Per page too large","paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Invalid help center"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Per page too large","paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Invalid help center"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/listallcollections"}],"panels":[]}]},"httpPath":"/help_center/collections"},{"label":"Create a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/createcollection","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/createcollection","metadata":{"seo":{"title":"Create a collection","description":"You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCollection","name":"Create a collection","isWebhook":false,"pointer":"/paths/~1help_center~1collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new collection by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1collections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_collection_request","exampleIds":["paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created","paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request"]}},"schemaId":"components/schemas/create_collection_request","exampleIds":["paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created","paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request"],"pointer":"/paths/~1help_center~1collections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/help_center/collections","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_collection_request","exampleIds":["paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created","paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request"]}},"responseCodes":["200","400","401"],"pointer":"/help_center/collections","href":"help-center/createcollection","openApiOperationId":"createCollection","summary":"Create a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_collection_request","exampleIds":["paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created","paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_collection_request","exampleIds":["paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created","paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"collection created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections/post/responses/200/content/application~1json/examples/collection created"]}},"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections/post/responses/200/content/application~1json/examples/collection created"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Invalid help center","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Parent collection not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Invalid help center","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Parent collection not found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1help_center~1collections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections/post/responses/200/content/application~1json/examples/collection created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections/post/responses/200/content/application~1json/examples/collection created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Invalid help center","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Parent collection not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Invalid help center","paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Parent collection not found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/createcollection"}],"panels":[]}]},"httpPath":"/help_center/collections"},{"label":"Retrieve a collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/retrievecollection","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/retrievecollection","metadata":{"seo":{"title":"Retrieve a collection","description":"You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveCollection","name":"Retrieve a collection","isWebhook":false,"pointer":"/paths/~1help_center~1collections~1{collection_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single collection by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/collections/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collection_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/collections/{collection_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"collection_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/collections/{collection_id}","href":"help-center/retrievecollection","openApiOperationId":"retrieveCollection","summary":"Retrieve a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Collection found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/200/content/application~1json/examples/Collection found"]}},"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/200/content/application~1json/examples/Collection found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Collection not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/404/content/application~1json/examples/Collection not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/404/content/application~1json/examples/Collection not found"]}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/200/content/application~1json/examples/Collection found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/200/content/application~1json/examples/Collection found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/404/content/application~1json/examples/Collection not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/get/responses/404/content/application~1json/examples/Collection not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/retrievecollection"}],"panels":[]}]},"httpPath":"/help_center/collections/{collection_id}"},{"label":"Update a collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/updatecollection","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/updatecollection","metadata":{"seo":{"title":"Update a collection","description":"You can update the details of a single collection by making a PUT request to https://api.intercom.io/help_center/collections/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCollection","name":"Update a collection","isWebhook":false,"pointer":"/paths/~1help_center~1collections~1{collection_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update the details of a single collection by making a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/collections/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is checked but never applied. It must match the help center of the collection's articles and sub-collections, or the request returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A collection with no content rejects any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so leave it out. Moving a collection to another help center isn't supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collection_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_collection_request","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found"]}},"schemaId":"components/schemas/update_collection_request","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found"],"pointer":"/paths/~1help_center~1collections~1{collection_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/help_center/collections/{collection_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"collection_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_collection_request","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/help_center/collections/{collection_id}","href":"help-center/updatecollection","openApiOperationId":"updateCollection","summary":"Update a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_collection_request","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_collection_request","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Help center mismatch","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Parent collection not found","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Unsupported locale"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Help center mismatch","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Parent collection not found","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Unsupported locale"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Collection Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/404/content/application~1json/examples/Collection Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/404/content/application~1json/examples/Collection Not Found"]}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Help center mismatch","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Parent collection not found","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Unsupported locale"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Help center mismatch","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Parent collection not found","paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Unsupported locale"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/404/content/application~1json/examples/Collection Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/put/responses/404/content/application~1json/examples/Collection Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/updatecollection"}],"panels":[]}]},"httpPath":"/help_center/collections/{collection_id}"},{"label":"Delete a collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/deletecollection","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/deletecollection","metadata":{"seo":{"title":"Delete a collection","description":"You can delete a single collection by making a DELETE request to https://api.intercom.io/help_center/collections/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCollection","name":"Delete a collection","isWebhook":false,"pointer":"/paths/~1help_center~1collections~1{collection_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single collection by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/collections/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collection_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/help_center/collections/{collection_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"collection_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/collections/{collection_id}","href":"help-center/deletecollection","openApiOperationId":"deleteCollection","summary":"Delete a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_collection_object","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_collection_object","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"collection Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/404/content/application~1json/examples/collection Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/404/content/application~1json/examples/collection Not Found"]}],"pointer":"/paths/~1help_center~1collections~1{collection_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_collection_object","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_collection_object","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/404/content/application~1json/examples/collection Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{collection_id}/delete/responses/404/content/application~1json/examples/collection Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/deletecollection"}],"panels":[]}]},"httpPath":"/help_center/collections/{collection_id}"},{"label":"Retrieve a Help Center","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/retrievehelpcenter","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/retrievehelpcenter","metadata":{"seo":{"title":"Retrieve a Help Center","description":"You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_centers/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveHelpCenter","name":"Retrieve a Help Center","isWebhook":false,"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Help Center","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single Help Center by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/help_centers/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"help_center_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the Help Center which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/help_centers/{help_center_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"help_center_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/help_centers/{help_center_id}","href":"help-center/retrievehelpcenter","openApiOperationId":"retrieveHelpCenter","summary":"Retrieve a Help Center"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Help Center found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Help Center found"]}},"schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Help Center found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Help Center not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Help Center not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Help Center not found"]}],"pointer":"/paths/~1help_center~1help_centers~1{help_center_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Help Center found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Help Center found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Help Center not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Help Center not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/retrievehelpcenter"}],"panels":[]}]},"httpPath":"/help_center/help_centers/{help_center_id}"},{"label":"List all Help Centers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/help-center/listhelpcenters","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/listhelpcenters","metadata":{"seo":{"title":"List all Help Centers","description":"You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listHelpCenters","name":"List all Help Centers","isWebhook":false,"pointer":"/paths/~1help_center~1help_centers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Help Centers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can list all Help Centers by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/help_centers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1help_center~1help_centers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/help_centers","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/help_center/help_centers","href":"help-center/listhelpcenters","openApiOperationId":"listHelpCenters","summary":"List all Help Centers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Help Centers found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_list","exampleIds":["paths/~1help_center~1help_centers/get/responses/200/content/application~1json/examples/Help Centers found"]}},"schemaId":"components/schemas/help_center_list","exampleIds":["paths/~1help_center~1help_centers/get/responses/200/content/application~1json/examples/Help Centers found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1help_center~1help_centers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/help_center_list","exampleIds":["paths/~1help_center~1help_centers/get/responses/200/content/application~1json/examples/Help Centers found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/help_center_list","exampleIds":["paths/~1help_center~1help_centers/get/responses/200/content/application~1json/examples/Help Centers found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/listhelpcenters"}],"panels":[]}]},"httpPath":"/help_center/help_centers"},{"type":"link","label":"Collection","link":"/docs/references/rest-api/api.intercom.io/help-center/collection","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/collection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"collection"},"seo":{"title":"Collection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/collection"},"children":[]}]}]}},{"type":"link","label":"Help Center","link":"/docs/references/rest-api/api.intercom.io/help-center/help_center","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/help_center","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"help_center"},"seo":{"title":"Help Center"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Help Center","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/help_center"},"children":[]}]}]}},{"type":"link","label":"Help Centers","link":"/docs/references/rest-api/api.intercom.io/help-center/help_center_list","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/help_center_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"help_center_list"},"seo":{"title":"Help Centers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Help Centers","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/help_center_list"},"children":[]}]}]}},{"type":"link","label":"Help Center Redirect","link":"/docs/references/rest-api/api.intercom.io/help-center/help_center_redirect","routeSlug":"/docs/references/rest-api/api.intercom.io/help-center/help_center_redirect","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"help_center_redirect"},"seo":{"title":"Help Center Redirect"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Help Center Redirect","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/help_center_redirect"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Help Center"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Help Center","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Help Center"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Collection","link":"/help-center/collection","deprecated":false},{"title":"Help Center","link":"/help-center/help_center","deprecated":false},{"title":"Help Centers","link":"/help-center/help_center_list","deprecated":false},{"title":"Help Center Redirect","link":"/help-center/help_center_redirect","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/help_center/help_centers/{help_center_id}/redirects","summary":"List all redirects for a help center","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/listhelpcenterredirects","deprecated":false},{"title":"/help_center/help_centers/{help_center_id}/redirects","summary":"Create a redirect","prefix":{"name":"post","color":"post"},"badges":[],"link":"/help-center/createhelpcenterredirect","deprecated":false},{"title":"/help_center/help_centers/{help_center_id}/redirects/{id}","summary":"Retrieve a redirect","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/retrievehelpcenterredirect","deprecated":false},{"title":"/help_center/help_centers/{help_center_id}/redirects/{id}","summary":"Delete a redirect","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/help-center/deletehelpcenterredirect","deprecated":false},{"title":"/help_center/collections","summary":"List all collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/listallcollections","deprecated":false},{"title":"/help_center/collections","summary":"Create a collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/help-center/createcollection","deprecated":false},{"title":"/help_center/collections/{collection_id}","summary":"Retrieve a collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/retrievecollection","deprecated":false},{"title":"/help_center/collections/{collection_id}","summary":"Update a collection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/help-center/updatecollection","deprecated":false},{"title":"/help_center/collections/{collection_id}","summary":"Delete a collection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/help-center/deletecollection","deprecated":false},{"title":"/help_center/help_centers/{help_center_id}","summary":"Retrieve a Help Center","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/retrievehelpcenter","deprecated":false},{"title":"/help_center/help_centers","summary":"List all Help Centers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/listhelpcenters","deprecated":false}]}]}]}]}},{"type":"group","label":"Internal Articles","link":"/docs/references/rest-api/api.intercom.io/internal-articles","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles","items":[{"label":"List all articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/listinternalarticles","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/listinternalarticles","metadata":{"seo":{"title":"List all articles","description":"You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInternalArticles","name":"List all articles","isWebhook":false,"pointer":"/paths/~1internal_articles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all articles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all internal articles by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/internal_articles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1205","description":"The page of results to fetch. Defaults to 1."},{"name":"per_page","in":"query","schemaId":"schema_1254","description":"The number of results to return per page. Defaults to 50."}],"pointer":"/paths/~1internal_articles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/internal_articles","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1205"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1254"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/internal_articles","href":"internal-articles/listinternalarticles","openApiOperationId":"listInternalArticles","summary":"List all articles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successful. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned as strings when you send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request, and as integers otherwise."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article_list","exampleIds":["paths/~1internal_articles/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/internal_article_list","exampleIds":["paths/~1internal_articles/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1internal_articles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/internal_article_list","exampleIds":["paths/~1internal_articles/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article_list","exampleIds":["paths/~1internal_articles/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/listinternalarticles"}],"panels":[]}]},"httpPath":"/internal_articles"},{"label":"Create an internal article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/createinternalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/createinternalarticle","metadata":{"seo":{"title":"Create an internal article","description":"You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInternalArticle","name":"Create an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new internal article by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/internal_articles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_internal_article_request","exampleIds":["paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created","paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters"]}},"schemaId":"components/schemas/create_internal_article_request","exampleIds":["paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created","paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters"],"pointer":"/paths/~1internal_articles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/internal_articles","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_internal_article_request","exampleIds":["paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created","paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/internal_articles","href":"internal-articles/createinternalarticle","openApiOperationId":"createInternalArticle","summary":"Create an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_internal_article_request","exampleIds":["paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created","paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_internal_article_request","exampleIds":["paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created","paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"internal article created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles/post/responses/200/content/application~1json/examples/internal article created"]}},"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles/post/responses/200/content/application~1json/examples/internal article created"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request. The request body is empty, in which case the response has no body, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an array of integers"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids contains a non-integer"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids contains a non-integer"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Teammate, folder or audience ID not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Unknown audience IDs"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing required parameters, body_markdown sent with body or json_blocks, or an ai_*_availability value that is not a boolean"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/422/content/application~1json/examples/Missing required parameters","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Non-boolean availability flag"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/422/content/application~1json/examples/Missing required parameters","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Non-boolean availability flag"]}],"pointer":"/paths/~1internal_articles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles/post/responses/200/content/application~1json/examples/internal article created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles/post/responses/200/content/application~1json/examples/internal article created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids contains a non-integer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids contains a non-integer"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Unknown audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles/post/responses/404/content/application~1json/examples/Unknown audience IDs"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/422/content/application~1json/examples/Missing required parameters","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Non-boolean availability flag"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/422/content/application~1json/examples/Missing required parameters","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles/post/responses/422/content/application~1json/examples/Non-boolean availability flag"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/createinternalarticle"}],"panels":[]}]},"httpPath":"/internal_articles"},{"label":"Retrieve an internal article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/retrieveinternalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/retrieveinternalarticle","metadata":{"seo":{"title":"Retrieve an internal article","description":"You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveInternalArticle","name":"Retrieve an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single internal article by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/internal_articles/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/internal_articles/{internal_article_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/internal_articles/{internal_article_id}","href":"internal-articles/retrieveinternalarticle","openApiOperationId":"retrieveInternalArticle","summary":"Retrieve an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Internal article found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/200/content/application~1json/examples/Internal article found"]}},"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/200/content/application~1json/examples/Internal article found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Internal article not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/404/content/application~1json/examples/Internal article not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/404/content/application~1json/examples/Internal article not found"]},{"code":"422","description":"Invalid article ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/422/content/application~1json/examples/Invalid article ID"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/422/content/application~1json/examples/Invalid article ID"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/200/content/application~1json/examples/Internal article found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/200/content/application~1json/examples/Internal article found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/404/content/application~1json/examples/Internal article not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/404/content/application~1json/examples/Internal article not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/422/content/application~1json/examples/Invalid article ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/get/responses/422/content/application~1json/examples/Invalid article ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/retrieveinternalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}"},{"label":"Update an internal article","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/updateinternalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/updateinternalarticle","metadata":{"seo":{"title":"Update an internal article","description":"You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInternalArticle","name":"Update an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update the details of a single internal article by making a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/internal_articles/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields you leave out keep their current values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_internal_article_request","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found"]}},"schemaId":"components/schemas/update_internal_article_request","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found"],"pointer":"/paths/~1internal_articles~1{internal_article_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/internal_articles/{internal_article_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_internal_article_request","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/internal_articles/{internal_article_id}","href":"internal-articles/updateinternalarticle","openApiOperationId":"updateInternalArticle","summary":"Update an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_internal_article_request","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_internal_article_request","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful","paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request. The request body is empty, in which case the response has no body, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an array of integers"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids contains a non-integer"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids contains a non-integer"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Internal article, teammate, folder or audience ID not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body_markdown sent with body or json_blocks, an ai_*_availability value that is not a boolean, or the article is in a release running a live experiment"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Non-boolean availability flag","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Non-boolean availability flag","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids contains a non-integer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids is not an array","paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids contains a non-integer"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Teammate not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Folder not found","paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Non-boolean availability flag","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Non-boolean availability flag","paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/updateinternalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}"},{"label":"Delete an internal article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/deleteinternalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/deleteinternalarticle","metadata":{"seo":{"title":"Delete an internal article","description":"You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInternalArticle","name":"Delete an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single internal article by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/internal_articles/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/internal_articles/{internal_article_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/internal_articles/{internal_article_id}","href":"internal-articles/deleteinternalarticle","openApiOperationId":"deleteInternalArticle","summary":"Delete an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_internal_article_object","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_internal_article_object","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Internal article not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/404/content/application~1json/examples/Internal article not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/404/content/application~1json/examples/Internal article not found"]},{"code":"422","description":"Invalid article ID, or the article is in a release running a live experiment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Invalid article ID","paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Invalid article ID","paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_internal_article_object","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_internal_article_object","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/404/content/application~1json/examples/Internal article not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/404/content/application~1json/examples/Internal article not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Invalid article ID","paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Invalid article ID","paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/deleteinternalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}"},{"label":"Add a tag to an internal article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/attachtagtointernalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/attachtagtointernalarticle","metadata":{"seo":{"title":"Add a tag to an internal article","description":"Apply an existing tag to an internal article. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToInternalArticle","name":"Add a tag to an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to an internal article. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/internal_articles/{internal_article_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/internal_articles/{internal_article_id}/tags","href":"internal-articles/attachtagtointernalarticle","openApiOperationId":"attachTagToInternalArticle","summary":"Add a tag to an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Internal article, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/attachtagtointernalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}/tags"},{"label":"Remove a tag from an internal article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/detachtagfrominternalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/detachtagfrominternalarticle","metadata":{"seo":{"title":"Remove a tag from an internal article","description":"Remove a tag from an internal article. Returns the tag that was removed, withnull applied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromInternalArticle","name":"Remove a tag from an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from an internal article. Returns the tag that was removed, with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"admin_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional id of a teammate. The id is checked, and an unknown teammate returns a 404 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error, but the removal is not recorded against the teammate."},"children":[]}]}]}],"example":"1234"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/internal_articles/{internal_article_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[{"name":"admin_id","in":"query","required":false,"example":"1234","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/internal_articles/{internal_article_id}/tags/{id}","href":"internal-articles/detachtagfrominternalarticle","openApiOperationId":"detachTagFromInternalArticle","summary":"Remove a tag from an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Internal article, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/detachtagfrominternalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}/tags/{id}"},{"label":"Search for internal articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/internal-articles/searchinternalarticles","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/searchinternalarticles","metadata":{"seo":{"title":"Search for internal articles","description":"You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchInternalArticles","name":"Search for internal articles","isWebhook":false,"pointer":"/paths/~1internal_articles~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for internal articles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for internal articles by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/internal_articles/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"folder_id","in":"query","schemaId":"schema_1150","description":"The ID of the folder to search in. Results will include articles from this folder and all its descendant folders. If omitted or blank, the response is an empty list.","example":123},{"name":"page","in":"query","schemaId":"schema_1205","description":"The page of results to fetch. Defaults to 1."},{"name":"per_page","in":"query","schemaId":"schema_1258","description":"The number of results to return per page. Defaults to 10."}],"pointer":"/paths/~1internal_articles~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/internal_articles/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"folder_id","in":"query","required":false,"example":123,"schemaId":"schema_1150"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1205"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_1258"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/internal_articles/search","href":"internal-articles/searchinternalarticles","openApiOperationId":"searchInternalArticles","summary":"Search for internal articles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article_search_response","exampleIds":["paths/~1internal_articles~1search/get/responses/200/content/application~1json/examples/Search successful"]}},"schemaId":"components/schemas/internal_article_search_response","exampleIds":["paths/~1internal_articles~1search/get/responses/200/content/application~1json/examples/Search successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Folder not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/404/content/application~1json/examples/Folder not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/404/content/application~1json/examples/Folder not found"]}],"pointer":"/paths/~1internal_articles~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/internal_article_search_response","exampleIds":["paths/~1internal_articles~1search/get/responses/200/content/application~1json/examples/Search successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/internal_article_search_response","exampleIds":["paths/~1internal_articles~1search/get/responses/200/content/application~1json/examples/Search successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/404/content/application~1json/examples/Folder not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1search/get/responses/404/content/application~1json/examples/Folder not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-articles/searchinternalarticles"}],"panels":[]}]},"httpPath":"/internal_articles/search"},{"type":"link","label":"Internal Articles","link":"/docs/references/rest-api/api.intercom.io/internal-articles/internal_article_list_item","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/internal_article_list_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"internal_article_list_item"},"seo":{"title":"Internal Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal Articles","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/internal_article_list_item"},"children":[]}]}]}},{"type":"link","label":"Internal Article Search Response","link":"/docs/references/rest-api/api.intercom.io/internal-articles/internal_article_search_response","routeSlug":"/docs/references/rest-api/api.intercom.io/internal-articles/internal_article_search_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"internal_article_search_response"},"seo":{"title":"Internal Article Search Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal Article Search Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/internal_article_search_response"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Internal Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal Articles","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Internal Articles"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Internal Articles","link":"/internal-articles/internal_article_list_item","deprecated":false},{"title":"Internal Article Search Response","link":"/internal-articles/internal_article_search_response","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/internal_articles","summary":"List all articles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal-articles/listinternalarticles","deprecated":false},{"title":"/internal_articles","summary":"Create an internal article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal-articles/createinternalarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}","summary":"Retrieve an internal article","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal-articles/retrieveinternalarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}","summary":"Update an internal article","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal-articles/updateinternalarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}","summary":"Delete an internal article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/internal-articles/deleteinternalarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}/tags","summary":"Add a tag to an internal article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal-articles/attachtagtointernalarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}/tags/{id}","summary":"Remove a tag from an internal article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/internal-articles/detachtagfrominternalarticle","deprecated":false},{"title":"/internal_articles/search","summary":"Search for internal articles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal-articles/searchinternalarticles","deprecated":false}]}]}]}]}},{"type":"group","label":"IP Allowlist","link":"/docs/references/rest-api/api.intercom.io/ip-allowlist","routeSlug":"/docs/references/rest-api/api.intercom.io/ip-allowlist","items":[{"label":"Get IP allowlist settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ip-allowlist/getipallowlist","routeSlug":"/docs/references/rest-api/api.intercom.io/ip-allowlist/getipallowlist","metadata":{"seo":{"title":"Get IP allowlist settings","description":"Retrieve the current IP allowlist configuration for the workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIpAllowlist","name":"Get IP allowlist settings","isWebhook":false,"pointer":"/paths/~1ip_allowlist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get IP allowlist settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the current IP allowlist configuration for the workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_ip_allowlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ip_allowlist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ip_allowlist","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/ip_allowlist","href":"ip-allowlist/getipallowlist","openApiOperationId":"getIpAllowlist","summary":"Get IP allowlist settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1ip_allowlist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-allowlist/getipallowlist"}],"panels":[]}]},"httpPath":"/ip_allowlist"},{"label":"Update IP allowlist settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ip-allowlist/updateipallowlist","routeSlug":"/docs/references/rest-api/api.intercom.io/ip-allowlist/updateipallowlist","metadata":{"seo":{"title":"Update IP allowlist settings","description":"Update the IP allowlist configuration for the workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateIpAllowlist","name":"Update IP allowlist settings","isWebhook":false,"pointer":"/paths/~1ip_allowlist/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update IP allowlist settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the IP allowlist configuration for the workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_allowlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional. A field you omit is left unchanged, and a request with neither returns the current settings without changing anything. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a field is the same as omitting it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every non-blank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_allowlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry must be an IPv4 address or an IPv4 range in CIDR notation. Blank entries are ignored and surrounding whitespace is trimmed. Any other entry, including an IPv6 address, returns a 422 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the update leaves the allowlist enabled with at least one entry, the request must come from an IPv4 address that is on the list. A request from an IPv6 address can never match an IPv4 allowlist, so it returns the lockout 422 below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_ip_allowlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Lockout Protection"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ip_allowlist/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ip_allowlist/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ip_allowlist","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","422"],"pointer":"/ip_allowlist","href":"ip-allowlist/updateipallowlist","openApiOperationId":"updateIpAllowlist","summary":"Update IP allowlist settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/422/content/application~1json/examples/Lockout Protection"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/422/content/application~1json/examples/Lockout Protection"]}],"pointer":"/paths/~1ip_allowlist/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ip_allowlist","exampleIds":["paths/~1ip_allowlist/put/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/422/content/application~1json/examples/Lockout Protection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/422/content/application~1json/examples/Lockout Protection"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-allowlist/updateipallowlist"}],"panels":[]}]},"httpPath":"/ip_allowlist"}],"content":{"contentType":"group","meta":{"name":"IP Allowlist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Allowlist","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage IP allowlist settings for your workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP Allowlist API allows you to configure which IP addresses teammates can use your workspace from, in the web app and mobile apps. This is useful for restricting teammate access to specific corporate networks or VPNs. It doesn't apply to REST API requests, which use a separate REST API allowlist that this API doesn't manage."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Authentication"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_ip_allowlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ip_allowlist","summary":"Get IP allowlist settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-allowlist/getipallowlist","deprecated":false},{"title":"/ip_allowlist","summary":"Update IP allowlist settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ip-allowlist/updateipallowlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Jobs","link":"/docs/references/rest-api/api.intercom.io/jobs","routeSlug":"/docs/references/rest-api/api.intercom.io/jobs","items":[{"label":"Retrieve job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/jobs/jobsstatus","routeSlug":"/docs/references/rest-api/api.intercom.io/jobs/jobsstatus","metadata":{"seo":{"title":"Retrieve job status","description":"Retrieve the status of job execution."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobsStatus","name":"Retrieve job status","isWebhook":false,"pointer":"/paths/~1jobs~1status~1{job_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the status of job execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned only once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". While the job is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" both keys are left out of the response rather than returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the job which is given by Intercom","required":true}],"pointer":"/paths/~1jobs~1status~1{job_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1jobs~1status~1{job_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/jobs/status/{job_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"job_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/jobs/status/{job_id}","href":"jobs/jobsstatus","openApiOperationId":"jobsStatus","summary":"Retrieve job status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job execution status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/jobs","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved","paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job still pending"]}},"schemaId":"components/schemas/jobs","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved","paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job still pending"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/404/content/application~1json/examples/Job not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/404/content/application~1json/examples/Job not found"]}],"pointer":"/paths/~1jobs~1status~1{job_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/jobs","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved","paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job still pending"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/jobs","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved","paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job still pending"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/404/content/application~1json/examples/Job not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/404/content/application~1json/examples/Job not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobsstatus"}],"panels":[]}]},"httpPath":"/jobs/status/{job_id}"},{"type":"link","label":"Jobs","link":"/docs/references/rest-api/api.intercom.io/jobs/jobs","routeSlug":"/docs/references/rest-api/api.intercom.io/jobs/jobs","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"jobs"},"seo":{"title":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/jobs"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"Everything about jobs"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Jobs","link":"/jobs/jobs","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/jobs/status/{job_id}","summary":"Retrieve job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/jobsstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Macros","link":"/docs/references/rest-api/api.intercom.io/macros","routeSlug":"/docs/references/rest-api/api.intercom.io/macros","items":[{"label":"Retrieve a macro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/macros/getmacro","routeSlug":"/docs/references/rest-api/api.intercom.io/macros/getmacro","metadata":{"seo":{"title":"Retrieve a macro","description":"You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMacro","name":"Retrieve a macro","isWebhook":false,"pointer":"/paths/~1macros~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a macro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A macro is returned based on its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Always visible to all team members"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specific_teams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only visible if the authenticated user belongs to one of the teams specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible_to_team_ids"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a macro exists but is not visible to the authenticated user, a 404 error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder Transformation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API transforms Intercom placeholders to a more standard XML-like format in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{user.name | fallback: 'there'}}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<attribute key=\"user.name\" default=\"there\"/>"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default values in placeholders are HTML-escaped for security."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the macro","required":true,"example":"123"}],"pointer":"/paths/~1macros~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1macros~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/macros/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/macros/{id}","href":"macros/getmacro","openApiOperationId":"getMacro","summary":"Retrieve a macro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Macro found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/macro","exampleIds":["paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/support_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/sales_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/technical_support","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/simple_greeting"]}},"schemaId":"components/schemas/macro","exampleIds":["paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/support_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/sales_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/technical_support","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/simple_greeting"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden - missing required OAuth scope","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/403/content/application~1json/examples/Missing required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/403/content/application~1json/examples/Missing required scope"]},{"code":"404","description":"Macro not found or not accessible","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/404/content/application~1json/examples/Macro not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/404/content/application~1json/examples/Macro not found"]}],"pointer":"/paths/~1macros~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/macro","exampleIds":["paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/support_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/sales_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/technical_support","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/simple_greeting"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/macro","exampleIds":["paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/support_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/sales_macro","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/technical_support","paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/simple_greeting"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/403/content/application~1json/examples/Missing required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/403/content/application~1json/examples/Missing required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/404/content/application~1json/examples/Macro not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros~1{id}/get/responses/404/content/application~1json/examples/Macro not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/macros/getmacro"}],"panels":[]}]},"httpPath":"/macros/{id}"},{"label":"List all macros","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/macros/listmacros","routeSlug":"/docs/references/rest-api/api.intercom.io/macros/listmacros","metadata":{"seo":{"title":"List all macros","description":"You can fetch a list of all macros (saved replies) in your workspace for use in automating responses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMacros","name":"List all macros","isWebhook":false,"pointer":"/paths/~1macros/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all macros","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all macros (saved replies) in your workspace for use in automating responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The macros are returned in descending order by updated_at."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses cursor-based pagination via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The cursor is a Base64-encoded JSON array containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[updated_at, id]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the last item from the previous page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Placeholder Transformation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API transforms Intercom placeholders to a more standard XML-like format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{user.name | fallback: 'there'}}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<attribute key=\"user.name\" default=\"there\"/>"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_1160","description":"The number of results per page","example":50},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded cursor containing [updated_at, id] for pagination"},"children":[]}]}]}],"example":"WzE3MTk0OTM3NTcuMCwgIjEyMyJd"},{"name":"updated_since","in":"query","schemaId":"schema_1232","description":"Unix timestamp to filter macros updated after this time","example":1719474966}],"pointer":"/paths/~1macros/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1macros/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/macros","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","example":50,"schemaId":"schema_1160"},{"name":"starting_after","in":"query","example":"WzE3MTk0OTM3NTcuMCwgIjEyMyJd","schemaId":"schema_1152"},{"name":"updated_since","in":"query","example":1719474966,"schemaId":"schema_1232"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/macros","href":"macros/listmacros","openApiOperationId":"listMacros","summary":"List all macros"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/macro_list","exampleIds":["paths/~1macros/get/responses/200/content/application~1json/examples/basic_list","paths/~1macros/get/responses/200/content/application~1json/examples/pagination_with_cursor","paths/~1macros/get/responses/200/content/application~1json/examples/filtered_by_timestamp","paths/~1macros/get/responses/200/content/application~1json/examples/complex_placeholders","paths/~1macros/get/responses/200/content/application~1json/examples/empty_result","paths/~1macros/get/responses/200/content/application~1json/examples/large_list_preview"]}},"schemaId":"components/schemas/macro_list","exampleIds":["paths/~1macros/get/responses/200/content/application~1json/examples/basic_list","paths/~1macros/get/responses/200/content/application~1json/examples/pagination_with_cursor","paths/~1macros/get/responses/200/content/application~1json/examples/filtered_by_timestamp","paths/~1macros/get/responses/200/content/application~1json/examples/complex_placeholders","paths/~1macros/get/responses/200/content/application~1json/examples/empty_result","paths/~1macros/get/responses/200/content/application~1json/examples/large_list_preview"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/400/content/application~1json/examples/Invalid parameter"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/400/content/application~1json/examples/Invalid parameter"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden - missing required OAuth scope","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/403/content/application~1json/examples/Missing required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/403/content/application~1json/examples/Missing required scope"]}],"pointer":"/paths/~1macros/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/macro_list","exampleIds":["paths/~1macros/get/responses/200/content/application~1json/examples/basic_list","paths/~1macros/get/responses/200/content/application~1json/examples/pagination_with_cursor","paths/~1macros/get/responses/200/content/application~1json/examples/filtered_by_timestamp","paths/~1macros/get/responses/200/content/application~1json/examples/complex_placeholders","paths/~1macros/get/responses/200/content/application~1json/examples/empty_result","paths/~1macros/get/responses/200/content/application~1json/examples/large_list_preview"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/macro_list","exampleIds":["paths/~1macros/get/responses/200/content/application~1json/examples/basic_list","paths/~1macros/get/responses/200/content/application~1json/examples/pagination_with_cursor","paths/~1macros/get/responses/200/content/application~1json/examples/filtered_by_timestamp","paths/~1macros/get/responses/200/content/application~1json/examples/complex_placeholders","paths/~1macros/get/responses/200/content/application~1json/examples/empty_result","paths/~1macros/get/responses/200/content/application~1json/examples/large_list_preview"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/400/content/application~1json/examples/Invalid parameter"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/400/content/application~1json/examples/Invalid parameter"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/403/content/application~1json/examples/Missing required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1macros/get/responses/403/content/application~1json/examples/Missing required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/macros/listmacros"}],"panels":[]}]},"httpPath":"/macros"},{"type":"link","label":"Macro","link":"/docs/references/rest-api/api.intercom.io/macros/macro","routeSlug":"/docs/references/rest-api/api.intercom.io/macros/macro","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"macro"},"seo":{"title":"Macro"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Macro","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/macro"},"children":[]}]}]}},{"type":"link","label":"Macro List","link":"/docs/references/rest-api/api.intercom.io/macros/macro_list","routeSlug":"/docs/references/rest-api/api.intercom.io/macros/macro_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"macro_list"},"seo":{"title":"Macro List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Macro List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/macro_list"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Macros"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Macros","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to saved replies (macros) in conversations"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Macro","link":"/macros/macro","deprecated":false},{"title":"Macro List","link":"/macros/macro_list","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/macros/{id}","summary":"Retrieve a macro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/macros/getmacro","deprecated":false},{"title":"/macros","summary":"List all macros","prefix":{"name":"get","color":"get"},"badges":[],"link":"/macros/listmacros","deprecated":false}]}]}]}]}},{"type":"group","label":"Messages","link":"/docs/references/rest-api/api.intercom.io/messages","routeSlug":"/docs/references/rest-api/api.intercom.io/messages","items":[{"label":"Create a message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/messages/createmessage","routeSlug":"/docs/references/rest-api/api.intercom.io/messages/createmessage","metadata":{"seo":{"title":"Create a message","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 whatsapp."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMessage","name":"Create a message","isWebhook":false,"pointer":"/paths/~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email or whatsapp."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧 Sending for visitors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return the Message model that has been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚧 Retrieving Associated Conversations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Messages from contacts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be an admin. A request with a user or lead as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not rejected: it creates a conversation initiated by that contact, as the Create a conversation endpoint ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") does, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bcc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are ignored. To create a conversation initiated by a contact, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1messages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_message_request","exampleIds":["paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message"]}},"schemaId":"components/schemas/create_message_request","exampleIds":["paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message"],"pointer":"/paths/~1messages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/messages","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_message_request","exampleIds":["paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/messages","href":"messages/createmessage","openApiOperationId":"createMessage","summary":"Create a message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_message_request","exampleIds":["paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_message_request","exampleIds":["paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message","paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"admin message created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1messages/post/responses/200/content/application~1json/examples/user message created","paths/~1messages/post/responses/200/content/application~1json/examples/lead message created","paths/~1messages/post/responses/200/content/application~1json/examples/admin message created"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1messages/post/responses/200/content/application~1json/examples/user message created","paths/~1messages/post/responses/200/content/application~1json/examples/lead message created","paths/~1messages/post/responses/200/content/application~1json/examples/admin message created"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for message","paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for email message","paths/~1messages/post/responses/400/content/application~1json/examples/Recipient missing","paths/~1messages/post/responses/400/content/application~1json/examples/Too many recipients","paths/~1messages/post/responses/400/content/application~1json/examples/Brand not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for message","paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for email message","paths/~1messages/post/responses/400/content/application~1json/examples/Recipient missing","paths/~1messages/post/responses/400/content/application~1json/examples/Too many recipients","paths/~1messages/post/responses/400/content/application~1json/examples/Brand not found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient unsubscribed from emails","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient hard bounced"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient unsubscribed from emails","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient hard bounced"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/404/content/application~1json/examples/Contact not found"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message","paths/~1messages/post/responses/422/content/application~1json/examples/Subject too long","paths/~1messages/post/responses/422/content/application~1json/examples/Message too long"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message","paths/~1messages/post/responses/422/content/application~1json/examples/Subject too long","paths/~1messages/post/responses/422/content/application~1json/examples/Message too long"]}],"pointer":"/paths/~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1messages/post/responses/200/content/application~1json/examples/user message created","paths/~1messages/post/responses/200/content/application~1json/examples/lead message created","paths/~1messages/post/responses/200/content/application~1json/examples/admin message created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1messages/post/responses/200/content/application~1json/examples/user message created","paths/~1messages/post/responses/200/content/application~1json/examples/lead message created","paths/~1messages/post/responses/200/content/application~1json/examples/admin message created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for message","paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for email message","paths/~1messages/post/responses/400/content/application~1json/examples/Recipient missing","paths/~1messages/post/responses/400/content/application~1json/examples/Too many recipients","paths/~1messages/post/responses/400/content/application~1json/examples/Brand not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for message","paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for email message","paths/~1messages/post/responses/400/content/application~1json/examples/Recipient missing","paths/~1messages/post/responses/400/content/application~1json/examples/Too many recipients","paths/~1messages/post/responses/400/content/application~1json/examples/Brand not found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient unsubscribed from emails","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient hard bounced"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient unsubscribed from emails","paths/~1messages/post/responses/403/content/application~1json/examples/Recipient hard bounced"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/404/content/application~1json/examples/Contact not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message","paths/~1messages/post/responses/422/content/application~1json/examples/Subject too long","paths/~1messages/post/responses/422/content/application~1json/examples/Message too long"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message","paths/~1messages/post/responses/422/content/application~1json/examples/Subject too long","paths/~1messages/post/responses/422/content/application~1json/examples/Message too long"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/createmessage"}],"panels":[]}]},"httpPath":"/messages"},{"label":"Retrieve WhatsApp message delivery status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/messages/retrievewhatsappmessagestatus","routeSlug":"/docs/references/rest-api/api.intercom.io/messages/retrievewhatsappmessagestatus","metadata":{"seo":{"title":"Retrieve WhatsApp message delivery status","description":"Retrieves the delivery status of a specific WhatsApp message by its message ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveWhatsAppMessageStatus","name":"Retrieve WhatsApp message delivery status","isWebhook":false,"pointer":"/paths/~1messages~1whatsapp~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve WhatsApp message delivery status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the delivery status of a specific WhatsApp message by its message ID.\n\n\nReturns the current status, conversation details, and any error information if the message failed to deliver.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"message_id","in":"query","schemaId":"schema_1152","description":"The WhatsApp message ID to check status for","required":true}],"pointer":"/paths/~1messages~1whatsapp~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1messages~1whatsapp~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/messages/whatsapp/status","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"message_id","in":"query","required":true,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/messages/whatsapp/status","href":"messages/retrievewhatsappmessagestatus","openApiOperationId":"RetrieveWhatsAppMessageStatus","summary":"Retrieve WhatsApp message delivery status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"]}},"schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"]},{"code":"400","description":"Bad request - missing required parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"WhatsApp message not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"]}],"pointer":"/paths/~1messages~1whatsapp~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/retrievewhatsappmessagestatus"}],"panels":[]}]},"httpPath":"/messages/whatsapp/status"},{"label":"Get statuses of all messages sent based on the specified ruleset_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/messages/getwhatsappmessagestatus","routeSlug":"/docs/references/rest-api/api.intercom.io/messages/getwhatsappmessagestatus","metadata":{"seo":{"title":"Get statuses of all messages sent based on the specified ruleset_id","description":"Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWhatsAppMessageStatus","name":"Get statuses of all messages sent based on the specified ruleset_id","isWebhook":false,"pointer":"/paths/~1messages~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get statuses of all messages sent based on the specified ruleset_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ruleset_id","in":"query","schemaId":"schema_1152","description":"The unique identifier for the set of messages to check status for","required":true},{"name":"per_page","in":"query","schemaId":"schema_1259","description":"Number of results per page (default 50, max 100)"},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":"Cursor for pagination, used to fetch the next page of results"}],"pointer":"/paths/~1messages~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1messages~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/messages/status","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"ruleset_id","in":"query","required":true,"schemaId":"schema_1152"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1259"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/messages/status","href":"messages/getwhatsappmessagestatus","openApiOperationId":"getWhatsAppMessageStatus","summary":"Get statuses of all messages sent based on the specified ruleset_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad request - missing required parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"]}],"pointer":"/paths/~1messages~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/getwhatsappmessagestatus"}],"panels":[]}]},"httpPath":"/messages/status"},{"type":"link","label":"Message","link":"/docs/references/rest-api/api.intercom.io/messages/message","routeSlug":"/docs/references/rest-api/api.intercom.io/messages/message","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"message"},"seo":{"title":"Message"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Message","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/message"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Messages","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your messages"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Message","link":"/messages/message","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/messages","summary":"Create a message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/createmessage","deprecated":false},{"title":"/messages/whatsapp/status","summary":"Retrieve WhatsApp message delivery status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/retrievewhatsappmessagestatus","deprecated":false},{"title":"/messages/status","summary":"Get statuses of all messages sent based on the specified ruleset_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/getwhatsappmessagestatus","deprecated":false}]}]}]}]}},{"type":"group","label":"News","link":"/docs/references/rest-api/api.intercom.io/news","routeSlug":"/docs/references/rest-api/api.intercom.io/news","items":[{"label":"List all news items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/listnewsitems","routeSlug":"/docs/references/rest-api/api.intercom.io/news/listnewsitems","metadata":{"seo":{"title":"List all news items","description":"You can fetch a list of all news items"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNewsItems","name":"List all news items","isWebhook":false,"pointer":"/paths/~1news~1news_items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all news items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all news items"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"News items are returned newest first, by creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1181","description":"The page of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_1260","description":"The number of news items to return per page. Values above 20 are reduced to 20."}],"pointer":"/paths/~1news~1news_items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1news_items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/news_items","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1181"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_1260"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/news/news_items","href":"news/listnewsitems","openApiOperationId":"listNewsItems","summary":"List all news items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1news_items/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1news_items/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/400/content/application~1json/examples/Per page too small"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/400/content/application~1json/examples/Per page too small"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"News is not enabled on the workspace. The response has no body."}],"pointer":"/paths/~1news~1news_items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1news_items/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1news_items/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/400/content/application~1json/examples/Per page too small"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/400/content/application~1json/examples/Per page too small"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/listnewsitems"}],"panels":[]}]},"httpPath":"/news/news_items"},{"label":"Create a news item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/createnewsitem","routeSlug":"/docs/references/rest-api/api.intercom.io/news/createnewsitem","metadata":{"seo":{"title":"Create a news item","description":"You can create a news item"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNewsItem","name":"Create a news item","isWebhook":false,"pointer":"/paths/~1news~1news_items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a news item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a news item"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1news_items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/news_item_request","exampleIds":["paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/news_item_request","exampleIds":["paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1news~1news_items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/news/news_items","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/news_item_request","exampleIds":["paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/news/news_items","href":"news/createnewsitem","openApiOperationId":"createNewsItem","summary":"Create a news item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/news_item_request","exampleIds":["paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/news_item_request","exampleIds":["paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Title missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Sender missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Published date in the future"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Title missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Sender missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Published date in the future"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Sender not found. If News is not enabled on the workspace the response has no body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/404/content/application~1json/examples/Sender Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/404/content/application~1json/examples/Sender Not Found"]}],"pointer":"/paths/~1news~1news_items/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Title missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Sender missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Published date in the future"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Title missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Sender missing","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Published date in the future"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/404/content/application~1json/examples/Sender Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/404/content/application~1json/examples/Sender Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/createnewsitem"}],"panels":[]}]},"httpPath":"/news/news_items"},{"label":"Retrieve a news item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/retrievenewsitem","routeSlug":"/docs/references/rest-api/api.intercom.io/news/retrievenewsitem","metadata":{"seo":{"title":"Retrieve a news item","description":"You can fetch the details of a single news item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveNewsItem","name":"Retrieve a news item","isWebhook":false,"pointer":"/paths/~1news~1news_items~1{news_item_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a news item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single news item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"news_item_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the news item which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/news_items/{news_item_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"news_item_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/news/news_items/{news_item_id}","href":"news/retrievenewsitem","openApiOperationId":"retrieveNewsItem","summary":"Retrieve a news item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"News Item Not Found. If News is not enabled on the workspace the response has no body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/404/content/application~1json/examples/News Item Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/404/content/application~1json/examples/News Item Not Found"]}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/404/content/application~1json/examples/News Item Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/404/content/application~1json/examples/News Item Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/retrievenewsitem"}],"panels":[]}]},"httpPath":"/news/news_items/{news_item_id}"},{"label":"Update a news item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/updatenewsitem","routeSlug":"/docs/references/rest-api/api.intercom.io/news/updatenewsitem","metadata":{"seo":{"title":"Update a news item","description":"You can update a news item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNewsItem","name":"Update a news item","isWebhook":false,"pointer":"/paths/~1news~1news_items~1{news_item_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a news item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a news item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send this request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it behaves the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliver_silently"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cover_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keep their current values when you leave them out. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newsfeed_assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not: leaving either out clears it, so send the full list on every update. Leaving "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" out disables reactions, although the list in the response does not change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"news_item_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the news item which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_news_item_request","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found"]}},"schemaId":"components/schemas/update_news_item_request","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found"],"pointer":"/paths/~1news~1news_items~1{news_item_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/news/news_items/{news_item_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"news_item_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_news_item_request","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/news/news_items/{news_item_id}","href":"news/updatenewsitem","openApiOperationId":"updateNewsItem","summary":"Update a news item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_news_item_request","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_news_item_request","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Published date in the future"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Published date in the future"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"News Item Not Found, or the sender was not found. Omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also returns this status. If News is not enabled on the workspace the response has no body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item Not Found","paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/Sender Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item Not Found","paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/Sender Not Found"]}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Published date in the future"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid cover image URL","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid state","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Newsfeed does not exist","paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Published date in the future"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item Not Found","paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/Sender Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item Not Found","paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/Sender Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/updatenewsitem"}],"panels":[]}]},"httpPath":"/news/news_items/{news_item_id}"},{"label":"Delete a news item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/deletenewsitem","routeSlug":"/docs/references/rest-api/api.intercom.io/news/deletenewsitem","metadata":{"seo":{"title":"Delete a news item","description":"You can delete a single news item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNewsItem","name":"Delete a news item","isWebhook":false,"pointer":"/paths/~1news~1news_items~1{news_item_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a news item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single news item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"news_item_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the news item which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/news/news_items/{news_item_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"news_item_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/news/news_items/{news_item_id}","href":"news/deletenewsitem","openApiOperationId":"deleteNewsItem","summary":"Delete a news item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_object","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_object","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"News Item Not Found. If News is not enabled on the workspace the response has no body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/404/content/application~1json/examples/News Item Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/404/content/application~1json/examples/News Item Not Found"]}],"pointer":"/paths/~1news~1news_items~1{news_item_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_object","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_object","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/404/content/application~1json/examples/News Item Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/404/content/application~1json/examples/News Item Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/deletenewsitem"}],"panels":[]}]},"httpPath":"/news/news_items/{news_item_id}"},{"label":"List all live newsfeed items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/listlivenewsfeeditems","routeSlug":"/docs/references/rest-api/api.intercom.io/news/listlivenewsfeeditems","metadata":{"seo":{"title":"List all live newsfeed items","description":"You can fetch a list of all news items that are live on a given newsfeed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLiveNewsfeedItems","name":"List all live newsfeed items","isWebhook":false,"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all live newsfeed items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all news items that are live on a given newsfeed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"News items are returned most recently published first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"newsfeed_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the news feed item which is given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1181","description":"The page of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_1261","description":"The number of news items to return per page. Values above 20 are reduced to 20."}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/newsfeeds/{newsfeed_id}/items","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"newsfeed_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1181"},{"name":"per_page","in":"query","required":false,"example":20,"schemaId":"schema_1261"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/news/newsfeeds/{newsfeed_id}/items","href":"news/listlivenewsfeeditems","openApiOperationId":"listLiveNewsfeedItems","summary":"List all live newsfeed items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/400/content/application~1json/examples/Per page too small"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/400/content/application~1json/examples/Per page too small"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Newsfeed not found. If News is not enabled on the workspace the response has no body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/404/content/application~1json/examples/Newsfeed Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/404/content/application~1json/examples/Newsfeed Not Found"]}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/400/content/application~1json/examples/Per page too small"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/400/content/application~1json/examples/Per page too small"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/404/content/application~1json/examples/Newsfeed Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/404/content/application~1json/examples/Newsfeed Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/listlivenewsfeeditems"}],"panels":[]}]},"httpPath":"/news/newsfeeds/{newsfeed_id}/items"},{"label":"List all newsfeeds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/listnewsfeeds","routeSlug":"/docs/references/rest-api/api.intercom.io/news/listnewsfeeds","metadata":{"seo":{"title":"List all newsfeeds","description":"You can fetch a list of all newsfeeds"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNewsfeeds","name":"List all newsfeeds","isWebhook":false,"pointer":"/paths/~1news~1newsfeeds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all newsfeeds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all newsfeeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsfeeds are returned newest first, by creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1181","description":"The page of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_1260","description":"The number of newsfeeds to return per page. Values above 20 are reduced to 20."}],"pointer":"/paths/~1news~1newsfeeds/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1newsfeeds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/newsfeeds","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1181"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_1260"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/news/newsfeeds","href":"news/listnewsfeeds","openApiOperationId":"listNewsfeeds","summary":"List all newsfeeds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds/get/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/400/content/application~1json/examples/Per page too small"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/400/content/application~1json/examples/Per page too small"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"News is not enabled on the workspace. The response has no body."}],"pointer":"/paths/~1news~1newsfeeds/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/400/content/application~1json/examples/Per page too small"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/400/content/application~1json/examples/Per page too small"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/listnewsfeeds"}],"panels":[]}]},"httpPath":"/news/newsfeeds"},{"label":"Retrieve a newsfeed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/news/retrievenewsfeed","routeSlug":"/docs/references/rest-api/api.intercom.io/news/retrievenewsfeed","metadata":{"seo":{"title":"Retrieve a newsfeed","description":"You can fetch the details of a single newsfeed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveNewsfeed","name":"Retrieve a newsfeed","isWebhook":false,"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a newsfeed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single newsfeed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_news_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"newsfeed_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the news feed item which is given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/newsfeeds/{newsfeed_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"newsfeed_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/news/newsfeeds/{newsfeed_id}","href":"news/retrievenewsfeed","openApiOperationId":"retrieveNewsfeed","summary":"Retrieve a newsfeed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Newsfeed not found. If News is not enabled on the workspace the response has no body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/404/content/application~1json/examples/Newsfeed Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/404/content/application~1json/examples/Newsfeed Not Found"]}],"pointer":"/paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/404/content/application~1json/examples/Newsfeed Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/404/content/application~1json/examples/Newsfeed Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/retrievenewsfeed"}],"panels":[]}]},"httpPath":"/news/newsfeeds/{newsfeed_id}"},{"type":"link","label":"News Item","link":"/docs/references/rest-api/api.intercom.io/news/news_item","routeSlug":"/docs/references/rest-api/api.intercom.io/news/news_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"news_item"},"seo":{"title":"News Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"News Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/news_item"},"children":[]}]}]}},{"type":"link","label":"Newsfeed","link":"/docs/references/rest-api/api.intercom.io/news/newsfeed","routeSlug":"/docs/references/rest-api/api.intercom.io/news/newsfeed","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"newsfeed"},"seo":{"title":"Newsfeed"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Newsfeed","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/newsfeed"},"children":[]}]}]}},{"type":"link","label":"Newsfeed Assignment","link":"/docs/references/rest-api/api.intercom.io/news/newsfeed_assignment","routeSlug":"/docs/references/rest-api/api.intercom.io/news/newsfeed_assignment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"newsfeed_assignment"},"seo":{"title":"Newsfeed Assignment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Newsfeed Assignment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/newsfeed_assignment"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"News"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"News","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your News"},{"nodeType":"external-docs","url":"https://www.intercom.com/help/en/articles/6362251-news-explained","description":"News explained"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"News Item","link":"/news/news_item","deprecated":false},{"title":"Newsfeed","link":"/news/newsfeed","deprecated":false},{"title":"Newsfeed Assignment","link":"/news/newsfeed_assignment","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/news/news_items","summary":"List all news items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/listnewsitems","deprecated":false},{"title":"/news/news_items","summary":"Create a news item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/news/createnewsitem","deprecated":false},{"title":"/news/news_items/{news_item_id}","summary":"Retrieve a news item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/retrievenewsitem","deprecated":false},{"title":"/news/news_items/{news_item_id}","summary":"Update a news item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/news/updatenewsitem","deprecated":false},{"title":"/news/news_items/{news_item_id}","summary":"Delete a news item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/news/deletenewsitem","deprecated":false},{"title":"/news/newsfeeds/{newsfeed_id}/items","summary":"List all live newsfeed items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/listlivenewsfeeditems","deprecated":false},{"title":"/news/newsfeeds","summary":"List all newsfeeds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/listnewsfeeds","deprecated":false},{"title":"/news/newsfeeds/{newsfeed_id}","summary":"Retrieve a newsfeed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/retrievenewsfeed","deprecated":false}]}]}]}]}},{"type":"group","label":"Notes","link":"/docs/references/rest-api/api.intercom.io/notes","routeSlug":"/docs/references/rest-api/api.intercom.io/notes","items":[{"label":"List all company notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/notes/listcompanynotes","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/listcompanynotes","metadata":{"seo":{"title":"List all company notes","description":"You can fetch a list of notes that are associated to a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanyNotes","name":"List all company notes","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all company notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of notes that are associated to a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of results to return. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of notes to return per page. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":50},{"name":"order","in":"query","schemaId":"schema_1178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order the notes are returned in, by id. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{company_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1178"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}/notes","href":"notes/listcompanynotes","openApiOperationId":"listCompanyNotes","summary":"List all company notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"]}],"pointer":"/paths/~1companies~1{company_id}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/listcompanynotes"}],"panels":[]}]},"httpPath":"/companies/{company_id}/notes"},{"label":"Create a company note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/notes/createcompanynote","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/createcompanynote","metadata":{"seo":{"title":"Create a company note","description":"You can add a note to a single company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCompanyNote","name":"Create a company note","isWebhook":false,"pointer":"/paths/~1companies~1{company_id}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a company note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add a note to a single company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{company_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1companies~1{company_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"]}},"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"],"pointer":"/paths/~1companies~1{company_id}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies/{company_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/companies/{company_id}/notes","href":"notes/createcompanynote","openApiOperationId":"createCompanyNote","summary":"Create a company note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1179","exampleIds":["paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Company or admin not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"]}],"pointer":"/paths/~1companies~1{company_id}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/createcompanynote"}],"panels":[]}]},"httpPath":"/companies/{company_id}/notes"},{"label":"List all notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/notes/listnotes","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/listnotes","metadata":{"seo":{"title":"List all notes","description":"You can fetch a list of notes that are associated to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNotes","name":"List all notes","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of notes that are associated to a contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a contact.","required":true}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page of results to return. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},{"name":"per_page","in":"query","schemaId":"schema_1150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of notes to return per page. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":50},{"name":"order","in":"query","schemaId":"schema_1178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order the notes are returned in, by id. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_1150"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_1150"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_1178"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/notes","href":"notes/listnotes","openApiOperationId":"listNotes","summary":"List all notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/listnotes"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/notes"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/notes/createnote","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/createnote","metadata":{"seo":{"title":"Create a note","description":"You can add a note to a single contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNote","name":"Create a note","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add a note to a single contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given contact.","required":true,"example":"6762f0ad1bb69f9f2193bb62"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/notes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"6762f0ad1bb69f9f2193bb62","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/contacts/{contact_id}/notes","href":"notes/createnote","openApiOperationId":"createNote","summary":"Create a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1186","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/createnote"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/notes"},{"label":"Retrieve a note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/notes/retrievenote","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/retrievenote","metadata":{"seo":{"title":"Retrieve a note","description":"You can fetch the details of a single note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveNote","name":"Retrieve a note","isWebhook":false,"pointer":"/paths/~1notes~1{note_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single note."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"note_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given note","required":true,"example":"34"}],"pointer":"/paths/~1notes~1{note_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1notes~1{note_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notes/{note_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"note_id","in":"path","required":true,"example":"34","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/notes/{note_id}","href":"notes/retrievenote","openApiOperationId":"retrieveNote","summary":"Retrieve a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Note found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{note_id}/get/responses/200/content/application~1json/examples/Note found"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{note_id}/get/responses/200/content/application~1json/examples/Note found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Note not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/404/content/application~1json/examples/Note not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/404/content/application~1json/examples/Note not found"]}],"pointer":"/paths/~1notes~1{note_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{note_id}/get/responses/200/content/application~1json/examples/Note found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{note_id}/get/responses/200/content/application~1json/examples/Note found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/404/content/application~1json/examples/Note not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/get/responses/404/content/application~1json/examples/Note not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/retrievenote"}],"panels":[]}]},"httpPath":"/notes/{note_id}"},{"label":"Delete a note","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/notes/deletenote","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/deletenote","metadata":{"seo":{"title":"Delete a note","description":"You can delete a single contact or company note. Notes of other kinds cannot be deleted through the API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNote","name":"Delete a note","isWebhook":false,"pointer":"/paths/~1notes~1{note_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete a single contact or company note. Notes of other kinds cannot be deleted through the API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"note_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given note","required":true,"example":"34"}],"pointer":"/paths/~1notes~1{note_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1notes~1{note_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notes/{note_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"note_id","in":"path","required":true,"example":"34","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/notes/{note_id}","href":"notes/deletenote","openApiOperationId":"deleteNote","summary":"Delete a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_note_object","exampleIds":["paths/~1notes~1{note_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_note_object","exampleIds":["paths/~1notes~1{note_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Resource not available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/400/content/application~1json/examples/Resource not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/400/content/application~1json/examples/Resource not available"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Note not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/404/content/application~1json/examples/Note not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/404/content/application~1json/examples/Note not found"]}],"pointer":"/paths/~1notes~1{note_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_note_object","exampleIds":["paths/~1notes~1{note_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_note_object","exampleIds":["paths/~1notes~1{note_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/400/content/application~1json/examples/Resource not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/400/content/application~1json/examples/Resource not available"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/404/content/application~1json/examples/Note not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{note_id}/delete/responses/404/content/application~1json/examples/Note not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/deletenote"}],"panels":[]}]},"httpPath":"/notes/{note_id}"},{"type":"link","label":"Company Note","link":"/docs/references/rest-api/api.intercom.io/notes/company_note","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/company_note","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_note"},"seo":{"title":"Company Note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Note","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_note"},"children":[]}]}]}},{"type":"link","label":"Note","link":"/docs/references/rest-api/api.intercom.io/notes/note","routeSlug":"/docs/references/rest-api/api.intercom.io/notes/note","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"note"},"seo":{"title":"Note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Note","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/note"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notes","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Notes"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Company Note","link":"/notes/company_note","deprecated":false},{"title":"Note","link":"/notes/note","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{company_id}/notes","summary":"List all company notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/listcompanynotes","deprecated":false},{"title":"/companies/{company_id}/notes","summary":"Create a company note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/createcompanynote","deprecated":false},{"title":"/contacts/{contact_id}/notes","summary":"List all notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/listnotes","deprecated":false},{"title":"/contacts/{contact_id}/notes","summary":"Create a note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/createnote","deprecated":false},{"title":"/notes/{note_id}","summary":"Retrieve a note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/retrievenote","deprecated":false},{"title":"/notes/{note_id}","summary":"Delete a note","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notes/deletenote","deprecated":false}]}]}]}]}},{"type":"group","label":"Office Hours","link":"/docs/references/rest-api/api.intercom.io/office-hours","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours","items":[{"label":"Retrieve an office hours exception","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/getofficehoursexception","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/getofficehoursexception","metadata":{"seo":{"title":"Retrieve an office hours exception","description":"You can fetch the details of a single office hours exception."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOfficeHoursException","name":"Retrieve an office hours exception","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an office hours exception","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single office hours exception."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"office_hours_schedule_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours exception.","required":true,"example":"456"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"office_hours_schedule_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"456","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","href":"office-hours/getofficehoursexception","openApiOperationId":"getOfficeHoursException","summary":"Retrieve an office hours exception"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Office hours exception found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/200/content/application~1json/examples/Office hours exception found"]}},"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/200/content/application~1json/examples/Office hours exception found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule or exception not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours exception not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours exception not found"]}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/200/content/application~1json/examples/Office hours exception found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/200/content/application~1json/examples/Office hours exception found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours exception not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours exception not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/getofficehoursexception"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}"},{"label":"Update an office hours exception","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/updateofficehoursexception","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/updateofficehoursexception","metadata":{"seo":{"title":"Update an office hours exception","description":"You can update an existing office hours exception."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOfficeHoursException","name":"Update an office hours exception","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an office hours exception","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can update an existing office hours exception."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"office_hours_schedule_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours exception.","required":true,"example":"456"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception"]}},"schemaId":"components/schemas/update_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception"],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"office_hours_schedule_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"456","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","href":"office-hours/updateofficehoursexception","openApiOperationId":"updateOfficeHoursException","summary":"Update an office hours exception"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Office hours exception updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/200/content/application~1json/examples/Office hours exception updated"]}},"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/200/content/application~1json/examples/Office hours exception updated"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule or exception not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours exception not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours exception not found"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Invalid exception_type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Invalid exception_type"]}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/200/content/application~1json/examples/Office hours exception updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/200/content/application~1json/examples/Office hours exception updated"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/400/content/application~1json/examples/Unknown field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours exception not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours exception not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Invalid exception_type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Invalid exception_type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/updateofficehoursexception"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}"},{"label":"Delete an office hours exception","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/deleteofficehoursexception","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/deleteofficehoursexception","metadata":{"seo":{"title":"Delete an office hours exception","description":"You can delete a single office hours exception."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOfficeHoursException","name":"Delete an office hours exception","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an office hours exception","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can delete a single office hours exception."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"office_hours_schedule_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours exception.","required":true,"example":"456"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"office_hours_schedule_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"456","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","href":"office-hours/deleteofficehoursexception","openApiOperationId":"deleteOfficeHoursException","summary":"Delete an office hours exception"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Office hours exception deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1262","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/200/content/application~1json/examples/Office hours exception deleted"]}},"schemaId":"schema_1262","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/200/content/application~1json/examples/Office hours exception deleted"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule or exception not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours exception not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours exception not found"]}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1262","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/200/content/application~1json/examples/Office hours exception deleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1262","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/200/content/application~1json/examples/Office hours exception deleted"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours exception not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours exception not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/deleteofficehoursexception"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}"},{"label":"List all office hours exceptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/listofficehoursexceptions","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/listofficehoursexceptions","metadata":{"seo":{"title":"List all office hours exceptions","description":"You can fetch a list of all exceptions for an office hours schedule, ordered by date with the earliest first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfficeHoursExceptions","name":"List all office hours exceptions","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all office hours exceptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of all exceptions for an office hours schedule, ordered by date with the earliest first.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"office_hours_schedule_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"office_hours_schedule_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions","href":"office-hours/listofficehoursexceptions","openApiOperationId":"listOfficeHoursExceptions","summary":"List all office hours exceptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception_list","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/office_hours_exception_list","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/Office hours schedule not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/Office hours schedule not found"]}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/office_hours_exception_list","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception_list","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/Office hours schedule not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/Office hours schedule not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/listofficehoursexceptions"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions"},{"label":"Create an office hours exception","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/createofficehoursexception","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/createofficehoursexception","metadata":{"seo":{"title":"Create an office hours exception","description":"You can create an exception for an office hours schedule. Use closed to mark the day closed (omit time_intervals) or custom_hours to supply replacement intervals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOfficeHoursException","name":"Create an office hours exception","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an office hours exception","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create an exception for an office hours schedule. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to mark the day closed (omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to supply replacement intervals."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"office_hours_schedule_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception"]}},"schemaId":"components/schemas/create_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception"],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"office_hours_schedule_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception"]}},"responseCodes":["201","400","401","404","422"],"pointer":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions","href":"office-hours/createofficehoursexception","openApiOperationId":"createOfficeHoursException","summary":"Create an office hours exception"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_office_hours_exception_request","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Office hours exception created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/201/content/application~1json/examples/Office hours exception created"]}},"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/201/content/application~1json/examples/Office hours exception created"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/400/content/application~1json/examples/Unknown field"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/400/content/application~1json/examples/Unknown field"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/Office hours schedule not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/Office hours schedule not found"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing exception_type","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Duplicate date","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing exception_type","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Duplicate date","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid"]}],"pointer":"/paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/201/content/application~1json/examples/Office hours exception created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_exception","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/201/content/application~1json/examples/Office hours exception created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/400/content/application~1json/examples/Unknown field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/400/content/application~1json/examples/Unknown field"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/Office hours schedule not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/Office hours schedule not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing exception_type","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Duplicate date","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing exception_type","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Intervals on a closed exception","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Duplicate date","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/createofficehoursexception"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions"},{"label":"Retrieve an office hours schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/getofficehoursschedule","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/getofficehoursschedule","metadata":{"seo":{"title":"Retrieve an office hours schedule","description":"You can fetch the details of a single office hours schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOfficeHoursSchedule","name":"Retrieve an office hours schedule","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an office hours schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single office hours schedule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"}],"pointer":"/paths/~1office_hours_schedules~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/office_hours_schedules/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/office_hours_schedules/{id}","href":"office-hours/getofficehoursschedule","openApiOperationId":"getOfficeHoursSchedule","summary":"Retrieve an office hours schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Office hours schedule found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/200/content/application~1json/examples/Office hours schedule found"]}},"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/200/content/application~1json/examples/Office hours schedule found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found"]}],"pointer":"/paths/~1office_hours_schedules~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/200/content/application~1json/examples/Office hours schedule found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/200/content/application~1json/examples/Office hours schedule found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/getofficehoursschedule"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{id}"},{"label":"Update an office hours schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/updateofficehoursschedule","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/updateofficehoursschedule","metadata":{"seo":{"title":"Update an office hours schedule","description":"You can update an existing office hours schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOfficeHoursSchedule","name":"Update an office hours schedule","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an office hours schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can update an existing office hours schedule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"}],"pointer":"/paths/~1office_hours_schedules~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule"]}},"schemaId":"components/schemas/update_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule"],"pointer":"/paths/~1office_hours_schedules~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/office_hours_schedules/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/office_hours_schedules/{id}","href":"office-hours/updateofficehoursschedule","openApiOperationId":"updateOfficeHoursSchedule","summary":"Update an office hours schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Office hours schedule updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/200/content/application~1json/examples/Office hours schedule updated"]}},"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/200/content/application~1json/examples/Office hours schedule updated"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Invalid time zone"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Invalid time zone"]}],"pointer":"/paths/~1office_hours_schedules~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/200/content/application~1json/examples/Office hours schedule updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/200/content/application~1json/examples/Office hours schedule updated"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/400/content/application~1json/examples/Unknown field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/400/content/application~1json/examples/Unknown field"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Invalid time zone"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Invalid time zone"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/updateofficehoursschedule"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{id}"},{"label":"Delete an office hours schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/deleteofficehoursschedule","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/deleteofficehoursschedule","metadata":{"seo":{"title":"Delete an office hours schedule","description":"You can delete a single office hours schedule. The workspace's default schedule can't be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOfficeHoursSchedule","name":"Delete an office hours schedule","isWebhook":false,"pointer":"/paths/~1office_hours_schedules~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an office hours schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can delete a single office hours schedule. The workspace's default schedule can't be deleted.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"}],"pointer":"/paths/~1office_hours_schedules~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/office_hours_schedules/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","422"],"pointer":"/office_hours_schedules/{id}","href":"office-hours/deleteofficehoursschedule","openApiOperationId":"deleteOfficeHoursSchedule","summary":"Delete an office hours schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Office hours schedule deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1263","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted"]}},"schemaId":"schema_1263","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Office hours schedule not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/422/content/application~1json/examples/Default schedule"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/422/content/application~1json/examples/Default schedule"]}],"pointer":"/paths/~1office_hours_schedules~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1263","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1263","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/422/content/application~1json/examples/Default schedule"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/422/content/application~1json/examples/Default schedule"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/deleteofficehoursschedule"}],"panels":[]}]},"httpPath":"/office_hours_schedules/{id}"},{"label":"List all office hours schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/listofficehoursschedules","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/listofficehoursschedules","metadata":{"seo":{"title":"List all office hours schedules","description":"You can fetch a list of all office hours schedules for the workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfficeHoursSchedules","name":"List all office hours schedules","isWebhook":false,"pointer":"/paths/~1office_hours_schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all office hours schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of all office hours schedules for the workspace."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/office_hours_schedules","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/office_hours_schedules","href":"office-hours/listofficehoursschedules","openApiOperationId":"listOfficeHoursSchedules","summary":"List all office hours schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule_list","exampleIds":["paths/~1office_hours_schedules/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/office_hours_schedule_list","exampleIds":["paths/~1office_hours_schedules/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1office_hours_schedules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/office_hours_schedule_list","exampleIds":["paths/~1office_hours_schedules/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule_list","exampleIds":["paths/~1office_hours_schedules/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/listofficehoursschedules"}],"panels":[]}]},"httpPath":"/office_hours_schedules"},{"label":"Create an office hours schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/office-hours/createofficehoursschedule","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/createofficehoursschedule","metadata":{"seo":{"title":"Create an office hours schedule","description":"You can create a new office hours schedule for the workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOfficeHoursSchedule","name":"Create an office hours schedule","isWebhook":false,"pointer":"/paths/~1office_hours_schedules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an office hours schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can create a new office hours schedule for the workspace."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1office_hours_schedules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule"]}},"schemaId":"components/schemas/create_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule"],"pointer":"/paths/~1office_hours_schedules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/office_hours_schedules","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule"]}},"responseCodes":["201","400","401","422"],"pointer":"/office_hours_schedules","href":"office-hours/createofficehoursschedule","openApiOperationId":"createOfficeHoursSchedule","summary":"Create an office hours schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_office_hours_schedule_request","exampleIds":["paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Office hours schedule created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules/post/responses/201/content/application~1json/examples/Office hours schedule created"]}},"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules/post/responses/201/content/application~1json/examples/Office hours schedule created"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/400/content/application~1json/examples/Unknown field"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/400/content/application~1json/examples/Unknown field"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Invalid time zone"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Invalid time zone"]}],"pointer":"/paths/~1office_hours_schedules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules/post/responses/201/content/application~1json/examples/Office hours schedule created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/office_hours_schedule","exampleIds":["paths/~1office_hours_schedules/post/responses/201/content/application~1json/examples/Office hours schedule created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/400/content/application~1json/examples/Unknown field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/400/content/application~1json/examples/Unknown field"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Invalid time zone"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Missing time_intervals","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Duplicate name","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid","paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Invalid time zone"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/office-hours/createofficehoursschedule"}],"panels":[]}]},"httpPath":"/office_hours_schedules"},{"type":"link","label":"Office Hours Exception","link":"/docs/references/rest-api/api.intercom.io/office-hours/office_hours_exception","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/office_hours_exception","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"office_hours_exception"},"seo":{"title":"Office Hours Exception"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Office Hours Exception","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/office_hours_exception"},"children":[]}]}]}},{"type":"link","label":"Office Hours Schedule","link":"/docs/references/rest-api/api.intercom.io/office-hours/office_hours_schedule","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/office_hours_schedule","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"office_hours_schedule"},"seo":{"title":"Office Hours Schedule"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Office Hours Schedule","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/office_hours_schedule"},"children":[]}]}]}},{"type":"link","label":"Office Hours Time Interval","link":"/docs/references/rest-api/api.intercom.io/office-hours/office_hours_time_interval","routeSlug":"/docs/references/rest-api/api.intercom.io/office-hours/office_hours_time_interval","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"office_hours_time_interval"},"seo":{"title":"Office Hours Time Interval"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Office Hours Time Interval","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/office_hours_time_interval"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Office Hours"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Office Hours","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage office hours schedules and their exceptions. These endpoints require an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth token with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_office_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Office Hours Exception","link":"/office-hours/office_hours_exception","deprecated":false},{"title":"Office Hours Schedule","link":"/office-hours/office_hours_schedule","deprecated":false},{"title":"Office Hours Time Interval","link":"/office-hours/office_hours_time_interval","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","summary":"Retrieve an office hours exception","prefix":{"name":"get","color":"get"},"badges":[],"link":"/office-hours/getofficehoursexception","deprecated":false},{"title":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","summary":"Update an office hours exception","prefix":{"name":"put","color":"put"},"badges":[],"link":"/office-hours/updateofficehoursexception","deprecated":false},{"title":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}","summary":"Delete an office hours exception","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/office-hours/deleteofficehoursexception","deprecated":false},{"title":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions","summary":"List all office hours exceptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/office-hours/listofficehoursexceptions","deprecated":false},{"title":"/office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions","summary":"Create an office hours exception","prefix":{"name":"post","color":"post"},"badges":[],"link":"/office-hours/createofficehoursexception","deprecated":false},{"title":"/office_hours_schedules/{id}","summary":"Retrieve an office hours schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/office-hours/getofficehoursschedule","deprecated":false},{"title":"/office_hours_schedules/{id}","summary":"Update an office hours schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/office-hours/updateofficehoursschedule","deprecated":false},{"title":"/office_hours_schedules/{id}","summary":"Delete an office hours schedule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/office-hours/deleteofficehoursschedule","deprecated":false},{"title":"/office_hours_schedules","summary":"List all office hours schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/office-hours/listofficehoursschedules","deprecated":false},{"title":"/office_hours_schedules","summary":"Create an office hours schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/office-hours/createofficehoursschedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Reporting Data Export","link":"/docs/references/rest-api/api.intercom.io/reporting-data-export","routeSlug":"/docs/references/rest-api/api.intercom.io/reporting-data-export","items":[{"label":"Enqueue a new reporting data export job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1export~1reporting_data~1enqueue/post","routeSlug":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1export~1reporting_data~1enqueue/post","metadata":{"seo":{"title":"Enqueue a new reporting data export job","description":"For the conversation dataset, from API version 2.16 this export returns all conversations, including those that never received a user reply. Earlier versions return only conversations that received at least one user reply. Other datasets are unaffected."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Enqueue a new reporting data export job","isWebhook":false,"pointer":"/paths/~1export~1reporting_data~1enqueue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enqueue a new reporting data export job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the conversation dataset, from API version 2.16 this export returns all conversations, including those that never received a user reply. Earlier versions return only conversations that received at least one user reply. Other datasets are unaffected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_reporting_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1reporting_data~1enqueue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1264"}},"schemaId":"schema_1264","pointer":"/paths/~1export~1reporting_data~1enqueue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/export/reporting_data/enqueue","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1264"}},"responseCodes":["200","400","401","429"],"pointer":"/export/reporting_data/enqueue","href":"reporting-data-export/paths/~1export~1reporting_data~1enqueue/post","summary":"Enqueue a new reporting data export job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1264","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1264"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job enqueued successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1265"}},"schemaId":"schema_1265"},{"code":"400","description":"Bad request (e.g. validation errors)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Empty attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Non array attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unqualified attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/start_time too far in the past","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/end_time before start_time","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unknown parameter","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Empty attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Non array attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unqualified attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/start_time too far in the past","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/end_time before start_time","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unknown parameter","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"429","description":"Too many jobs in progress","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/429/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/429/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1export~1reporting_data~1enqueue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1265","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1265"}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Empty attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Non array attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unqualified attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/start_time too far in the past","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/end_time before start_time","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unknown parameter","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid dataset_id","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Empty attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Non array attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unqualified attribute_ids","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/start_time too far in the past","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/end_time before start_time","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unknown parameter","paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/429/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1enqueue/post/responses/429/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting-data-export/paths/~1export~1reporting_data~1enqueue/post"}],"panels":[]}]},"httpPath":"/export/reporting_data/enqueue"},{"label":"Get export job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1export~1reporting_data~1{job_identifier}/get","routeSlug":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1export~1reporting_data~1{job_identifier}/get","metadata":{"seo":{"title":"Get export job status","description":"Requires the export_reporting_data OAuth scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get export job status","isWebhook":false,"pointer":"/paths/~1export~1reporting_data~1{job_identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get export job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_reporting_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_identifier","in":"path","schemaId":"schema_1152","description":"Unique identifier of the job.","required":true}],"pointer":"/paths/~1export~1reporting_data~1{job_identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1reporting_data~1{job_identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/export/reporting_data/{job_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"job_identifier","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/export/reporting_data/{job_identifier}","href":"reporting-data-export/paths/~1export~1reporting_data~1{job_identifier}/get","summary":"Get export job status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job status returned successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1266","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With pending status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With complete status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With failed status"]}},"schemaId":"schema_1266","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With pending status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With complete status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With failed status"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"When the job is not found or was created by a different teammate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1export~1reporting_data~1{job_identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1266","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With pending status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With complete status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With failed status"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1266","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With pending status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With complete status","paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With failed status"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting-data-export/paths/~1export~1reporting_data~1{job_identifier}/get"}],"panels":[]}]},"httpPath":"/export/reporting_data/{job_identifier}"},{"label":"List available datasets and attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1export~1reporting_data~1get_datasets/get","routeSlug":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1export~1reporting_data~1get_datasets/get","metadata":{"seo":{"title":"List available datasets and attributes","description":"Requires the export_reporting_data or read_reporting_datasets OAuth scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List available datasets and attributes","isWebhook":false,"pointer":"/paths/~1export~1reporting_data~1get_datasets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available datasets and attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_reporting_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_reporting_datasets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1reporting_data~1get_datasets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/export/reporting_data/get_datasets","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/export/reporting_data/get_datasets","href":"reporting-data-export/paths/~1export~1reporting_data~1get_datasets/get","summary":"List available datasets and attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of datasets","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1267"}},"schemaId":"schema_1267"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1export~1reporting_data~1get_datasets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1267"}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1reporting_data~1get_datasets/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting-data-export/paths/~1export~1reporting_data~1get_datasets/get"}],"panels":[]}]},"httpPath":"/export/reporting_data/get_datasets"},{"label":"Download completed export job data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1download~1reporting_data~1{job_identifier}/get","routeSlug":"/docs/references/rest-api/api.intercom.io/reporting-data-export/paths/~1download~1reporting_data~1{job_identifier}/get","metadata":{"seo":{"title":"Download completed export job data","description":"Download the data from a completed reporting data export job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Download completed export job data","isWebhook":false,"pointer":"/paths/~1download~1reporting_data~1{job_identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download completed export job data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the data from a completed reporting data export job."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Octet header required"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will have to specify the header Accept: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when hitting this endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_reporting_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_identifier","in":"path","schemaId":"schema_1152","description":"Unique identifier of the job.","required":true}],"pointer":"/paths/~1download~1reporting_data~1{job_identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"},{"name":"Accept","in":"header","schemaId":"schema_1268","description":"Required header for downloading the export file","required":true}],"pointer":"/paths/~1download~1reporting_data~1{job_identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/download/reporting_data/{job_identifier}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"job_identifier","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"},{"name":"Accept","in":"header","required":true,"example":"application/octet-stream","schemaId":"schema_1268"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/download/reporting_data/{job_identifier}","href":"reporting-data-export/paths/~1download~1reporting_data~1{job_identifier}/get","summary":"Download completed export job data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export file downloaded. The CSV data is gzip-compressed and the response has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Encoding: gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, so most HTTP clients decompress it automatically."},"children":[]}]}]}],"mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1269"}},"schemaId":"schema_1269","headers":{"Content-Encoding":{"description":"The encoding applied to the response body.","schema":{"type":"string","example":"gzip"}}},"headerSchemaId":"schema_1270"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"When the job is not found, was created by a different teammate, or is not complete, or the export file is no longer available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found","paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Export file not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found","paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Export file not found"]}],"pointer":"/paths/~1download~1reporting_data~1{job_identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1269","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1269"}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found","paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Export file not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found","paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Export file not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting-data-export/paths/~1download~1reporting_data~1{job_identifier}/get"}],"panels":[]}]},"httpPath":"/download/reporting_data/{job_identifier}"}],"content":{"contentType":"group","meta":{"name":"Reporting Data Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reporting Data Export","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Everything about Reporting Data Export. See this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.intercom.com/help/en/articles/12089688-api-metrics-documentation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on using the data to generate various metrics."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/export/reporting_data/enqueue","summary":"Enqueue a new reporting data export job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reporting-data-export/paths/~1export~1reporting_data~1enqueue/post","deprecated":false},{"title":"/export/reporting_data/{job_identifier}","summary":"Get export job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting-data-export/paths/~1export~1reporting_data~1{job_identifier}/get","deprecated":false},{"title":"/export/reporting_data/get_datasets","summary":"List available datasets and attributes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting-data-export/paths/~1export~1reporting_data~1get_datasets/get","deprecated":false},{"title":"/download/reporting_data/{job_identifier}","summary":"Download completed export job data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting-data-export/paths/~1download~1reporting_data~1{job_identifier}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/docs/references/rest-api/api.intercom.io/roles","routeSlug":"/docs/references/rest-api/api.intercom.io/roles","items":[{"label":"List all roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/roles/listroles","routeSlug":"/docs/references/rest-api/api.intercom.io/roles/listroles","metadata":{"seo":{"title":"List all roles","description":"You can fetch a list of all roles in the workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRoles","name":"List all roles","isWebhook":false,"pointer":"/paths/~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of all roles in the workspace.\n\nRoles define what a teammate can do in a workspace. The teammates endpoint\nreturns the role a teammate holds, but only the roles that are currently\nassigned, and only their id and name. This endpoint lists every role in the\nworkspace, each with its description.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/roles","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/roles","href":"roles/listroles","openApiOperationId":"listRoles","summary":"List all roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/role_list","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/role_list","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1roles/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1roles/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/role_list","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/role_list","exampleIds":["paths/~1roles/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1roles/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1roles/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/listroles"}],"panels":[]}]},"httpPath":"/roles"},{"label":"Retrieve a role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/roles/retrieverole","routeSlug":"/docs/references/rest-api/api.intercom.io/roles/retrieverole","metadata":{"seo":{"title":"Retrieve a role","description":"You can fetch the details of a single role by its id, including its description, which the teammates endpoint does not return."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveRole","name":"Retrieve a role","isWebhook":false,"pointer":"/paths/~1roles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single role by its id, including its\ndescription, which the teammates endpoint does not return.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given role.","required":true,"example":"991267902"}],"pointer":"/paths/~1roles~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1roles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/roles/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"991267902","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/roles/{id}","href":"roles/retrieverole","openApiOperationId":"retrieveRole","summary":"Retrieve a role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/role","exampleIds":["paths/~1roles~1{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/role","exampleIds":["paths/~1roles~1{id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Role not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/404/content/application~1json/examples/Role not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/404/content/application~1json/examples/Role not found"]}],"pointer":"/paths/~1roles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/role","exampleIds":["paths/~1roles~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/role","exampleIds":["paths/~1roles~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/404/content/application~1json/examples/Role not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1roles~1{id}/get/responses/404/content/application~1json/examples/Role not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/retrieverole"}],"panels":[]}]},"httpPath":"/roles/{id}"},{"type":"link","label":"Role","link":"/docs/references/rest-api/api.intercom.io/roles/role","routeSlug":"/docs/references/rest-api/api.intercom.io/roles/role","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"role"},"seo":{"title":"Role"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Role","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/role"},"children":[]}]}]}},{"type":"link","label":"Role List","link":"/docs/references/rest-api/api.intercom.io/roles/role_list","routeSlug":"/docs/references/rest-api/api.intercom.io/roles/role_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"role_list"},"seo":{"title":"Role List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Role List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/role_list"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Roles"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Role","link":"/roles/role","deprecated":false},{"title":"Role List","link":"/roles/role_list","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/roles","summary":"List all roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/listroles","deprecated":false},{"title":"/roles/{id}","summary":"Retrieve a role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/retrieverole","deprecated":false}]}]}]}]}},{"type":"group","label":"Segments","link":"/docs/references/rest-api/api.intercom.io/segments","routeSlug":"/docs/references/rest-api/api.intercom.io/segments","items":[{"label":"List attached segments for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/segments/listsegmentsforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/segments/listsegmentsforacontact","metadata":{"seo":{"title":"List attached segments for contact","description":"You can fetch a list of segments that are associated to a contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSegmentsForAContact","name":"List attached segments for contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attached segments for contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of segments that are associated to a contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/segments","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/segments","href":"segments/listsegmentsforacontact","openApiOperationId":"listSegmentsForAContact","summary":"List attached segments for contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_segments","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/listsegmentsforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/segments"},{"label":"List all segments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/segments/listsegments","routeSlug":"/docs/references/rest-api/api.intercom.io/segments/listsegments","metadata":{"seo":{"title":"List all segments","description":"You can fetch a list of all segments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSegments","name":"List all segments","isWebhook":false,"pointer":"/paths/~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all segments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all segments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment names are returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_count","in":"query","schemaId":"schema_1156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes the count of contacts that belong to each segment. The counts are added whenever this parameter has a value in the query string, even "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an empty one, so omit it entirely to leave them out. A bare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adds no counts. With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a company segment gets no count unless a contact segment has the same name, and then it shows that contact segment's count."},"children":[]}]}]}],"example":true},{"name":"type","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list company segments. Any other value, or no value, lists contact segments."},"children":[]}]}]}],"example":"company"}],"pointer":"/paths/~1segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/segments","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"include_count","in":"query","required":false,"example":true,"schemaId":"schema_1156"},{"name":"type","in":"query","required":false,"example":"company","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/segments","href":"segments/listsegments","openApiOperationId":"listSegments","summary":"List all segments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/segment_list","exampleIds":["paths/~1segments/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/segment_list","exampleIds":["paths/~1segments/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/segment_list","exampleIds":["paths/~1segments/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/segment_list","exampleIds":["paths/~1segments/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/listsegments"}],"panels":[]}]},"httpPath":"/segments"},{"label":"Retrieve a segment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/segments/retrievesegment","routeSlug":"/docs/references/rest-api/api.intercom.io/segments/retrievesegment","metadata":{"seo":{"title":"Retrieve a segment","description":"You can fetch the details of a single segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveSegment","name":"Retrieve a segment","isWebhook":false,"pointer":"/paths/~1segments~1{segment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single segment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The segment name is returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"segment_id","in":"path","schemaId":"schema_1152","description":"The unique identified of a given segment.","required":true,"example":"123"}],"pointer":"/paths/~1segments~1{segment_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_count","in":"query","schemaId":"schema_1156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes the count of contacts that belong to the segment. The count is added whenever this parameter has a value in the query string, even "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an empty one, so omit it entirely to leave it out. A bare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adds no count."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1segments~1{segment_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1segments~1{segment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/segments/{segment_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"segment_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[{"name":"include_count","in":"query","required":false,"example":true,"schemaId":"schema_1156"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/segments/{segment_id}","href":"segments/retrievesegment","openApiOperationId":"retrieveSegment","summary":"Retrieve a segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~1{segment_id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~1{segment_id}/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Segment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/404/content/application~1json/examples/Segment not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/404/content/application~1json/examples/Segment not found"]}],"pointer":"/paths/~1segments~1{segment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~1{segment_id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~1{segment_id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/404/content/application~1json/examples/Segment not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/404/content/application~1json/examples/Segment not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/retrievesegment"}],"panels":[]}]},"httpPath":"/segments/{segment_id}"},{"type":"link","label":"Segment","link":"/docs/references/rest-api/api.intercom.io/segments/segment","routeSlug":"/docs/references/rest-api/api.intercom.io/segments/segment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"segment"},"seo":{"title":"Segment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Segment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/segment"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Segments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Segments","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Segments"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Segment","link":"/segments/segment","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts/{contact_id}/segments","summary":"List attached segments for contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/segments/listsegmentsforacontact","deprecated":false},{"title":"/segments","summary":"List all segments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/segments/listsegments","deprecated":false},{"title":"/segments/{segment_id}","summary":"Retrieve a segment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/segments/retrievesegment","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription Types","link":"/docs/references/rest-api/api.intercom.io/subscription-types","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types","items":[{"label":"List subscriptions for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/subscription-types/listsubscriptionsforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types/listsubscriptionsforacontact","metadata":{"seo":{"title":"List subscriptions for a contact","description":"You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.This will return a list of Subscription Type objects that the contact is associated with."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptionsForAContact","name":"List subscriptions for a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscriptions for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a list of Subscription Type objects that the contact is associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data property will show a combined list of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.Opt-out subscription types that the user has opted-out from."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.Opt-in subscription types that the user has opted-in to receiving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/subscriptions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions","href":"subscription-types/listsubscriptionsforacontact","openApiOperationId":"listSubscriptionsForAContact","summary":"List subscriptions for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-types/listsubscriptionsforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/subscriptions"},{"label":"Add subscription to a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/subscription-types/attachsubscriptiontypetocontact","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types/attachsubscriptiontypetocontact","metadata":{"seo":{"title":"Add subscription to a contact","description":"You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachSubscriptionTypeToContact","name":"Add subscription to a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add subscription to a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a subscription type model for the subscription type that was added to the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"]}},"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/subscriptions","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions","href":"subscription-types/attachsubscriptiontypetocontact","openApiOperationId":"attachSubscriptionTypeToContact","summary":"Add subscription to a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1187","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-types/attachsubscriptiontypetocontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/subscriptions"},{"label":"Remove subscription from a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/subscription-types/detachsubscriptiontypetocontact","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types/detachsubscriptiontypetocontact","metadata":{"seo":{"title":"Remove subscription from a contact","description":"You can remove a specific subscription from a contact. This willreturn a subscription type model for the subscription type that was removedfrom the contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachSubscriptionTypeToContact","name":"Remove subscription from a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove subscription from a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can remove a specific subscription from a contact. This will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return a subscription type model for the subscription type that was removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"subscription_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the subscription type which is given by Intercom","required":true,"example":"37846"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/subscriptions/{subscription_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"},{"name":"subscription_id","in":"path","required":true,"example":"37846","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions/{subscription_id}","href":"subscription-types/detachsubscriptiontypetocontact","openApiOperationId":"detachSubscriptionTypeToContact","summary":"Remove subscription from a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-types/detachsubscriptiontypetocontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/subscriptions/{subscription_id}"},{"label":"List subscription types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/subscription-types/listsubscriptiontypes","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types/listsubscriptiontypes","metadata":{"seo":{"title":"List subscription types","description":"You can list all subscription types. A list of subscription type objects will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptionTypes","name":"List subscription types","isWebhook":false,"pointer":"/paths/~1subscription_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List subscription types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can list all subscription types. A list of subscription type objects will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1subscription_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription_types","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/subscription_types","href":"subscription-types/listsubscriptiontypes","openApiOperationId":"listSubscriptionTypes","summary":"List subscription types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1subscription_types/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1subscription_types/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types/get/responses/401/content/application~1json/examples/Token lacks required scope"]}],"pointer":"/paths/~1subscription_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1subscription_types/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type_list","exampleIds":["paths/~1subscription_types/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-types/listsubscriptiontypes"}],"panels":[]}]},"httpPath":"/subscription_types"},{"label":"Retrieve a subscription type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/subscription-types/getsubscriptiontype","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types/getsubscriptiontype","metadata":{"seo":{"title":"Retrieve a subscription type","description":"You can fetch the details of a single subscription type by making a GET request to https://api.intercom.io/subscription_types/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionType","name":"Retrieve a subscription type","isWebhook":false,"pointer":"/paths/~1subscription_types~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single subscription type by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/subscription_types/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the subscription type.","required":true,"example":"123"}],"pointer":"/paths/~1subscription_types~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1subscription_types~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription_types/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/subscription_types/{id}","href":"subscription-types/getsubscriptiontype","openApiOperationId":"getSubscriptionType","summary":"Retrieve a subscription type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1subscription_types~1{id}/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1subscription_types~1{id}/get/responses/200/content/application~1json/examples/Successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Subscription type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/404/content/application~1json/examples/Subscription type not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/404/content/application~1json/examples/Subscription type not found"]}],"pointer":"/paths/~1subscription_types~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1subscription_types~1{id}/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1subscription_types~1{id}/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/404/content/application~1json/examples/Subscription type not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types~1{id}/get/responses/404/content/application~1json/examples/Subscription type not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-types/getsubscriptiontype"}],"panels":[]}]},"httpPath":"/subscription_types/{id}"},{"type":"link","label":"Subscription Types","link":"/docs/references/rest-api/api.intercom.io/subscription-types/subscription_type","routeSlug":"/docs/references/rest-api/api.intercom.io/subscription-types/subscription_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"subscription_type"},"seo":{"title":"Subscription Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription Types","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/subscription_type"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Subscription Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription Types","showPageActions":true},{"nodeType":"markdoc","content":"Everything about subscription types"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Subscription Types","link":"/subscription-types/subscription_type","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts/{contact_id}/subscriptions","summary":"List subscriptions for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-types/listsubscriptionsforacontact","deprecated":false},{"title":"/contacts/{contact_id}/subscriptions","summary":"Add subscription to a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription-types/attachsubscriptiontypetocontact","deprecated":false},{"title":"/contacts/{contact_id}/subscriptions/{subscription_id}","summary":"Remove subscription from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscription-types/detachsubscriptiontypetocontact","deprecated":false},{"title":"/subscription_types","summary":"List subscription types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-types/listsubscriptiontypes","deprecated":false},{"title":"/subscription_types/{id}","summary":"Retrieve a subscription type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-types/getsubscriptiontype","deprecated":false}]}]}]}]}},{"type":"group","label":"Switch","link":"/docs/references/rest-api/api.intercom.io/switch","routeSlug":"/docs/references/rest-api/api.intercom.io/switch","items":[{"label":"Create a phone Switch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/switch/createphoneswitch","routeSlug":"/docs/references/rest-api/api.intercom.io/switch/createphoneswitch","metadata":{"seo":{"title":"Create a phone Switch","description":"You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPhoneSwitch","name":"Create a phone Switch","isWebhook":false,"pointer":"/paths/~1phone_call_redirects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a phone Switch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1phone_call_redirects/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_phone_switch_request","exampleIds":["paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes"]}},"schemaId":"components/schemas/create_phone_switch_request","exampleIds":["paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes"],"pointer":"/paths/~1phone_call_redirects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/phone_call_redirects","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_phone_switch_request","exampleIds":["paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes"]}},"responseCodes":["200","400","401","422"],"pointer":"/phone_call_redirects","href":"switch/createphoneswitch","openApiOperationId":"createPhoneSwitch","summary":"Create a phone Switch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_phone_switch_request","exampleIds":["paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_phone_switch_request","exampleIds":["paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number","paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/phone_switch","exampleIds":["paths/~1phone_call_redirects/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/phone_switch","exampleIds":["paths/~1phone_call_redirects/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"The phone number lookup or the SMS send failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - exception sending sms","paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - invalid number"]}},"exampleIds":["paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - exception sending sms","paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - invalid number"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Feature not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Feature not available"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was invalid. The response is an object with a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caller_phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"landline_phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twilio_settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the workspace has no Twilio account to send the SMS, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Any other invalid input returns its own key, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"send_notification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Twilio account not found","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Missing phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid custom attributes"]}},"exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Twilio account not found","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Missing phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid custom attributes"]}],"pointer":"/paths/~1phone_call_redirects/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/phone_switch","exampleIds":["paths/~1phone_call_redirects/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/phone_switch","exampleIds":["paths/~1phone_call_redirects/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","exampleIds":["paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - exception sending sms","paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - invalid number"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - exception sending sms","paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - invalid number"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Feature not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Feature not available"]}}},{"code":"422","exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Twilio account not found","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Missing phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid custom attributes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Twilio account not found","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Missing phone number","paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid custom attributes"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/switch/createphoneswitch"}],"panels":[]}]},"httpPath":"/phone_call_redirects"}],"content":{"contentType":"group","meta":{"name":"Switch"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Switch","showPageActions":true},{"nodeType":"markdoc","content":"Everything about Switch"},{"nodeType":"external-docs","url":"https://www.intercom.com/switch","description":"Meet Switch: from on hold to messaging in just a few taps"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/phone_call_redirects","summary":"Create a phone Switch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/switch/createphoneswitch","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/docs/references/rest-api/api.intercom.io/tags","routeSlug":"/docs/references/rest-api/api.intercom.io/tags","items":[{"label":"Add a tag to an external page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoexternalpage","metadata":{"seo":{"title":"Add a tag to an external page","description":"Apply an existing tag to an external page. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToExternalPage","name":"Add a tag to an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to an external page. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission. Pages uploaded as files can't be tagged and return a 404."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true,"example":"1234"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ai/external_pages/{external_page_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"external_page_id","in":"path","required":true,"example":"1234","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/ai/external_pages/{external_page_id}/tags","href":"tags/attachtagtoexternalpage","openApiOperationId":"attachTagToExternalPage","summary":"Add a tag to an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1161","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"External page, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtoexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{external_page_id}/tags"},{"label":"Remove a tag from an external page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromexternalpage","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromexternalpage","metadata":{"seo":{"title":"Remove a tag from an external page","description":"Remove a tag from an external page. Returns the tag that was removed, with nullapplied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromExternalPage","name":"Remove a tag from an external page","isWebhook":false,"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from an external page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from an external page. Returns the tag that was removed, with null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission. Pages uploaded as files can't be tagged and return a 404."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth tokens must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_ai_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_page_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the external page which is given by Intercom.","required":true,"example":"1234"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ai/external_pages/{external_page_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"external_page_id","in":"path","required":true,"example":"1234","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/ai/external_pages/{external_page_id}/tags/{id}","href":"tags/detachtagfromexternalpage","openApiOperationId":"detachTagFromExternalPage","summary":"Remove a tag from an external page"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"External page or tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found","paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfromexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{external_page_id}/tags/{id}"},{"label":"Add a tag to an article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoarticle","metadata":{"seo":{"title":"Add a tag to an article","description":"Apply an existing tag to an article. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToArticle","name":"Add a tag to an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to an article. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1articles~1{article_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/articles/{article_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/articles/{article_id}/tags","href":"tags/attachtagtoarticle","openApiOperationId":"attachTagToArticle","summary":"Add a tag to an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Article, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1articles~1{article_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtoarticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}/tags"},{"label":"Remove a tag from an article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromarticle","metadata":{"seo":{"title":"Remove a tag from an article","description":"Remove a tag from an article. Returns the tag that was removed, with nullapplied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromArticle","name":"Remove a tag from an article","isWebhook":false,"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from an article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from an article. Returns the tag that was removed, with null"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/articles/{article_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/articles/{article_id}/tags/{id}","href":"tags/detachtagfromarticle","openApiOperationId":"detachTagFromArticle","summary":"Remove a tag from an article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Article or tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1articles~1{article_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found","paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfromarticle"}],"panels":[]}]},"httpPath":"/articles/{article_id}/tags/{id}"},{"label":"Add a tag to an internal article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtointernalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtointernalarticle","metadata":{"seo":{"title":"Add a tag to an internal article","description":"Apply an existing tag to an internal article. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToInternalArticle","name":"Add a tag to an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to an internal article. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/internal_articles/{internal_article_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/internal_articles/{internal_article_id}/tags","href":"tags/attachtagtointernalarticle","openApiOperationId":"attachTagToInternalArticle","summary":"Add a tag to an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Internal article, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtointernalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}/tags"},{"label":"Remove a tag from an internal article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfrominternalarticle","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfrominternalarticle","metadata":{"seo":{"title":"Remove a tag from an internal article","description":"Remove a tag from an internal article. Returns the tag that was removed, withnull applied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromInternalArticle","name":"Remove a tag from an internal article","isWebhook":false,"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from an internal article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from an internal article. Returns the tag that was removed, with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_articles_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal_article_id","in":"path","schemaId":"schema_1150","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"admin_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional id of a teammate. The id is checked, and an unknown teammate returns a 404 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error, but the removal is not recorded against the teammate."},"children":[]}]}]}],"example":"1234"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/internal_articles/{internal_article_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"internal_article_id","in":"path","required":true,"example":123,"schemaId":"schema_1150"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[{"name":"admin_id","in":"query","required":false,"example":"1234","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/internal_articles/{internal_article_id}/tags/{id}","href":"tags/detachtagfrominternalarticle","openApiOperationId":"detachTagFromInternalArticle","summary":"Remove a tag from an internal article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Internal article, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfrominternalarticle"}],"panels":[]}]},"httpPath":"/internal_articles/{internal_article_id}/tags/{id}"},{"label":"List tags attached to a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/listtagsforacontact","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/listtagsforacontact","metadata":{"seo":{"title":"List tags attached to a contact","description":"You can fetch a list of all tags that are attached to a specific contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTagsForAContact","name":"List tags attached to a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tags attached to a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch a list of all tags that are attached to a specific contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{contact_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags","href":"tags/listtagsforacontact","openApiOperationId":"listTagsForAContact","summary":"List tags attached to a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/listtagsforacontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/tags"},{"label":"Add tag to a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtocontact","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtocontact","metadata":{"seo":{"title":"Add tag to a contact","description":"You can tag a specific contact. This will return a tag object forthe tag that was added to the contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToContact","name":"Add tag to a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag to a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can tag a specific contact. This will return a tag object for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the tag that was added to the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{contact_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags","href":"tags/attachtagtocontact","openApiOperationId":"attachTagToContact","summary":"Add tag to a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1188","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found","paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtocontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/tags"},{"label":"Remove tag from a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromcontact","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromcontact","metadata":{"seo":{"title":"Remove tag from a contact","description":"You can remove tag from a specific contact. This will return atag object for the tag that was removed from the contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromContact","name":"Remove tag from a contact","isWebhook":false,"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can remove tag from a specific contact. This will return a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag object for the tag that was removed from the contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contact_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"tag_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the tag which is given by Intercom","required":true,"example":"7522907"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_1152"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags/{tag_id}","href":"tags/detachtagfromcontact","openApiOperationId":"detachTagFromContact","summary":"Remove tag from a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfromcontact"}],"panels":[]}]},"httpPath":"/contacts/{contact_id}/tags/{tag_id}"},{"label":"Add a tag to a content snippet","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtocontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtocontentsnippet","metadata":{"seo":{"title":"Add a tag to a content snippet","description":"Apply an existing tag to a content snippet. Returns the tag that was applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToContentSnippet","name":"Add a tag to a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an existing tag to a content snippet. Returns the tag that was applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag must already exist in the workspace (create tags with the Tags API),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_snippet_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content snippet.","required":true,"example":"123"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/content_snippets/{content_snippet_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"content_snippet_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401","403","404"],"pointer":"/content_snippets/{content_snippet_id}/tags","href":"tags/attachtagtocontentsnippet","openApiOperationId":"attachTagToContentSnippet","summary":"Add a tag to a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1163","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Content snippet, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtocontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{content_snippet_id}/tags"},{"label":"Remove a tag from a content snippet","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromcontentsnippet","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromcontentsnippet","metadata":{"seo":{"title":"Remove a tag from a content snippet","description":"Remove a tag from a content snippet. Returns the tag that was removed, withnull applied_at and applied_by."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromContentSnippet","name":"Remove a tag from a content snippet","isWebhook":false,"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tag from a content snippet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a tag from a content snippet. Returns the tag that was removed, with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticating teammate must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manage_knowledge_base_content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_content_snippets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_snippet_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the content snippet.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier of the tag to remove, as given by Intercom.","required":true,"example":"7522907"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"admin_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional id of a teammate. The id is checked, and an unknown teammate returns a 404 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error, but the removal is not recorded against the teammate."},"children":[]}]}]}],"example":"1234"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/content_snippets/{content_snippet_id}/tags/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"content_snippet_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[{"name":"admin_id","in":"query","required":false,"example":"1234","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/content_snippets/{content_snippet_id}/tags/{id}","href":"tags/detachtagfromcontentsnippet","openApiOperationId":"detachTagFromContentSnippet","summary":"Remove a tag from a content snippet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"Content snippet, tag or teammate not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}],"pointer":"/paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found","paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfromcontentsnippet"}],"panels":[]}]},"httpPath":"/content_snippets/{content_snippet_id}/tags/{id}"},{"label":"Add tag to a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoconversation","metadata":{"seo":{"title":"Add tag to a conversation","description":"You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToConversation","name":"Add tag to a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag to a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"]}},"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{conversation_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/{conversation_id}/tags","href":"tags/attachtagtoconversation","openApiOperationId":"attachTagToConversation","summary":"Add tag to a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtoconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/tags"},{"label":"Remove tag from a conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromconversation","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromconversation","metadata":{"seo":{"title":"Remove tag from a conversation","description":"You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromConversation","name":"Remove tag from a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversation_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"},{"name":"tag_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tag_id"},"children":[]}]}]}],"required":true,"example":"7522907"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/{conversation_id}/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"conversation_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/{conversation_id}/tags/{tag_id}","href":"tags/detachtagfromconversation","openApiOperationId":"detachTagFromConversation","summary":"Remove tag from a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfromconversation"}],"panels":[]}]},"httpPath":"/conversations/{conversation_id}/tags/{tag_id}"},{"label":"List all tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/listtags","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/listtags","metadata":{"seo":{"title":"List all tags","description":"You can fetch a list of all tags for a given workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTags","name":"List all tags","isWebhook":false,"pointer":"/paths/~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch a list of all tags for a given workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns that one tag object instead of a list. Passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns a list of the tags applied to a single contact or company."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_1152","description":"The unique identifier of a tag. When set, a single tag object is returned instead of a list.","example":"123"},{"name":"taggable_type","in":"query","schemaId":"schema_1271","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list the tags applied to one contact or company instead of the whole workspace. Identify it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"user"},{"name":"taggable_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Intercom id of the contact or company whose tags you want, used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"536e564f316c83104c000020"},{"name":"user_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external id of the contact whose tags you want, used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type=user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"25"},{"name":"email","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the contact whose tags you want, used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type=user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"jane@example.com"},{"name":"company_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external id of the company whose tags you want, used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type=company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"6"},{"name":"name","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company whose tags you want, used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type=company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Intercom"}],"pointer":"/paths/~1tags/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":false,"example":"123","schemaId":"schema_1152"},{"name":"taggable_type","in":"query","required":false,"example":"user","schemaId":"schema_1271"},{"name":"taggable_id","in":"query","required":false,"example":"536e564f316c83104c000020","schemaId":"schema_1152"},{"name":"user_id","in":"query","required":false,"example":"25","schemaId":"schema_1152"},{"name":"email","in":"query","required":false,"example":"jane@example.com","schemaId":"schema_1152"},{"name":"company_id","in":"query","required":false,"example":"6","schemaId":"schema_1152"},{"name":"name","in":"query","required":false,"example":"Intercom","schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/tags","href":"tags/listtags","openApiOperationId":"listTags","summary":"List all tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1272","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful","paths/~1tags/get/responses/200/content/application~1json/examples/single tag"]}},"schemaId":"schema_1272","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful","paths/~1tags/get/responses/200/content/application~1json/examples/single tag"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag, contact or company not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/get/responses/404/content/application~1json/examples/Contact not found","paths/~1tags/get/responses/404/content/application~1json/examples/Company not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/get/responses/404/content/application~1json/examples/Contact not found","paths/~1tags/get/responses/404/content/application~1json/examples/Company not found"]}],"pointer":"/paths/~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1272","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful","paths/~1tags/get/responses/200/content/application~1json/examples/single tag"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1272","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful","paths/~1tags/get/responses/200/content/application~1json/examples/single tag"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/get/responses/404/content/application~1json/examples/Contact not found","paths/~1tags/get/responses/404/content/application~1json/examples/Company not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/get/responses/404/content/application~1json/examples/Contact not found","paths/~1tags/get/responses/404/content/application~1json/examples/Company not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/listtags"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Create or update a tag, Tag or untag companies, Tag contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/createtag","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/createtag","metadata":{"seo":{"title":"Create or update a tag, Tag or untag companies, Tag contacts","description":"You can use this endpoint to perform the following operations:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTag","name":"Create or update a tag, Tag or untag companies, Tag contacts","isWebhook":false,"pointer":"/paths/~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update a tag, Tag or untag companies, Tag contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this endpoint to perform the following operations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Create a new tag:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Update an existing tag:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Tag Companies:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. Untag Companies:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5. Tag Multiple Users:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each operation will return a tag object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts and companies listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that do not exist are skipped: they are left out of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrays in the response and the request still succeeds. With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids_to_add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taggable_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a contact id that does not exist returns a 404, while a company id that does not exist is skipped. With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids_to_add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrays in the response are always empty, and a 404 still leaves the tag created or renamed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1273","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found"]}},"schemaId":"schema_1273","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found"],"pointer":"/paths/~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1273","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/tags","href":"tags/createtag","openApiOperationId":"createTag","summary":"Create or update a tag, Tag or untag companies, Tag contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1273","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1273","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped","paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_create_response","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful","paths/~1tags/post/responses/200/content/application~1json/examples/Companies tagged"]}},"schemaId":"components/schemas/tag_create_response","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful","paths/~1tags/post/responses/200/content/application~1json/examples/Companies tagged"]},{"code":"400","description":"Invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/400/content/application~1json/examples/Invalid parameters"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/400/content/application~1json/examples/Invalid parameters"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag or contact not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/post/responses/404/content/application~1json/examples/Contact in ids_to_add not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/post/responses/404/content/application~1json/examples/Contact in ids_to_add not found"]}],"pointer":"/paths/~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_create_response","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful","paths/~1tags/post/responses/200/content/application~1json/examples/Companies tagged"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_create_response","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful","paths/~1tags/post/responses/200/content/application~1json/examples/Companies tagged"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/400/content/application~1json/examples/Invalid parameters"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/400/content/application~1json/examples/Invalid parameters"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/post/responses/404/content/application~1json/examples/Contact in ids_to_add not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Tag not found","paths/~1tags/post/responses/404/content/application~1json/examples/Contact in ids_to_add not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/createtag"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Find a specific tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/findtag","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/findtag","metadata":{"seo":{"title":"Find a specific tag","description":"You can fetch the details of tags that are on the workspace by their id.This will return a tag object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findTag","name":"Find a specific tag","isWebhook":false,"pointer":"/paths/~1tags~1{tag_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Find a specific tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of tags that are on the workspace by their id."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a tag object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given tag","required":true,"example":"123"}],"pointer":"/paths/~1tags~1{tag_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tags~1{tag_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"tag_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/tags/{tag_id}","href":"tags/findtag","openApiOperationId":"findTag","summary":"Find a specific tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags~1{tag_id}/get/responses/200/content/application~1json/examples/Tag found"]}},"schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags~1{tag_id}/get/responses/200/content/application~1json/examples/Tag found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1tags~1{tag_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags~1{tag_id}/get/responses/200/content/application~1json/examples/Tag found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags~1{tag_id}/get/responses/200/content/application~1json/examples/Tag found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/findtag"}],"panels":[]}]},"httpPath":"/tags/{tag_id}"},{"label":"Delete tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/deletetag","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/deletetag","metadata":{"seo":{"title":"Delete tag","description":"You can delete the details of tags that are on the workspace by passing in the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTag","name":"Delete tag","isWebhook":false,"pointer":"/paths/~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete the details of tags that are on the workspace by passing in the id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given tag","required":true,"example":"123"}],"pointer":"/paths/~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"tag_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/tags/{tag_id}","href":"tags/deletetag","openApiOperationId":"deleteTag","summary":"Delete tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful"},{"code":"400","description":"Tag has dependent objects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized","paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Resource not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetag"}],"panels":[]}]},"httpPath":"/tags/{tag_id}"},{"label":"Add tag to a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/attachtagtoticket","metadata":{"seo":{"title":"Add tag to a ticket","description":"You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToTicket","name":"Add tag to a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag to a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"]}},"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/{ticket_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/tickets/{ticket_id}/tags","href":"tags/attachtagtoticket","openApiOperationId":"attachTagToTicket","summary":"Add tag to a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Ticket not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/attachtagtoticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/tags"},{"label":"Remove tag from a ticket","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/detachtagfromticket","metadata":{"seo":{"title":"Remove tag from a ticket","description":"You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromTicket","name":"Remove tag from a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"},{"name":"tag_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the tag which is given by Intercom","required":true,"example":"7522907"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tickets/{ticket_id}/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/tickets/{ticket_id}/tags/{tag_id}","href":"tags/detachtagfromticket","openApiOperationId":"detachTagFromTicket","summary":"Remove tag from a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/detachtagfromticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/tags/{tag_id}"},{"type":"link","label":"Tag","link":"/docs/references/rest-api/api.intercom.io/tags/tag","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/tag","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tag"},"seo":{"title":"Tag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tag"},"children":[]}]}]}},{"type":"link","label":"Tag","link":"/docs/references/rest-api/api.intercom.io/tags/tag_basic","routeSlug":"/docs/references/rest-api/api.intercom.io/tags/tag_basic","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tag_basic"},"seo":{"title":"Tag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tag_basic"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Everything about tags"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Tag","link":"/tags/tag","deprecated":false},{"title":"Tag","link":"/tags/tag_basic","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ai/external_pages/{external_page_id}/tags","summary":"Add a tag to an external page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtoexternalpage","deprecated":false},{"title":"/ai/external_pages/{external_page_id}/tags/{id}","summary":"Remove a tag from an external page","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromexternalpage","deprecated":false},{"title":"/articles/{article_id}/tags","summary":"Add a tag to an article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtoarticle","deprecated":false},{"title":"/articles/{article_id}/tags/{id}","summary":"Remove a tag from an article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}/tags","summary":"Add a tag to an internal article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtointernalarticle","deprecated":false},{"title":"/internal_articles/{internal_article_id}/tags/{id}","summary":"Remove a tag from an internal article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfrominternalarticle","deprecated":false},{"title":"/contacts/{contact_id}/tags","summary":"List tags attached to a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/listtagsforacontact","deprecated":false},{"title":"/contacts/{contact_id}/tags","summary":"Add tag to a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtocontact","deprecated":false},{"title":"/contacts/{contact_id}/tags/{tag_id}","summary":"Remove tag from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromcontact","deprecated":false},{"title":"/content_snippets/{content_snippet_id}/tags","summary":"Add a tag to a content snippet","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtocontentsnippet","deprecated":false},{"title":"/content_snippets/{content_snippet_id}/tags/{id}","summary":"Remove a tag from a content snippet","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromcontentsnippet","deprecated":false},{"title":"/conversations/{conversation_id}/tags","summary":"Add tag to a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtoconversation","deprecated":false},{"title":"/conversations/{conversation_id}/tags/{tag_id}","summary":"Remove tag from a conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromconversation","deprecated":false},{"title":"/tags","summary":"List all tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/listtags","deprecated":false},{"title":"/tags","summary":"Create or update a tag, Tag or untag companies, Tag contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/createtag","deprecated":false},{"title":"/tags/{tag_id}","summary":"Find a specific tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/findtag","deprecated":false},{"title":"/tags/{tag_id}","summary":"Delete tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetag","deprecated":false},{"title":"/tickets/{ticket_id}/tags","summary":"Add tag to a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/attachtagtoticket","deprecated":false},{"title":"/tickets/{ticket_id}/tags/{tag_id}","summary":"Remove tag from a ticket","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromticket","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams","link":"/docs/references/rest-api/api.intercom.io/teams","routeSlug":"/docs/references/rest-api/api.intercom.io/teams","items":[{"label":"List all teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/teams/listteams","routeSlug":"/docs/references/rest-api/api.intercom.io/teams/listteams","metadata":{"seo":{"title":"List all teams","description":"This will return a list of team objects for the App."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTeams","name":"List all teams","isWebhook":false,"pointer":"/paths/~1teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all teams","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This will return a list of team objects for the App."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1teams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/teams","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/teams","href":"teams/listteams","openApiOperationId":"listTeams","summary":"List all teams"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team_list","exampleIds":["paths/~1teams/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/team_list","exampleIds":["paths/~1teams/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1teams/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team_list","exampleIds":["paths/~1teams/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team_list","exampleIds":["paths/~1teams/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1teams/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/listteams"}],"panels":[]}]},"httpPath":"/teams"},{"label":"Retrieve a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/teams/retrieveteam","routeSlug":"/docs/references/rest-api/api.intercom.io/teams/retrieveteam","metadata":{"seo":{"title":"Retrieve a team","description":"You can fetch the details of a single team, containing an array of admins that belong to this team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveTeam","name":"Retrieve a team","isWebhook":false,"pointer":"/paths/~1teams~1{team_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single team, containing an array of admins that belong to this team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"team_id","in":"path","schemaId":"schema_1152","description":"The unique identifier of a given team.","required":true,"example":"123"}],"pointer":"/paths/~1teams~1{team_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1teams~1{team_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/teams/{team_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"team_id","in":"path","required":true,"example":"123","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/teams/{team_id}","href":"teams/retrieveteam","openApiOperationId":"retrieveTeam","summary":"Retrieve a team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team","exampleIds":["paths/~1teams~1{team_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/team","exampleIds":["paths/~1teams~1{team_id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Team not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/404/content/application~1json/examples/Team not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/404/content/application~1json/examples/Team not found"]}],"pointer":"/paths/~1teams~1{team_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","exampleIds":["paths/~1teams~1{team_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team","exampleIds":["paths/~1teams~1{team_id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/404/content/application~1json/examples/Team not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}/get/responses/404/content/application~1json/examples/Team not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/retrieveteam"}],"panels":[]}]},"httpPath":"/teams/{team_id}"},{"label":"Retrieve team metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/teams/getteammetrics","routeSlug":"/docs/references/rest-api/api.intercom.io/teams/getteammetrics","metadata":{"seo":{"title":"Retrieve team metrics","description":"Returns real-time activity metrics for admins in the specified team. For each admin, the response includes counts of open, idle, and snoozed conversations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTeamMetrics","name":"Retrieve team metrics","isWebhook":false,"pointer":"/paths/~1teams~1{team_id}~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve team metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns real-time activity metrics for admins in the specified team. For each admin, the response includes counts of open, idle, and snoozed conversations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realtime_monitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to be enabled for your workspace."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"team_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the team to retrieve metrics for. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /teams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available team IDs."},"children":[]}]}]}],"required":true,"example":"42"}],"pointer":"/paths/~1teams~1{team_id}~1metrics/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"idle_threshold","in":"query","schemaId":"schema_1274","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of seconds after which an open conversation is considered idle. Clamped to the range 1–86400. Defaults to 1800 (30 minutes)."},"children":[]}]}]}]}],"pointer":"/paths/~1teams~1{team_id}~1metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1teams~1{team_id}~1metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/teams/{team_id}/metrics","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"team_id","in":"path","required":true,"example":"42","schemaId":"schema_1152"}],"query":[{"name":"idle_threshold","in":"query","required":false,"example":1800,"schemaId":"schema_1274"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/teams/{team_id}/metrics","href":"teams/getteammetrics","openApiOperationId":"getTeamMetrics","summary":"Retrieve team metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team_metric_list","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/200/content/application~1json/examples/successful_response"]}},"schemaId":"components/schemas/team_metric_list","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/200/content/application~1json/examples/successful_response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Feature not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/403/content/application~1json/examples/feature_disabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/403/content/application~1json/examples/feature_disabled"]},{"code":"404","description":"Team not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/404/content/application~1json/examples/team_not_found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/404/content/application~1json/examples/team_not_found"]}],"pointer":"/paths/~1teams~1{team_id}~1metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team_metric_list","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/200/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team_metric_list","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/200/content/application~1json/examples/successful_response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/403/content/application~1json/examples/feature_disabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/403/content/application~1json/examples/feature_disabled"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/404/content/application~1json/examples/team_not_found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{team_id}~1metrics/get/responses/404/content/application~1json/examples/team_not_found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/getteammetrics"}],"panels":[]}]},"httpPath":"/teams/{team_id}/metrics"},{"type":"link","label":"Team","link":"/docs/references/rest-api/api.intercom.io/teams/team","routeSlug":"/docs/references/rest-api/api.intercom.io/teams/team","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team"},"seo":{"title":"Team"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Teams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teams","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Teams"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Team","link":"/teams/team","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/teams","summary":"List all teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/listteams","deprecated":false},{"title":"/teams/{team_id}","summary":"Retrieve a team","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/retrieveteam","deprecated":false},{"title":"/teams/{team_id}/metrics","summary":"Retrieve team metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/getteammetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticket States","link":"/docs/references/rest-api/api.intercom.io/ticket-states","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-states","items":[{"label":"List all ticket states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-states/listticketstates","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-states/listticketstates","metadata":{"seo":{"title":"List all ticket states","description":"You can get a list of all ticket states for a workspace. The list includes archived ticket states; check archived on each one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTicketStates","name":"List all ticket states","isWebhook":false,"pointer":"/paths/~1ticket_states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all ticket states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can get a list of all ticket states for a workspace. The list includes archived ticket states; check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on each one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ticket_states","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/ticket_states","href":"ticket-states/listticketstates","openApiOperationId":"listTicketStates","summary":"List all ticket states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_state_list","exampleIds":["paths/~1ticket_states/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/ticket_state_list","exampleIds":["paths/~1ticket_states/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_states/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_states/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_state_list","exampleIds":["paths/~1ticket_states/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_state_list","exampleIds":["paths/~1ticket_states/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_states/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_states/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-states/listticketstates"}],"panels":[]}]},"httpPath":"/ticket_states"}],"content":{"contentType":"group","meta":{"name":"Ticket States"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket States","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your ticket states"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ticket_states","summary":"List all ticket states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-states/listticketstates","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticket Type Attributes","link":"/docs/references/rest-api/api.intercom.io/ticket-type-attributes","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-type-attributes","items":[{"label":"Create a new attribute for a ticket type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-type-attributes/createtickettypeattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-type-attributes/createtickettypeattribute","metadata":{"seo":{"title":"Create a new attribute for a ticket type","description":"You can create a new attribute for a ticket type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTicketTypeAttribute","name":"Create a new attribute for a ticket type","isWebhook":false,"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new attribute for a ticket type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can create a new attribute for a ticket type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_type_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the ticket type which is given by Intercom.","required":true}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created"]}},"schemaId":"components/schemas/create_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created"],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ticket_types/{ticket_type_id}/attributes","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_type_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created"]}},"responseCodes":["200","400","401"],"pointer":"/ticket_types/{ticket_type_id}/attributes","href":"ticket-type-attributes/createtickettypeattribute","openApiOperationId":"createTicketTypeAttribute","summary":"Create a new attribute for a ticket type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket Type Attribute created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/200/content/application~1json/examples/Ticket Type Attribute created"]}},"schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/200/content/application~1json/examples/Ticket Type Attribute created"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Invalid data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/List without enough options"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Invalid data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/List without enough options"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/200/content/application~1json/examples/Ticket Type Attribute created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/200/content/application~1json/examples/Ticket Type Attribute created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Invalid data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/List without enough options"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Invalid data_type","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/List without enough options"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-type-attributes/createtickettypeattribute"}],"panels":[]}]},"httpPath":"/ticket_types/{ticket_type_id}/attributes"},{"label":"Update an existing attribute for a ticket type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-type-attributes/updatetickettypeattribute","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-type-attributes/updatetickettypeattribute","metadata":{"seo":{"title":"Update an existing attribute for a ticket type","description":"You can update an existing attribute for a ticket type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTicketTypeAttribute","name":"Update an existing attribute for a ticket type","isWebhook":false,"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing attribute for a ticket type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can update an existing attribute for a ticket type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_type_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the ticket type which is given by Intercom.","required":true},{"name":"attribute_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the ticket type attribute which is given by Intercom.","required":true}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"]}},"schemaId":"components/schemas/update_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ticket_types/{ticket_type_id}/attributes/{attribute_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_type_id","in":"path","required":true,"schemaId":"schema_1152"},{"name":"attribute_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"]}},"responseCodes":["200","401"],"pointer":"/ticket_types/{ticket_type_id}/attributes/{attribute_id}","href":"ticket-type-attributes/updatetickettypeattribute","openApiOperationId":"updateTicketTypeAttribute","summary":"Update an existing attribute for a ticket type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_ticket_type_attribute_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket Type Attribute updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated"]}},"schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type_attribute","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-type-attributes/updatetickettypeattribute"}],"panels":[]}]},"httpPath":"/ticket_types/{ticket_type_id}/attributes/{attribute_id}"}],"content":{"contentType":"group","meta":{"name":"Ticket Type Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Type Attributes","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your ticket type attributes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ticket_types/{ticket_type_id}/attributes","summary":"Create a new attribute for a ticket type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-type-attributes/createtickettypeattribute","deprecated":false},{"title":"/ticket_types/{ticket_type_id}/attributes/{attribute_id}","summary":"Update an existing attribute for a ticket type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticket-type-attributes/updatetickettypeattribute","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticket Types","link":"/docs/references/rest-api/api.intercom.io/ticket-types","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-types","items":[{"label":"List all ticket types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-types/listtickettypes","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-types/listtickettypes","metadata":{"seo":{"title":"List all ticket types","description":"You can get a list of all ticket types for a workspace. The list includes archived ticket types and ticket types that Intercom creates itself."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTicketTypes","name":"List all ticket types","isWebhook":false,"pointer":"/paths/~1ticket_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all ticket types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can get a list of all ticket types for a workspace. The list includes archived ticket types and ticket types that Intercom creates itself."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ticket_types","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/ticket_types","href":"ticket-types/listtickettypes","openApiOperationId":"listTicketTypes","summary":"List all ticket types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type_list","exampleIds":["paths/~1ticket_types/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/ticket_type_list","exampleIds":["paths/~1ticket_types/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type_list","exampleIds":["paths/~1ticket_types/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type_list","exampleIds":["paths/~1ticket_types/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-types/listtickettypes"}],"panels":[]}]},"httpPath":"/ticket_types"},{"label":"Create a ticket type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-types/createtickettype","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-types/createtickettype","metadata":{"seo":{"title":"Create a ticket type","description":"You can create a new ticket type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTicketType","name":"Create a ticket type","isWebhook":false,"pointer":"/paths/~1ticket_types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a ticket type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a new ticket type."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 Creating ticket types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every ticket type will be created with two default attributes: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default_title"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default_description"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"icon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" propery, use an emoji from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://twemoji-cheatsheet.vercel.app/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twemoji Cheatsheet"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_type_request","exampleIds":["paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created"]}},"schemaId":"components/schemas/create_ticket_type_request","exampleIds":["paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created"],"pointer":"/paths/~1ticket_types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ticket_types","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_ticket_type_request","exampleIds":["paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created"]}},"responseCodes":["200","400","401"],"pointer":"/ticket_types","href":"ticket-types/createtickettype","openApiOperationId":"createTicketType","summary":"Create a ticket type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/create_ticket_type_request","exampleIds":["paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_type_request","exampleIds":["paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket type created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types/post/responses/200/content/application~1json/examples/Ticket type created"]}},"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types/post/responses/200/content/application~1json/examples/Ticket type created"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Customer ticket type cannot be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Tracker ticket type must be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid icon"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Customer ticket type cannot be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Tracker ticket type must be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid icon"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types/post/responses/200/content/application~1json/examples/Ticket type created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types/post/responses/200/content/application~1json/examples/Ticket type created"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Customer ticket type cannot be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Tracker ticket type must be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid icon"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid category","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Duplicate name","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Customer ticket type cannot be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Tracker ticket type must be internal","paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid icon"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-types/createtickettype"}],"panels":[]}]},"httpPath":"/ticket_types"},{"label":"Retrieve a ticket type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-types/gettickettype","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-types/gettickettype","metadata":{"seo":{"title":"Retrieve a ticket type","description":"You can fetch the details of a single ticket type. Archived ticket types are returned as well."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTicketType","name":"Retrieve a ticket type","isWebhook":false,"pointer":"/paths/~1ticket_types~1{ticket_type_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a ticket type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single ticket type. Archived ticket types are returned as well."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_type_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the ticket type which is given by Intercom.","required":true}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ticket_types/{ticket_type_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_type_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/ticket_types/{ticket_type_id}","href":"ticket-types/gettickettype","openApiOperationId":"getTicketType","summary":"Retrieve a ticket type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket type found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/200/content/application~1json/examples/Ticket type found"]}},"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/200/content/application~1json/examples/Ticket type found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Ticket type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/404/content/application~1json/examples/Ticket type not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/404/content/application~1json/examples/Ticket type not found"]}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/200/content/application~1json/examples/Ticket type found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/200/content/application~1json/examples/Ticket type found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/404/content/application~1json/examples/Ticket type not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/get/responses/404/content/application~1json/examples/Ticket type not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-types/gettickettype"}],"panels":[]}]},"httpPath":"/ticket_types/{ticket_type_id}"},{"label":"Update a ticket type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/ticket-types/updatetickettype","routeSlug":"/docs/references/rest-api/api.intercom.io/ticket-types/updatetickettype","metadata":{"seo":{"title":"Update a ticket type","description":"You can update a ticket type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTicketType","name":"Update a ticket type","isWebhook":false,"pointer":"/paths/~1ticket_types~1{ticket_type_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a ticket type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update a ticket type."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 Updating a ticket type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"icon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" propery, use an emoji from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://twemoji-cheatsheet.vercel.app/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twemoji Cheatsheet"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_type_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the ticket type which is given by Intercom.","required":true}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_ticket_type_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated"]}},"schemaId":"components/schemas/update_ticket_type_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated"],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ticket_types/{ticket_type_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_type_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_ticket_type_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated"]}},"responseCodes":["200","401"],"pointer":"/ticket_types/{ticket_type_id}","href":"ticket-types/updatetickettype","openApiOperationId":"updateTicketType","summary":"Update a ticket type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_ticket_type_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_ticket_type_request","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket type updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/200/content/application~1json/examples/Ticket type updated"]}},"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/200/content/application~1json/examples/Ticket type updated"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/200/content/application~1json/examples/Ticket type updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/200/content/application~1json/examples/Ticket type updated"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-types/updatetickettype"}],"panels":[]}]},"httpPath":"/ticket_types/{ticket_type_id}"}],"content":{"contentType":"group","meta":{"name":"Ticket Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Types","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your ticket types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ticket_types","summary":"List all ticket types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-types/listtickettypes","deprecated":false},{"title":"/ticket_types","summary":"Create a ticket type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-types/createtickettype","deprecated":false},{"title":"/ticket_types/{ticket_type_id}","summary":"Retrieve a ticket type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-types/gettickettype","deprecated":false},{"title":"/ticket_types/{ticket_type_id}","summary":"Update a ticket type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticket-types/updatetickettype","deprecated":false}]}]}]}]}},{"type":"group","label":"Tickets","link":"/docs/references/rest-api/api.intercom.io/tickets","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets","items":[{"label":"Reply to a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/replyticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/replyticket","metadata":{"seo":{"title":"Reply to a ticket","description":"You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replyTicket","name":"Reply to a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1reply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reply to a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1275","required":true}],"pointer":"/paths/~1tickets~1{ticket_id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1276","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"schema_1276","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1tickets~1{ticket_id}~1reply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/{ticket_id}/reply","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"123","schemaId":"schema_1275"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1276","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/tickets/{ticket_id}/reply","href":"tickets/replyticket","openApiOperationId":"replyTicket","summary":"Reply to a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1276","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1276","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply","paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Admin Reply to send Quick Reply Options","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_reply","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply"]}},"schemaId":"components/schemas/ticket_reply","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a back-office ticket","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a tracker ticket"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a back-office ticket","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a tracker ticket"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1reply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_reply","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_reply","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a back-office ticket","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a tracker ticket"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a back-office ticket","paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a tracker ticket"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/replyticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/reply"},{"label":"Add tag to a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/attachtagtoticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/attachtagtoticket","metadata":{"seo":{"title":"Add tag to a ticket","description":"You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachTagToTicket","name":"Add tag to a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag to a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"]}},"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/{ticket_id}/tags","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/tickets/{ticket_id}/tags","href":"tickets/attachtagtoticket","openApiOperationId":"attachTagToTicket","summary":"Add tag to a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1208","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Ticket not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/attachtagtoticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/tags"},{"label":"Remove tag from a ticket","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/detachtagfromticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/detachtagfromticket","metadata":{"seo":{"title":"Remove tag from a ticket","description":"You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detachTagFromTicket","name":"Remove tag from a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket_id"},"children":[]}]}]}],"required":true,"example":"64619700005694"},{"name":"tag_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the tag which is given by Intercom","required":true,"example":"7522907"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tickets/{ticket_id}/tags/{tag_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/tickets/{ticket_id}/tags/{tag_id}","href":"tickets/detachtagfromticket","openApiOperationId":"detachTagFromTicket","summary":"Remove tag from a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1209","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/detachtagfromticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/tags/{tag_id}"},{"label":"Link a conversation to a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/linkconversationtoticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/linkconversationtoticket","metadata":{"seo":{"title":"Link a conversation to a ticket","description":"Link a conversation to an existing tracker ticket. The conversation can bea regular conversation or one that has been converted into a customer ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkConversationToTicket","name":"Link a conversation to a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link a conversation to a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link a conversation to an existing tracker ticket. The conversation can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a regular conversation or one that has been converted into a customer ticket."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this when related conversations surface after a tracker ticket has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already been created. The ticket in the path must be a tracker ticket, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body is the conversation (or customer ticket) to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link to it. This returns the linked conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A tracker ticket can have up to 2,500 linked conversations; once that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"limit is reached, further requests return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_conversation_limit_exceeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_tickets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the tracker ticket which is given by Intercom.","required":true,"example":"64619700005694"}],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1277","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_1277","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/{ticket_id}/linked_conversations","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1277","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/tickets/{ticket_id}/linked_conversations","href":"tickets/linkconversationtoticket","openApiOperationId":"linkConversationToTicket","summary":"Link a conversation to a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1277","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1277","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Not a tracker ticket","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Already linked to a tracker","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Linked conversation limit exceeded","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Missing conversation_id"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Not a tracker ticket","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Already linked to a tracker","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Linked conversation limit exceeded","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Missing conversation_id"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Conversation not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Conversation not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Not a tracker ticket","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Already linked to a tracker","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Linked conversation limit exceeded","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Missing conversation_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Not a tracker ticket","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Already linked to a tracker","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Linked conversation limit exceeded","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Missing conversation_id"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Conversation not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Conversation not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/linkconversationtoticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/linked_conversations"},{"label":"Unlink a conversation from a ticket","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/unlinkconversationfromticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/unlinkconversationfromticket","metadata":{"seo":{"title":"Unlink a conversation from a ticket","description":"Unlink a conversation (or converted customer ticket) from a tracker ticketit is currently linked to. The ticket in the path must be a tracker ticket.This returns the conversation that was unlinked."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlinkConversationFromTicket","name":"Unlink a conversation from a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink a conversation from a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlink a conversation (or converted customer ticket) from a tracker ticket"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is currently linked to. The ticket in the path must be a tracker ticket."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This returns the conversation that was unlinked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_tickets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the tracker ticket which is given by Intercom.","required":true,"example":"64619700005694"},{"name":"id","in":"path","schemaId":"schema_1152","description":"The unique identifier (given by Intercom) for the linked conversation or customer ticket to unlink.","required":true,"example":"204"}],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tickets/{ticket_id}/linked_conversations/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_1152"},{"name":"id","in":"path","required":true,"example":"204","schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/tickets/{ticket_id}/linked_conversations/{id}","href":"tickets/unlinkconversationfromticket","openApiOperationId":"unlinkConversationFromTicket","summary":"Unlink a conversation from a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/400/content/application~1json/examples/Not a tracker ticket"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/400/content/application~1json/examples/Not a tracker ticket"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Conversation not linked"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Conversation not linked"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/400/content/application~1json/examples/Not a tracker ticket"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/400/content/application~1json/examples/Not a tracker ticket"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Conversation not linked"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Ticket not found","paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Conversation not linked"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/unlinkconversationfromticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/linked_conversations/{id}"},{"label":"Create a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/createticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/createticket","metadata":{"seo":{"title":"Create a ticket","description":"You can create a new ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTicket","name":"Create a ticket","isWebhook":false,"pointer":"/paths/~1tickets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can create a new ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1278","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"]}},"schemaId":"schema_1278","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"],"pointer":"/paths/~1tickets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1278","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/tickets","href":"tickets/createticket","openApiOperationId":"createTicket","summary":"Create a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1278","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1278","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing contact","paths/~1tickets/post/responses/400/content/application~1json/examples/Contact not found","paths/~1tickets/post/responses/400/content/application~1json/examples/Invalid ticket type","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing required attributes"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing contact","paths/~1tickets/post/responses/400/content/application~1json/examples/Contact not found","paths/~1tickets/post/responses/400/content/application~1json/examples/Invalid ticket type","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing required attributes"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Conversation to link not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/404/content/application~1json/examples/Conversation to link not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/404/content/application~1json/examples/Conversation to link not found"]},{"code":"500","description":"Ticket could not be created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/500/content/application~1json/examples/Ticket creation failed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/500/content/application~1json/examples/Ticket creation failed"]}],"pointer":"/paths/~1tickets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing contact","paths/~1tickets/post/responses/400/content/application~1json/examples/Contact not found","paths/~1tickets/post/responses/400/content/application~1json/examples/Invalid ticket type","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing required attributes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing contact","paths/~1tickets/post/responses/400/content/application~1json/examples/Contact not found","paths/~1tickets/post/responses/400/content/application~1json/examples/Invalid ticket type","paths/~1tickets/post/responses/400/content/application~1json/examples/Missing required attributes"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/404/content/application~1json/examples/Conversation to link not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/404/content/application~1json/examples/Conversation to link not found"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/500/content/application~1json/examples/Ticket creation failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets/post/responses/500/content/application~1json/examples/Ticket creation failed"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/createticket"}],"panels":[]}]},"httpPath":"/tickets"},{"label":"Enqueue create ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/enqueuecreateticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/enqueuecreateticket","metadata":{"seo":{"title":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enqueueCreateTicket","name":"Enqueue create ticket","isWebhook":false,"pointer":"/paths/~1tickets~1enqueue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enqueue create ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1enqueue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1278","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"]}},"schemaId":"schema_1278","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"],"pointer":"/paths/~1tickets~1enqueue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/enqueue","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1278","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"]}},"responseCodes":["200","400","401","500"],"pointer":"/tickets/enqueue","href":"tickets/enqueuecreateticket","openApiOperationId":"enqueueCreateTicket","summary":"Enqueue create ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1278","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1278","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/jobs","exampleIds":["paths/~1tickets~1enqueue/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/jobs","exampleIds":["paths/~1tickets~1enqueue/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/400/content/application~1json/examples/Bad Request"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/400/content/application~1json/examples/Bad Request"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Job could not be enqueued","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/500/content/application~1json/examples/Enqueue failed"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/500/content/application~1json/examples/Enqueue failed"]}],"pointer":"/paths/~1tickets~1enqueue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/jobs","exampleIds":["paths/~1tickets~1enqueue/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/jobs","exampleIds":["paths/~1tickets~1enqueue/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/400/content/application~1json/examples/Bad Request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/400/content/application~1json/examples/Bad Request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/500/content/application~1json/examples/Enqueue failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1enqueue/post/responses/500/content/application~1json/examples/Enqueue failed"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/enqueuecreateticket"}],"panels":[]}]},"httpPath":"/tickets/enqueue"},{"label":"Update a ticket","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/updateticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/updateticket","metadata":{"seo":{"title":"Update a ticket","description":"You can update a ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTicket","name":"Update a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can update a ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the ticket which is given by Intercom."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Not the Inbox ticket ID"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from the API response, not the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" displayed in the Intercom Inbox (e.g., #12345). Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the ticket object returned by the API."},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1tickets~1{ticket_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1279","exampleIds":["paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type"]}},"schemaId":"schema_1279","exampleIds":["paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type"],"pointer":"/paths/~1tickets~1{ticket_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1279","exampleIds":["paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/tickets/{ticket_id}","href":"tickets/updateticket","openApiOperationId":"updateTicket","summary":"Update a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_1279","exampleIds":["paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1279","exampleIds":["paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found","paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket state id is not valid or is not associated with the ticket type.","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be unshared","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be shared"]}},"exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket state id is not valid or is not associated with the ticket type.","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be unshared","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be shared"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Ticket, admin or assignee not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Assignee not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Ticket not found"]}},"exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Assignee not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Ticket not found"]},{"code":"422","description":"Conversation already assigned to the assignee","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/422/content/application~1json/examples/Already assigned"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/422/content/application~1json/examples/Already assigned"]}],"pointer":"/paths/~1tickets~1{ticket_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket state id is not valid or is not associated with the ticket type.","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be unshared","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be shared"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket state id is not valid or is not associated with the ticket type.","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be unshared","paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be shared"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Assignee not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Ticket not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Assignee not found","paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Ticket not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/422/content/application~1json/examples/Already assigned"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/put/responses/422/content/application~1json/examples/Already assigned"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/updateticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}"},{"label":"Retrieve a ticket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/getticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/getticket","metadata":{"seo":{"title":"Retrieve a ticket","description":"You can fetch the details of a single ticket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTicket","name":"Retrieve a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can fetch the details of a single ticket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the ticket which is given by Intercom."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Not the Inbox ticket ID"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from the API response, not the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" displayed in the Intercom Inbox (e.g., #12345). Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the ticket object returned by the API."},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1tickets~1{ticket_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/tickets/{ticket_id}","href":"tickets/getticket","openApiOperationId":"getTicket","summary":"Retrieve a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/200/content/application~1json/examples/Ticket found"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/200/content/application~1json/examples/Ticket found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Ticket not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/404/content/application~1json/examples/Ticket not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/404/content/application~1json/examples/Ticket not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/200/content/application~1json/examples/Ticket found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/200/content/application~1json/examples/Ticket found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/404/content/application~1json/examples/Ticket not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/get/responses/404/content/application~1json/examples/Ticket not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/getticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}"},{"label":"Delete a ticket","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/deleteticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/deleteticket","metadata":{"seo":{"title":"Delete a ticket","description":"Deleting a ticket is permanent and cannot be reversed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTicket","name":"Delete a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a ticket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Irreversible operation"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a ticket is permanent and cannot be reversed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the ticket which is given by Intercom."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Not the Inbox ticket ID"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from the API response, not the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" displayed in the Intercom Inbox (e.g., #12345). Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the ticket object returned by the API."},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1tickets~1{ticket_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/tickets/{ticket_id}","href":"tickets/deleteticket","openApiOperationId":"deleteTicket","summary":"Delete a ticket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_deleted","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/ticket_deleted","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"Ticket not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/404/content/application~1json/examples/Ticket not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/404/content/application~1json/examples/Ticket not found"]},{"code":"422","description":"Back-office ticket linked to a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/422/content/application~1json/examples/Linked to a conversation"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/422/content/application~1json/examples/Linked to a conversation"]}],"pointer":"/paths/~1tickets~1{ticket_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_deleted","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_deleted","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/404/content/application~1json/examples/Ticket not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/404/content/application~1json/examples/Ticket not found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/422/content/application~1json/examples/Linked to a conversation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}/delete/responses/422/content/application~1json/examples/Linked to a conversation"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/deleteticket"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}"},{"label":"Change ticket type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/changetickettype","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/changetickettype","metadata":{"seo":{"title":"Change ticket type","description":"You can change the type of a ticket. The new ticket type must be in the same category as the current type. Attributes matching by name and type are automatically transferred from the old type; values provided in ticket_attributes override transferred values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"changeTicketType","name":"Change ticket type","isWebhook":false,"pointer":"/paths/~1tickets~1{ticket_id}~1change_type/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change ticket type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can change the type of a ticket. The new ticket type must be in the same category as the current type. Attributes matching by name and type are automatically transferred from the old type; values provided in ticket_attributes override transferred values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticket_id","in":"path","schemaId":"schema_1152","description":"The unique identifier for the ticket which is given by Intercom.","required":true}],"pointer":"/paths/~1tickets~1{ticket_id}~1change_type/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1{ticket_id}~1change_type/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/change_ticket_type_request","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response"]}},"schemaId":"components/schemas/change_ticket_type_request","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response"],"pointer":"/paths/~1tickets~1{ticket_id}~1change_type/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/{ticket_id}/change_type","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"ticket_id","in":"path","required":true,"schemaId":"schema_1152"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/change_ticket_type_request","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response"]}},"responseCodes":["200","400","401","404"],"pointer":"/tickets/{ticket_id}/change_type","href":"tickets/changetickettype","openApiOperationId":"changeTicketType","summary":"Change ticket type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/change_ticket_type_request","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/change_ticket_type_request","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_state_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Same ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Ticket state not in new ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Unknown ticket attribute"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_state_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Same ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Ticket state not in new ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Unknown ticket attribute"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Ticket not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/404/content/application~1json/examples/Ticket not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/404/content/application~1json/examples/Ticket not found"]}],"pointer":"/paths/~1tickets~1{ticket_id}~1change_type/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_state_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Same ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Ticket state not in new ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Unknown ticket attribute"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_type_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_state_id","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Same ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Ticket state not in new ticket type","paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Unknown ticket attribute"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/404/content/application~1json/examples/Ticket not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1change_type/post/responses/404/content/application~1json/examples/Ticket not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/changetickettype"}],"panels":[]}]},"httpPath":"/tickets/{ticket_id}/change_type"},{"label":"Search tickets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/tickets/searchtickets","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/searchtickets","metadata":{"seo":{"title":"Search tickets","description":"You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchTickets","name":"Search tickets","isWebhook":false,"pointer":"/paths/~1tickets~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search tickets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To search for tickets, you send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/tickets/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will accept a query object in the body which will define your filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Optimizing search queries"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search queries can be complex, so optimizing them can help the performance of your search."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators to combine multiple filters to get the exact results you need and utilize"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination to limit the number of results returned. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results per page and maximum is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details on how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"tickets/searchtickets/request/nesting-and-limitations","deepLinkHash":"/tickets/searchtickets#tickets/searchtickets/request/nesting-and-limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nesting & Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are some limitations to the amount of multiples there can be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 2 nested filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's a limit of max 15 filters for each AND or OR group"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"tickets/searchtickets/request/accepted-fields","deepLinkHash":"/tickets/searchtickets#tickets/searchtickets/request/accepted-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a date, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be a string such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"foobar\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields not in the table below, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", are rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin_assignee_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team_assignee_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"open"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snoozed_until"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (UNIX timestamp)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket_attribute.{id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String or Boolean or Date (UNIX timestamp) or Float or Integer"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Searching by Category"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When searching for tickets by the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, specific terms must be used instead of the category names:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category tickets, use the term "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back-office"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category tickets, use the term "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracker"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category tickets, use the term "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tracker"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"tickets/searchtickets/request/sorting","deepLinkHash":"/tickets/searchtickets#tickets/searchtickets/request/sorting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sort the results with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"field\": \"created_at\", \"order\": \"ascending\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be one of the fields in the table above, other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_attribute.{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ascending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", newest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"tickets/searchtickets/request/accepted-operators","deepLinkHash":"/tickets/searchtickets#tickets/searchtickets/request/accepted-operators"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted Operators"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Searching based on `created_at`"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators to search by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The table below shows the operators you can use to define how you want to search for the value.  The operator should be put in as a string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"=\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The operator has to be compatible with the field's type  (eg. you cannot search with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a given string value as it's only compatible for integer's and dates)."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!="},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In  Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries  Values most be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not In  Shortcut for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR !"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" queries  Values must be in Array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer  Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater (or equal) than"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer  Date (UNIX Timestamp)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower (or equal) than"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"!~"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Doesn't Contain"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"^"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts With"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ends With"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1tickets~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/search_request","exampleIds":["paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/search_request","exampleIds":["paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1tickets~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/search","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/search_request","exampleIds":["paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400"],"pointer":"/tickets/search","href":"tickets/searchtickets","openApiOperationId":"searchTickets","summary":"Search tickets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/search_request","exampleIds":["paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/search_request","exampleIds":["paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_list","exampleIds":["paths/~1tickets~1search/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/ticket_list","exampleIds":["paths/~1tickets~1search/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid per_page"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid per_page"]}],"pointer":"/paths/~1tickets~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_list","exampleIds":["paths/~1tickets~1search/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_list","exampleIds":["paths/~1tickets~1search/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid per_page"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid query","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid field","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid operator","paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid per_page"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/searchtickets"}],"panels":[]}]},"httpPath":"/tickets/search"},{"type":"link","label":"Ticket","link":"/docs/references/rest-api/api.intercom.io/tickets/ticket","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/ticket","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket"},"seo":{"title":"Ticket"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket"},"children":[]}]}]}},{"type":"link","label":"Contacts","link":"/docs/references/rest-api/api.intercom.io/tickets/ticket_contacts","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/ticket_contacts","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_contacts"},"seo":{"title":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_contacts"},"children":[]}]}]}},{"type":"link","label":"Ticket Part","link":"/docs/references/rest-api/api.intercom.io/tickets/ticket_part","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/ticket_part","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_part"},"seo":{"title":"Ticket Part"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Part","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_part"},"children":[]}]}]}},{"type":"link","label":"Ticket State","link":"/docs/references/rest-api/api.intercom.io/tickets/ticket_state","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/ticket_state","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_state"},"seo":{"title":"Ticket State"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket State","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_state"},"children":[]}]}]}},{"type":"link","label":"Ticket State","link":"/docs/references/rest-api/api.intercom.io/tickets/ticket_state_detailed","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/ticket_state_detailed","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_state_detailed"},"seo":{"title":"Ticket State"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket State","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_state_detailed"},"children":[]}]}]}},{"type":"link","label":"Ticket Type","link":"/docs/references/rest-api/api.intercom.io/tickets/ticket_type","routeSlug":"/docs/references/rest-api/api.intercom.io/tickets/ticket_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_type"},"seo":{"title":"Ticket Type"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Type","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_type"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Tickets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tickets","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your tickets"}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Ticket","link":"/tickets/ticket","deprecated":false},{"title":"Contacts","link":"/tickets/ticket_contacts","deprecated":false},{"title":"Ticket Part","link":"/tickets/ticket_part","deprecated":false},{"title":"Ticket State","link":"/tickets/ticket_state","deprecated":false},{"title":"Ticket State","link":"/tickets/ticket_state_detailed","deprecated":false},{"title":"Ticket Type","link":"/tickets/ticket_type","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tickets/{ticket_id}/reply","summary":"Reply to a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/replyticket","deprecated":false},{"title":"/tickets/{ticket_id}/tags","summary":"Add tag to a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/attachtagtoticket","deprecated":false},{"title":"/tickets/{ticket_id}/tags/{tag_id}","summary":"Remove tag from a ticket","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tickets/detachtagfromticket","deprecated":false},{"title":"/tickets/{ticket_id}/linked_conversations","summary":"Link a conversation to a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/linkconversationtoticket","deprecated":false},{"title":"/tickets/{ticket_id}/linked_conversations/{id}","summary":"Unlink a conversation from a ticket","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tickets/unlinkconversationfromticket","deprecated":false},{"title":"/tickets","summary":"Create a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/createticket","deprecated":false},{"title":"/tickets/enqueue","summary":"Enqueue create ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/enqueuecreateticket","deprecated":false},{"title":"/tickets/{ticket_id}","summary":"Update a ticket","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tickets/updateticket","deprecated":false},{"title":"/tickets/{ticket_id}","summary":"Retrieve a ticket","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tickets/getticket","deprecated":false},{"title":"/tickets/{ticket_id}","summary":"Delete a ticket","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tickets/deleteticket","deprecated":false},{"title":"/tickets/{ticket_id}/change_type","summary":"Change ticket type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/changetickettype","deprecated":false},{"title":"/tickets/search","summary":"Search tickets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/searchtickets","deprecated":false}]}]}]}]}},{"type":"group","label":"Visitors","link":"/docs/references/rest-api/api.intercom.io/visitors","routeSlug":"/docs/references/rest-api/api.intercom.io/visitors","items":[{"label":"Update a visitor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/visitors/updatevisitor","routeSlug":"/docs/references/rest-api/api.intercom.io/visitors/updatevisitor","metadata":{"seo":{"title":"Update a visitor","description":"Sending a PUT request to /visitors will result in an update of an existing Visitor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVisitor","name":"Update a visitor","isWebhook":false,"pointer":"/paths/~1visitors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a visitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/visitors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will result in an update of an existing Visitor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 1."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can update a visitor by passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the visitor in the Request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 2."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can update a visitor by passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the visitor in the Request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" promotes the visitor to a lead. When that happens the response is a contact object with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not a visitor object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1visitors/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_visitor_request","exampleIds":["paths/~1visitors/put/requestBody/content/application~1json/examples/successful","paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found"]}},"schemaId":"components/schemas/update_visitor_request","exampleIds":["paths/~1visitors/put/requestBody/content/application~1json/examples/successful","paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found"],"pointer":"/paths/~1visitors/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/visitors","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_visitor_request","exampleIds":["paths/~1visitors/put/requestBody/content/application~1json/examples/successful","paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/visitors","href":"visitors/updatevisitor","openApiOperationId":"updateVisitor","summary":"Update a visitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/update_visitor_request","exampleIds":["paths/~1visitors/put/requestBody/content/application~1json/examples/successful","paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_visitor_request","exampleIds":["paths/~1visitors/put/requestBody/content/application~1json/examples/successful","paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/put/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/400/content/application~1json/examples/No identifier supplied"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/400/content/application~1json/examples/No identifier supplied"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/put/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/put/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"visitor Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/404/content/application~1json/examples/visitor Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/404/content/application~1json/examples/visitor Not Found"]}],"pointer":"/paths/~1visitors/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/400/content/application~1json/examples/No identifier supplied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/400/content/application~1json/examples/No identifier supplied"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/put/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/put/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/404/content/application~1json/examples/visitor Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/404/content/application~1json/examples/visitor Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/visitors/updatevisitor"}],"panels":[]}]},"httpPath":"/visitors"},{"label":"Retrieve a visitor with User ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/visitors/retrievevisitorwithuserid","routeSlug":"/docs/references/rest-api/api.intercom.io/visitors/retrievevisitorwithuserid","metadata":{"seo":{"title":"Retrieve a visitor with User ID","description":"You can fetch the details of a single visitor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveVisitorWithUserId","name":"Retrieve a visitor with User ID","isWebhook":false,"pointer":"/paths/~1visitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a visitor with User ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can fetch the details of a single visitor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_single_user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"user_id","in":"query","schemaId":"schema_1152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user_id of the Visitor you want to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1visitors/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1visitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/visitors","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"user_id","in":"query","required":true,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/visitors","href":"visitors/retrievevisitorwithuserid","openApiOperationId":"retrieveVisitorWithUserId","summary":"Retrieve a visitor with User ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/get/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/get/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Visitor not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/404/content/application~1json/examples/Visitor not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/404/content/application~1json/examples/Visitor not found"]}],"pointer":"/paths/~1visitors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visitor","exampleIds":["paths/~1visitors/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/get/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors/get/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/404/content/application~1json/examples/Visitor not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/404/content/application~1json/examples/Visitor not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/visitors/retrievevisitorwithuserid"}],"panels":[]}]},"httpPath":"/visitors"},{"label":"Convert a visitor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/visitors/convertvisitor","routeSlug":"/docs/references/rest-api/api.intercom.io/visitors/convertvisitor","metadata":{"seo":{"title":"Convert a visitor","description":"You can merge a Visitor to a Contact of role type lead or user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"convertVisitor","name":"Convert a visitor","isWebhook":false,"pointer":"/paths/~1visitors~1convert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert a visitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can merge a Visitor to a Contact of role type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📘 What happens upon a visitor being converted?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify the visitor with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visitor.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visitor.user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is not read when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_write_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_users_companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OAuth scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1visitors~1convert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/convert_visitor_request","exampleIds":["paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/convert_visitor_request","exampleIds":["paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1visitors~1convert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visitors/convert","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/convert_visitor_request","exampleIds":["paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","400","401","404"],"pointer":"/visitors/convert","href":"visitors/convertvisitor","openApiOperationId":"convertVisitor","summary":"Convert a visitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"components/schemas/convert_visitor_request","exampleIds":["paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/convert_visitor_request","exampleIds":["paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact","exampleIds":["paths/~1visitors~1convert/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact","exampleIds":["paths/~1visitors~1convert/post/responses/200/content/application~1json/examples/successful"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/No visitor identifier supplied","paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/Missing or unknown type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/No visitor identifier supplied","paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/Missing or unknown type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Token lacks required scope"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Token lacks required scope"]},{"code":"404","description":"Visitor not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/404/content/application~1json/examples/Visitor not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/404/content/application~1json/examples/Visitor not found"]}],"pointer":"/paths/~1visitors~1convert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact","exampleIds":["paths/~1visitors~1convert/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact","exampleIds":["paths/~1visitors~1convert/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/No visitor identifier supplied","paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/Missing or unknown type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/No visitor identifier supplied","paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/Missing or unknown type"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Token lacks required scope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized","paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Token lacks required scope"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/404/content/application~1json/examples/Visitor not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/404/content/application~1json/examples/Visitor not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/visitors/convertvisitor"}],"panels":[]}]},"httpPath":"/visitors/convert"}],"content":{"contentType":"group","meta":{"name":"Visitors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitors","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Visitors"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/visitors","summary":"Update a visitor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/visitors/updatevisitor","deprecated":false},{"title":"/visitors","summary":"Retrieve a visitor with User ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/visitors/retrievevisitorwithuserid","deprecated":false},{"title":"/visitors/convert","summary":"Convert a visitor","prefix":{"name":"post","color":"post"},"badges":[],"link":"/visitors/convertvisitor","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp","link":"/docs/references/rest-api/api.intercom.io/whatsapp","routeSlug":"/docs/references/rest-api/api.intercom.io/whatsapp","items":[{"label":"Retrieve WhatsApp message delivery status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/whatsapp/retrievewhatsappmessagestatus","routeSlug":"/docs/references/rest-api/api.intercom.io/whatsapp/retrievewhatsappmessagestatus","metadata":{"seo":{"title":"Retrieve WhatsApp message delivery status","description":"Retrieves the delivery status of a specific WhatsApp message by its message ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveWhatsAppMessageStatus","name":"Retrieve WhatsApp message delivery status","isWebhook":false,"pointer":"/paths/~1messages~1whatsapp~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve WhatsApp message delivery status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the delivery status of a specific WhatsApp message by its message ID.\n\n\nReturns the current status, conversation details, and any error information if the message failed to deliver.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"message_id","in":"query","schemaId":"schema_1152","description":"The WhatsApp message ID to check status for","required":true}],"pointer":"/paths/~1messages~1whatsapp~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1messages~1whatsapp~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/messages/whatsapp/status","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"message_id","in":"query","required":true,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/messages/whatsapp/status","href":"whatsapp/retrievewhatsappmessagestatus","openApiOperationId":"RetrieveWhatsAppMessageStatus","summary":"Retrieve WhatsApp message delivery status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"]}},"schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"]},{"code":"400","description":"Bad request - missing required parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"404","description":"WhatsApp message not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"]}],"pointer":"/paths/~1messages~1whatsapp~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response","paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/retrievewhatsappmessagestatus"}],"panels":[]}]},"httpPath":"/messages/whatsapp/status"},{"label":"Get statuses of all messages sent based on the specified ruleset_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/whatsapp/getwhatsappmessagestatus","routeSlug":"/docs/references/rest-api/api.intercom.io/whatsapp/getwhatsappmessagestatus","metadata":{"seo":{"title":"Get statuses of all messages sent based on the specified ruleset_id","description":"Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWhatsAppMessageStatus","name":"Get statuses of all messages sent based on the specified ruleset_id","isWebhook":false,"pointer":"/paths/~1messages~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get statuses of all messages sent based on the specified ruleset_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.\n\n\nThis endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing\ninformation about delivery state and related message details.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ruleset_id","in":"query","schemaId":"schema_1152","description":"The unique identifier for the set of messages to check status for","required":true},{"name":"per_page","in":"query","schemaId":"schema_1259","description":"Number of results per page (default 50, max 100)"},{"name":"starting_after","in":"query","schemaId":"schema_1152","description":"Cursor for pagination, used to fetch the next page of results"}],"pointer":"/paths/~1messages~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1messages~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/messages/status","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[],"query":[{"name":"ruleset_id","in":"query","required":true,"schemaId":"schema_1152"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_1259"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_1152"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/messages/status","href":"whatsapp/getwhatsappmessagestatus","openApiOperationId":"getWhatsAppMessageStatus","summary":"Get statuses of all messages sent based on the specified ruleset_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"]},{"code":"400","description":"Bad request - missing required parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"API plan restricted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"]}],"pointer":"/paths/~1messages~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/whatsapp_message_status_list","exampleIds":["paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/getwhatsappmessagestatus"}],"panels":[]}]},"httpPath":"/messages/status"}],"content":{"contentType":"group","meta":{"name":"WhatsApp"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your WhatsApp messages"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/messages/whatsapp/status","summary":"Retrieve WhatsApp message delivery status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/whatsapp/retrievewhatsappmessagestatus","deprecated":false},{"title":"/messages/status","summary":"Get statuses of all messages sent based on the specified ruleset_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/whatsapp/getwhatsappmessagestatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Workflows","link":"/docs/references/rest-api/api.intercom.io/workflows","routeSlug":"/docs/references/rest-api/api.intercom.io/workflows","items":[{"label":"Export a workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/rest-api/api.intercom.io/workflows/exportworkflow","routeSlug":"/docs/references/rest-api/api.intercom.io/workflows/exportworkflow","metadata":{"seo":{"title":"Export a workflow","description":"Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportWorkflow","name":"Export a workflow","isWebhook":false,"pointer":"/paths/~1export~1workflows~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export a workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the path is the workflow's ruleset ID, the number at the end of the workflow's URL in Intercom ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.intercom.com/a/apps/<app_id>/automation/workflows/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workflow.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response is a different ID, so don't pass it back as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1224","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ruleset ID of the workflow. This is the number at the end of the workflow's URL in Intercom, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.intercom.com/a/apps/<app_id>/automation/workflows/<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is not the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workflow.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response, so don't pass that value back here."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1export~1workflows~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_1149"}],"pointer":"/paths/~1export~1workflows~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/export/workflows/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_1224"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.18","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","503"],"pointer":"/export/workflows/{id}","href":"workflows/exportworkflow","openApiOperationId":"exportWorkflow","summary":"Export a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workflow exported successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/workflow_export","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/workflow_export","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Workflow not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found"]},{"code":"503","description":"Workflow export is currently disabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/503/content/application~1json/examples/Workflow export disabled"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/503/content/application~1json/examples/Workflow export disabled"]}],"pointer":"/paths/~1export~1workflows~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/workflow_export","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/workflow_export","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found"]}}},{"code":"503","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/503/content/application~1json/examples/Workflow export disabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/503/content/application~1json/examples/Workflow export disabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflows/exportworkflow"}],"panels":[]}]},"httpPath":"/export/workflows/{id}"}],"content":{"contentType":"group","meta":{"name":"Workflows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflows","showPageActions":true},{"nodeType":"markdoc","content":"Everything about your Workflows"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/export/workflows/{id}","summary":"Export a workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflows/exportworkflow","deprecated":false}]}]}]}]}},{"type":"group","label":"Models","link":"/docs/references/rest-api/api.intercom.io/models","routeSlug":"/docs/references/rest-api/api.intercom.io/models","items":[{"type":"link","label":"Activity Log","link":"/docs/references/rest-api/api.intercom.io/models/activity_log","routeSlug":"/docs/references/rest-api/api.intercom.io/models/activity_log","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"activity_log"},"seo":{"title":"Activity Log"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity Log","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/activity_log"},"children":[]}]}]}},{"type":"link","label":"Paginated Response","link":"/docs/references/rest-api/api.intercom.io/models/activity_log_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/activity_log_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"activity_log_list"},"seo":{"title":"Paginated Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Paginated Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/activity_log_list"},"children":[]}]}]}},{"type":"link","label":"Activity Log Metadata","link":"/docs/references/rest-api/api.intercom.io/models/activity_log_metadata","routeSlug":"/docs/references/rest-api/api.intercom.io/models/activity_log_metadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"activity_log_metadata"},"seo":{"title":"Activity Log Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity Log Metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/activity_log_metadata"},"children":[]}]}]}},{"type":"link","label":"Addressable List","link":"/docs/references/rest-api/api.intercom.io/models/addressable_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/addressable_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"addressable_list"},"seo":{"title":"Addressable List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Addressable List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/addressable_list"},"children":[]}]}]}},{"type":"link","label":"Admins","link":"/docs/references/rest-api/api.intercom.io/models/admin_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/admin_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"admin_list"},"seo":{"title":"Admins"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admins","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/admin_list"},"children":[]}]}]}},{"type":"link","label":"Admin Priority Level","link":"/docs/references/rest-api/api.intercom.io/models/admin_priority_level","routeSlug":"/docs/references/rest-api/api.intercom.io/models/admin_priority_level","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"admin_priority_level"},"seo":{"title":"Admin Priority Level"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin Priority Level","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/admin_priority_level"},"children":[]}]}]}},{"type":"link","label":"Admin Reply","link":"/docs/references/rest-api/api.intercom.io/models/admin_reply_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/admin_reply_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"admin_reply_conversation_request"},"seo":{"title":"Admin Reply"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin Reply","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/admin_reply_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Admin Reply on ticket","link":"/docs/references/rest-api/api.intercom.io/models/admin_reply_ticket_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/admin_reply_ticket_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"admin_reply_ticket_request"},"seo":{"title":"Admin Reply on ticket"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin Reply on ticket","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/admin_reply_ticket_request"},"children":[]}]}]}},{"type":"link","label":"Admin","link":"/docs/references/rest-api/api.intercom.io/models/admin_with_app","routeSlug":"/docs/references/rest-api/api.intercom.io/models/admin_with_app","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"admin_with_app"},"seo":{"title":"Admin"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/admin_with_app"},"children":[]}]}]}},{"type":"link","label":"Part type - ai_agent_event (otp_email_verification_failed)","link":"/docs/references/rest-api/api.intercom.io/models/ai_agent_event_otp_email_verification_failed","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ai_agent_event_otp_email_verification_failed","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ai_agent_event_otp_email_verification_failed"},"seo":{"title":"Part type - ai_agent_event (otp_email_verification_failed)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - ai_agent_event (otp_email_verification_failed)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ai_agent_event_otp_email_verification_failed"},"children":[]}]}]}},{"type":"link","label":"AI Call Response","link":"/docs/references/rest-api/api.intercom.io/models/ai_call_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ai_call_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ai_call_response"},"seo":{"title":"AI Call Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Call Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ai_call_response"},"children":[]}]}]}},{"type":"link","label":"AI Topic and Subtopic","link":"/docs/references/rest-api/api.intercom.io/models/ai_topic_subtopic","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ai_topic_subtopic","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ai_topic_subtopic"},"seo":{"title":"AI Topic and Subtopic"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Topic and Subtopic","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ai_topic_subtopic"},"children":[]}]}]}},{"type":"link","label":"App","link":"/docs/references/rest-api/api.intercom.io/models/app","routeSlug":"/docs/references/rest-api/api.intercom.io/models/app","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"app"},"seo":{"title":"App"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/app"},"children":[]}]}]}},{"type":"link","label":"Article Content","link":"/docs/references/rest-api/api.intercom.io/models/article_content","routeSlug":"/docs/references/rest-api/api.intercom.io/models/article_content","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_content"},"seo":{"title":"Article Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Content","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_content"},"children":[]}]}]}},{"type":"link","label":"Articles","link":"/docs/references/rest-api/api.intercom.io/models/article_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/article_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_list"},"seo":{"title":"Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Articles","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_list"},"children":[]}]}]}},{"type":"link","label":"Article Statistics","link":"/docs/references/rest-api/api.intercom.io/models/article_statistics","routeSlug":"/docs/references/rest-api/api.intercom.io/models/article_statistics","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_statistics"},"seo":{"title":"Article Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Statistics","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_statistics"},"children":[]}]}]}},{"type":"link","label":"Article Translated Content","link":"/docs/references/rest-api/api.intercom.io/models/article_translated_content","routeSlug":"/docs/references/rest-api/api.intercom.io/models/article_translated_content","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_translated_content"},"seo":{"title":"Article Translated Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Translated Content","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_translated_content"},"children":[]}]}]}},{"type":"link","label":"Article Versions","link":"/docs/references/rest-api/api.intercom.io/models/article_version_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/article_version_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"article_version_list"},"seo":{"title":"Article Versions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article Versions","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/article_version_list"},"children":[]}]}]}},{"type":"link","label":"Assign Conversation Request","link":"/docs/references/rest-api/api.intercom.io/models/assign_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/assign_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"assign_conversation_request"},"seo":{"title":"Assign Conversation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign Conversation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/assign_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Attach Contact To Conversation Request","link":"/docs/references/rest-api/api.intercom.io/models/attach_contact_to_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/attach_contact_to_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"attach_contact_to_conversation_request"},"seo":{"title":"Attach Contact To Conversation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach Contact To Conversation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/attach_contact_to_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Audience List","link":"/docs/references/rest-api/api.intercom.io/models/audience_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/audience_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"audience_list"},"seo":{"title":"Audience List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audience List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/audience_list"},"children":[]}]}]}},{"type":"link","label":"Auth Token List","link":"/docs/references/rest-api/api.intercom.io/models/auth_token_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/auth_token_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"auth_token_list"},"seo":{"title":"Auth Token List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth Token List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/auth_token_list"},"children":[]}]}]}},{"type":"link","label":"away_status_reason","link":"/docs/references/rest-api/api.intercom.io/models/away_status_reason","routeSlug":"/docs/references/rest-api/api.intercom.io/models/away_status_reason","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"away_status_reason"},"seo":{"title":"away_status_reason"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"away_status_reason","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/away_status_reason"},"children":[]}]}]}},{"type":"link","label":"Away Status Reasons","link":"/docs/references/rest-api/api.intercom.io/models/away_status_reason_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/away_status_reason_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"away_status_reason_list"},"seo":{"title":"Away Status Reasons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Away Status Reasons","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/away_status_reason_list"},"children":[]}]}]}},{"type":"link","label":"Banner List","link":"/docs/references/rest-api/api.intercom.io/models/banner_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/banner_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"banner_list"},"seo":{"title":"Banner List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Banner List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/banner_list"},"children":[]}]}]}},{"type":"link","label":"Bot Reply","link":"/docs/references/rest-api/api.intercom.io/models/bot_reply_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/bot_reply_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"bot_reply_conversation_request"},"seo":{"title":"Bot Reply"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bot Reply","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/bot_reply_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Bulk Create Contacts Request","link":"/docs/references/rest-api/api.intercom.io/models/bulk_create_contacts_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/bulk_create_contacts_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"bulk_create_contacts_request"},"seo":{"title":"Bulk Create Contacts Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Create Contacts Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/bulk_create_contacts_request"},"children":[]}]}]}},{"type":"link","label":"Bulk Delete Contacts Request","link":"/docs/references/rest-api/api.intercom.io/models/bulk_delete_contacts_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/bulk_delete_contacts_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"bulk_delete_contacts_request"},"seo":{"title":"Bulk Delete Contacts Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Delete Contacts Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/bulk_delete_contacts_request"},"children":[]}]}]}},{"type":"link","label":"Bulk Update Contacts Request","link":"/docs/references/rest-api/api.intercom.io/models/bulk_update_contacts_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/bulk_update_contacts_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"bulk_update_contacts_request"},"seo":{"title":"Bulk Update Contacts Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Update Contacts Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/bulk_update_contacts_request"},"children":[]}]}]}},{"type":"link","label":"Calls","link":"/docs/references/rest-api/api.intercom.io/models/call_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/call_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"call_list"},"seo":{"title":"Calls"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calls","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/call_list"},"children":[]}]}]}},{"type":"link","label":"Part type - call_summary","link":"/docs/references/rest-api/api.intercom.io/models/call_summary","routeSlug":"/docs/references/rest-api/api.intercom.io/models/call_summary","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"call_summary"},"seo":{"title":"Part type - call_summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - call_summary","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/call_summary"},"children":[]}]}]}},{"type":"link","label":"Change Ticket Type Request","link":"/docs/references/rest-api/api.intercom.io/models/change_ticket_type_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/change_ticket_type_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"change_ticket_type_request"},"seo":{"title":"Change Ticket Type Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Ticket Type Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/change_ticket_type_request"},"children":[]}]}]}},{"type":"link","label":"Close Conversation Request","link":"/docs/references/rest-api/api.intercom.io/models/close_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/close_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"close_conversation_request"},"seo":{"title":"Close Conversation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close Conversation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/close_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Collections","link":"/docs/references/rest-api/api.intercom.io/models/collection_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/collection_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"collection_list"},"seo":{"title":"Collections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collections","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/collection_list"},"children":[]}]}]}},{"type":"link","label":"Company Attached Contacts","link":"/docs/references/rest-api/api.intercom.io/models/company_attached_contacts","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_attached_contacts","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_attached_contacts"},"seo":{"title":"Company Attached Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Attached Contacts","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_attached_contacts"},"children":[]}]}]}},{"type":"link","label":"Company Attached Segments","link":"/docs/references/rest-api/api.intercom.io/models/company_attached_segments","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_attached_segments","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_attached_segments"},"seo":{"title":"Company Attached Segments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Attached Segments","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_attached_segments"},"children":[]}]}]}},{"type":"link","label":"Company Data","link":"/docs/references/rest-api/api.intercom.io/models/company_data","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_data","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_data"},"seo":{"title":"Company Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Data","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_data"},"children":[]}]}]}},{"type":"link","label":"Companies","link":"/docs/references/rest-api/api.intercom.io/models/company_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_list"},"seo":{"title":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_list"},"children":[]}]}]}},{"type":"link","label":"Company Scroll","link":"/docs/references/rest-api/api.intercom.io/models/company_scroll","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_scroll","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_scroll"},"seo":{"title":"Company Scroll"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Scroll","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_scroll"},"children":[]}]}]}},{"type":"link","label":"Company search request","link":"/docs/references/rest-api/api.intercom.io/models/company_search_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_search_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_search_request"},"seo":{"title":"Company search request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company search request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_search_request"},"children":[]}]}]}},{"type":"link","label":"Company Search Response","link":"/docs/references/rest-api/api.intercom.io/models/company_search_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_search_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_search_response"},"seo":{"title":"Company Search Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Search Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_search_response"},"children":[]}]}]}},{"type":"link","label":"Company Users","link":"/docs/references/rest-api/api.intercom.io/models/company_user_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/company_user_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"company_user_list"},"seo":{"title":"Company Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Users","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/company_user_list"},"children":[]}]}]}},{"type":"link","label":"Contact Activity","link":"/docs/references/rest-api/api.intercom.io/models/contact_activity","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_activity","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_activity"},"seo":{"title":"Contact Activity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Activity","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_activity"},"children":[]}]}]}},{"type":"link","label":"Contact Activity List","link":"/docs/references/rest-api/api.intercom.io/models/contact_activity_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_activity_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_activity_list"},"seo":{"title":"Contact Activity List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Activity List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_activity_list"},"children":[]}]}]}},{"type":"link","label":"Contact Archived","link":"/docs/references/rest-api/api.intercom.io/models/contact_archived","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_archived","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_archived"},"seo":{"title":"Contact Archived"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Archived","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_archived"},"children":[]}]}]}},{"type":"link","label":"Contact Attached Companies","link":"/docs/references/rest-api/api.intercom.io/models/contact_attached_companies","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_attached_companies","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_attached_companies"},"seo":{"title":"Contact Attached Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Attached Companies","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_attached_companies"},"children":[]}]}]}},{"type":"link","label":"Contact Blocked","link":"/docs/references/rest-api/api.intercom.io/models/contact_blocked","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_blocked","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_blocked"},"seo":{"title":"Contact Blocked"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Blocked","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_blocked"},"children":[]}]}]}},{"type":"link","label":"Contact companies","link":"/docs/references/rest-api/api.intercom.io/models/contact_companies","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_companies","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_companies"},"seo":{"title":"Contact companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact companies","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_companies"},"children":[]}]}]}},{"type":"link","label":"Contact Deleted","link":"/docs/references/rest-api/api.intercom.io/models/contact_deleted","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_deleted","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_deleted"},"seo":{"title":"Contact Deleted"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Deleted","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_deleted"},"children":[]}]}]}},{"type":"link","label":"Contact List","link":"/docs/references/rest-api/api.intercom.io/models/contact_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_list"},"seo":{"title":"Contact List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_list"},"children":[]}]}]}},{"type":"link","label":"Contact Location","link":"/docs/references/rest-api/api.intercom.io/models/contact_location","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_location","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_location"},"seo":{"title":"Contact Location"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Location","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_location"},"children":[]}]}]}},{"type":"link","label":"Contact notes","link":"/docs/references/rest-api/api.intercom.io/models/contact_notes","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_notes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_notes"},"seo":{"title":"Contact notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact notes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_notes"},"children":[]}]}]}},{"type":"link","label":"Contact Reference","link":"/docs/references/rest-api/api.intercom.io/models/contact_reference","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reference","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reference"},"seo":{"title":"Contact Reference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Reference","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reference"},"children":[]}]}]}},{"type":"link","label":"Contact Reply Base Object","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_base_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_base_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_base_request"},"seo":{"title":"Contact Reply Base Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Reply Base Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_base_request"},"children":[]}]}]}},{"type":"link","label":"Contact Reply","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_conversation_request"},"seo":{"title":"Contact Reply"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Reply","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Email","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_email_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_email_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_email_request"},"seo":{"title":"Email"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_email_request"},"children":[]}]}]}},{"type":"link","label":"Intercom User ID","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_intercom_user_id_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_intercom_user_id_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_intercom_user_id_request"},"seo":{"title":"Intercom User ID"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intercom User ID","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_intercom_user_id_request"},"children":[]}]}]}},{"type":"link","label":"Email","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_email_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_email_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_ticket_email_request"},"seo":{"title":"Email"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_ticket_email_request"},"children":[]}]}]}},{"type":"link","label":"Intercom User ID","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_intercom_user_id_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_intercom_user_id_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_ticket_intercom_user_id_request"},"seo":{"title":"Intercom User ID"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intercom User ID","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_ticket_intercom_user_id_request"},"children":[]}]}]}},{"type":"link","label":"Contact Reply on ticket","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_ticket_request"},"seo":{"title":"Contact Reply on ticket"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Reply on ticket","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_ticket_request"},"children":[]}]}]}},{"type":"link","label":"User ID","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_user_id_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_ticket_user_id_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_ticket_user_id_request"},"seo":{"title":"User ID"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User ID","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_ticket_user_id_request"},"children":[]}]}]}},{"type":"link","label":"User ID","link":"/docs/references/rest-api/api.intercom.io/models/contact_reply_user_id_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_reply_user_id_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_reply_user_id_request"},"seo":{"title":"User ID"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User ID","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_reply_user_id_request"},"children":[]}]}]}},{"type":"link","label":"Contact search request","link":"/docs/references/rest-api/api.intercom.io/models/contact_search_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_search_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_search_request"},"seo":{"title":"Contact search request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact search request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_search_request"},"children":[]}]}]}},{"type":"link","label":"Segments","link":"/docs/references/rest-api/api.intercom.io/models/contact_segments","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_segments","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_segments"},"seo":{"title":"Segments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Segments","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_segments"},"children":[]}]}]}},{"type":"link","label":"Social Profile","link":"/docs/references/rest-api/api.intercom.io/models/contact_social_profiles","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_social_profiles","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_social_profiles"},"seo":{"title":"Social Profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Social Profile","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_social_profiles"},"children":[]}]}]}},{"type":"link","label":"Contact Subscription Types","link":"/docs/references/rest-api/api.intercom.io/models/contact_subscription_types","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_subscription_types","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_subscription_types"},"seo":{"title":"Contact Subscription Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Subscription Types","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_subscription_types"},"children":[]}]}]}},{"type":"link","label":"Contact Tags","link":"/docs/references/rest-api/api.intercom.io/models/contact_tags","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_tags","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_tags"},"seo":{"title":"Contact Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Tags","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_tags"},"children":[]}]}]}},{"type":"link","label":"Contact Unarchived","link":"/docs/references/rest-api/api.intercom.io/models/contact_unarchived","routeSlug":"/docs/references/rest-api/api.intercom.io/models/contact_unarchived","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"contact_unarchived"},"seo":{"title":"Contact Unarchived"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Unarchived","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/contact_unarchived"},"children":[]}]}]}},{"type":"link","label":"Content Bulk Action Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/content_bulk_action_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_bulk_action_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_bulk_action_request"},"seo":{"title":"Content Bulk Action Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Bulk Action Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_bulk_action_request"},"children":[]}]}]}},{"type":"link","label":"Content Bulk Action Response Envelope","link":"/docs/references/rest-api/api.intercom.io/models/content_bulk_action_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_bulk_action_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_bulk_action_response"},"seo":{"title":"Content Bulk Action Response Envelope"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Bulk Action Response Envelope","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_bulk_action_response"},"children":[]}]}]}},{"type":"link","label":"Content Search Article Content Item","link":"/docs/references/rest-api/api.intercom.io/models/content_search_article_content_item","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_search_article_content_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_search_article_content_item"},"seo":{"title":"Content Search Article Content Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Search Article Content Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_search_article_content_item"},"children":[]}]}]}},{"type":"link","label":"Content Search Article Item","link":"/docs/references/rest-api/api.intercom.io/models/content_search_article_item","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_search_article_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_search_article_item"},"seo":{"title":"Content Search Article Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Search Article Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_search_article_item"},"children":[]}]}]}},{"type":"link","label":"Content Search Default Item","link":"/docs/references/rest-api/api.intercom.io/models/content_search_default_item","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_search_default_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_search_default_item"},"seo":{"title":"Content Search Default Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Search Default Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_search_default_item"},"children":[]}]}]}},{"type":"link","label":"Content Search Response","link":"/docs/references/rest-api/api.intercom.io/models/content_search_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_search_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_search_response"},"seo":{"title":"Content Search Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Search Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_search_response"},"children":[]}]}]}},{"type":"link","label":"Content Search Result","link":"/docs/references/rest-api/api.intercom.io/models/content_search_result","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_search_result","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_search_result"},"seo":{"title":"Content Search Result"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Search Result","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_search_result"},"children":[]}]}]}},{"type":"link","label":"Create Content Snippet Request","link":"/docs/references/rest-api/api.intercom.io/models/content_snippet_create_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_snippet_create_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_snippet_create_request"},"seo":{"title":"Create Content Snippet Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Content Snippet Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_snippet_create_request"},"children":[]}]}]}},{"type":"link","label":"Content Snippet List","link":"/docs/references/rest-api/api.intercom.io/models/content_snippet_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_snippet_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_snippet_list"},"seo":{"title":"Content Snippet List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Snippet List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_snippet_list"},"children":[]}]}]}},{"type":"link","label":"Update Content Snippet Request","link":"/docs/references/rest-api/api.intercom.io/models/content_snippet_update_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_snippet_update_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_snippet_update_request"},"seo":{"title":"Update Content Snippet Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Content Snippet Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_snippet_update_request"},"children":[]}]}]}},{"type":"link","label":"Content Source List","link":"/docs/references/rest-api/api.intercom.io/models/content_sources_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/content_sources_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"content_sources_list"},"seo":{"title":"Content Source List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Source List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/content_sources_list"},"children":[]}]}]}},{"type":"link","label":"Conversation attachment files","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attachment_files","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attachment_files","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attachment_files"},"seo":{"title":"Conversation attachment files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation attachment files","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attachment_files"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute Base","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_base","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_base","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_base"},"seo":{"title":"Conversation Attribute Base"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute Base","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_base"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (Boolean)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_boolean_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_boolean_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_boolean_type"},"seo":{"title":"Conversation Attribute (Boolean)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (Boolean)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_boolean_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (Datetime)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_datetime_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_datetime_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_datetime_type"},"seo":{"title":"Conversation Attribute (Datetime)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (Datetime)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_datetime_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (Decimal)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_decimal_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_decimal_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_decimal_type"},"seo":{"title":"Conversation Attribute (Decimal)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (Decimal)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_decimal_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (Files)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_files_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_files_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_files_type"},"seo":{"title":"Conversation Attribute (Files)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (Files)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_files_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (Integer)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_integer_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_integer_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_integer_type"},"seo":{"title":"Conversation Attribute (Integer)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (Integer)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_integer_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute List","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_list"},"seo":{"title":"Conversation Attribute List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_list"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (List)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_list_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_list_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_list_type"},"seo":{"title":"Conversation Attribute (List)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (List)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_list_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute Option","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_option","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_option","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_option"},"seo":{"title":"Conversation Attribute Option"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute Option","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_option"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (Relationship)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_relationship_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_relationship_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_relationship_type"},"seo":{"title":"Conversation Attribute (Relationship)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (Relationship)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_relationship_type"},"children":[]}]}]}},{"type":"link","label":"Conversation Attribute (String)","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_string_type","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_string_type","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_string_type"},"seo":{"title":"Conversation Attribute (String)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Attribute (String)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_string_type"},"children":[]}]}]}},{"type":"link","label":"Part type - conversation_attribute_updated_by_admin","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_updated_by_admin","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_updated_by_admin","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_updated_by_admin"},"seo":{"title":"Part type - conversation_attribute_updated_by_admin"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - conversation_attribute_updated_by_admin","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_updated_by_admin"},"children":[]}]}]}},{"type":"link","label":"Part type - conversation_attribute_updated_by_user","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_updated_by_user","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_updated_by_user","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_updated_by_user"},"seo":{"title":"Part type - conversation_attribute_updated_by_user"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - conversation_attribute_updated_by_user","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_updated_by_user"},"children":[]}]}]}},{"type":"link","label":"Part type - conversation_attribute_updated_by_workflow","link":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_updated_by_workflow","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_attribute_updated_by_workflow","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_attribute_updated_by_workflow"},"seo":{"title":"Part type - conversation_attribute_updated_by_workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - conversation_attribute_updated_by_workflow","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_attribute_updated_by_workflow"},"children":[]}]}]}},{"type":"link","label":"Conversation Channel","link":"/docs/references/rest-api/api.intercom.io/models/conversation_channel","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_channel","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_channel"},"seo":{"title":"Conversation Channel"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Channel","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_channel"},"children":[]}]}]}},{"type":"link","label":"Contacts","link":"/docs/references/rest-api/api.intercom.io/models/conversation_contacts","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_contacts","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_contacts"},"seo":{"title":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_contacts"},"children":[]}]}]}},{"type":"link","label":"Conversation Deleted","link":"/docs/references/rest-api/api.intercom.io/models/conversation_deleted","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_deleted","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_deleted"},"seo":{"title":"Conversation Deleted"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Deleted","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_deleted"},"children":[]}]}]}},{"type":"link","label":"Conversation External Reference","link":"/docs/references/rest-api/api.intercom.io/models/conversation_external_reference","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_external_reference","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_external_reference"},"seo":{"title":"Conversation External Reference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation External Reference","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_external_reference"},"children":[]}]}]}},{"type":"link","label":"First contact reply","link":"/docs/references/rest-api/api.intercom.io/models/conversation_first_contact_reply","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_first_contact_reply","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_first_contact_reply"},"seo":{"title":"First contact reply"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"First contact reply","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_first_contact_reply"},"children":[]}]}]}},{"type":"link","label":"Conversation List","link":"/docs/references/rest-api/api.intercom.io/models/conversation_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_list"},"seo":{"title":"Conversation List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_list"},"children":[]}]}]}},{"type":"link","label":"Conversation Part","link":"/docs/references/rest-api/api.intercom.io/models/conversation_part","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_part","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_part"},"seo":{"title":"Conversation Part"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Part","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_part"},"children":[]}]}]}},{"type":"link","label":"Conversation part author","link":"/docs/references/rest-api/api.intercom.io/models/conversation_part_author","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_part_author","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_part_author"},"seo":{"title":"Conversation part author"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation part author","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_part_author"},"children":[]}]}]}},{"type":"link","label":"Conversation Part Metadata","link":"/docs/references/rest-api/api.intercom.io/models/conversation_part_metadata","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_part_metadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_part_metadata"},"seo":{"title":"Conversation Part Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Part Metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_part_metadata"},"children":[]}]}]}},{"type":"link","label":"Conversation Participants Response","link":"/docs/references/rest-api/api.intercom.io/models/conversation_participants_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_participants_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_participants_response"},"seo":{"title":"Conversation Participants Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Participants Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_participants_response"},"children":[]}]}]}},{"type":"link","label":"Conversation Parts","link":"/docs/references/rest-api/api.intercom.io/models/conversation_parts","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_parts","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_parts"},"seo":{"title":"Conversation Parts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Parts","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_parts"},"children":[]}]}]}},{"type":"link","label":"Conversation Rating","link":"/docs/references/rest-api/api.intercom.io/models/conversation_rating","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_rating","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_rating"},"seo":{"title":"Conversation Rating"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation Rating","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_rating"},"children":[]}]}]}},{"type":"link","label":"Conversation response time","link":"/docs/references/rest-api/api.intercom.io/models/conversation_response_time","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_response_time","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_response_time"},"seo":{"title":"Conversation response time"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation response time","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_response_time"},"children":[]}]}]}},{"type":"link","label":"Conversation source","link":"/docs/references/rest-api/api.intercom.io/models/conversation_source","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_source","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_source"},"seo":{"title":"Conversation source"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation source","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_source"},"children":[]}]}]}},{"type":"link","label":"Conversation source author","link":"/docs/references/rest-api/api.intercom.io/models/conversation_source_author","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_source_author","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_source_author"},"seo":{"title":"Conversation source author"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation source author","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_source_author"},"children":[]}]}]}},{"type":"link","label":"Conversation statistics","link":"/docs/references/rest-api/api.intercom.io/models/conversation_statistics","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_statistics","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_statistics"},"seo":{"title":"Conversation statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation statistics","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_statistics"},"children":[]}]}]}},{"type":"link","label":"Conversation teammates","link":"/docs/references/rest-api/api.intercom.io/models/conversation_teammates","routeSlug":"/docs/references/rest-api/api.intercom.io/models/conversation_teammates","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"conversation_teammates"},"seo":{"title":"Conversation teammates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation teammates","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/conversation_teammates"},"children":[]}]}]}},{"type":"link","label":"Convert Ticket Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/convert_conversation_to_ticket_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/convert_conversation_to_ticket_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"convert_conversation_to_ticket_request"},"seo":{"title":"Convert Ticket Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert Ticket Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/convert_conversation_to_ticket_request"},"children":[]}]}]}},{"type":"link","label":"Convert Visitor Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/convert_visitor_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/convert_visitor_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"convert_visitor_request"},"seo":{"title":"Convert Visitor Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert Visitor Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/convert_visitor_request"},"children":[]}]}]}},{"type":"link","label":"Create Article Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_article_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_article_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_article_request"},"seo":{"title":"Create Article Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Article Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_article_request"},"children":[]}]}]}},{"type":"link","label":"Create Audience Request","link":"/docs/references/rest-api/api.intercom.io/models/create_audience_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_audience_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_audience_request"},"seo":{"title":"Create Audience Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Audience Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_audience_request"},"children":[]}]}]}},{"type":"link","label":"Create Collection Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_collection_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_collection_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_collection_request"},"seo":{"title":"Create Collection Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Collection Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_collection_request"},"children":[]}]}]}},{"type":"link","label":"Create Contact Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_contact_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_contact_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_contact_request"},"seo":{"title":"Create Contact Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Contact Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_contact_request"},"children":[]}]}]}},{"type":"link","label":"Create Content Import Source Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_content_import_source_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_content_import_source_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_content_import_source_request"},"seo":{"title":"Create Content Import Source Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Content Import Source Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_content_import_source_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (Boolean)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_boolean_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_boolean_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_boolean_request"},"seo":{"title":"Create Conversation Attribute Request (Boolean)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (Boolean)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_boolean_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (Datetime)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_datetime_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_datetime_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_datetime_request"},"seo":{"title":"Create Conversation Attribute Request (Datetime)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (Datetime)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_datetime_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (Decimal)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_decimal_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_decimal_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_decimal_request"},"seo":{"title":"Create Conversation Attribute Request (Decimal)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (Decimal)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_decimal_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (Files)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_files_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_files_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_files_request"},"seo":{"title":"Create Conversation Attribute Request (Files)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (Files)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_files_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (Integer)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_integer_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_integer_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_integer_request"},"seo":{"title":"Create Conversation Attribute Request (Integer)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (Integer)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_integer_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (List)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_list_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_list_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_list_request"},"seo":{"title":"Create Conversation Attribute Request (List)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (List)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_list_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Option Request","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_option_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_option_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_option_request"},"seo":{"title":"Create Conversation Attribute Option Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Option Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_option_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (Relationship)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_relationship_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_relationship_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_relationship_request"},"seo":{"title":"Create Conversation Attribute Request (Relationship)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (Relationship)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_relationship_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_request"},"seo":{"title":"Create Conversation Attribute Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request Base","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_request_base","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_request_base","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_request_base"},"seo":{"title":"Create Conversation Attribute Request Base"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request Base","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_request_base"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Attribute Request (String)","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_string_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_attribute_string_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_attribute_string_request"},"seo":{"title":"Create Conversation Attribute Request (String)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Attribute Request (String)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_attribute_string_request"},"children":[]}]}]}},{"type":"link","label":"Create Conversation Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_request"},"seo":{"title":"Create Conversation Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Conversation Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Create conversation stream token request","link":"/docs/references/rest-api/api.intercom.io/models/create_conversation_stream_token_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_conversation_stream_token_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_conversation_stream_token_request"},"seo":{"title":"Create conversation stream token request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation stream token request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_conversation_stream_token_request"},"children":[]}]}]}},{"type":"link","label":"Create Data Attribute Request","link":"/docs/references/rest-api/api.intercom.io/models/create_data_attribute_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_data_attribute_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_data_attribute_request"},"seo":{"title":"Create Data Attribute Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Attribute Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_data_attribute_request"},"children":[]}]}]}},{"type":"link","label":"Create Data Connector Request","link":"/docs/references/rest-api/api.intercom.io/models/create_data_connector_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_data_connector_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_data_connector_request"},"seo":{"title":"Create Data Connector Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Connector Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_data_connector_request"},"children":[]}]}]}},{"type":"link","label":"Create Data Event Request","link":"/docs/references/rest-api/api.intercom.io/models/create_data_event_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_data_event_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_data_event_request"},"seo":{"title":"Create Data Event Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Event Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_data_event_request"},"children":[]}]}]}},{"type":"link","label":"Create Data Event Summaries Request","link":"/docs/references/rest-api/api.intercom.io/models/create_data_event_summaries_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_data_event_summaries_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_data_event_summaries_request"},"seo":{"title":"Create Data Event Summaries Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Event Summaries Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_data_event_summaries_request"},"children":[]}]}]}},{"type":"link","label":"Create Data Export Request","link":"/docs/references/rest-api/api.intercom.io/models/create_data_exports_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_data_exports_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_data_exports_request"},"seo":{"title":"Create Data Export Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Data Export Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_data_exports_request"},"children":[]}]}]}},{"type":"link","label":"Create External Page Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_external_page_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_external_page_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_external_page_request"},"seo":{"title":"Create External Page Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create External Page Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_external_page_request"},"children":[]}]}]}},{"type":"link","label":"Create Help Center Redirect Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_help_center_redirect_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_help_center_redirect_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_help_center_redirect_request"},"seo":{"title":"Create Help Center Redirect Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Help Center Redirect Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_help_center_redirect_request"},"children":[]}]}]}},{"type":"link","label":"Create Internal Article Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_internal_article_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_internal_article_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_internal_article_request"},"seo":{"title":"Create Internal Article Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Internal Article Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_internal_article_request"},"children":[]}]}]}},{"type":"link","label":"Create Message Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_message_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_message_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_message_request"},"seo":{"title":"Create Message Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Message Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_message_request"},"children":[]}]}]}},{"type":"link","label":"Create Office Hours Exception Request","link":"/docs/references/rest-api/api.intercom.io/models/create_office_hours_exception_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_office_hours_exception_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_office_hours_exception_request"},"seo":{"title":"Create Office Hours Exception Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Office Hours Exception Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_office_hours_exception_request"},"children":[]}]}]}},{"type":"link","label":"Create Office Hours Schedule Request","link":"/docs/references/rest-api/api.intercom.io/models/create_office_hours_schedule_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_office_hours_schedule_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_office_hours_schedule_request"},"seo":{"title":"Create Office Hours Schedule Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Office Hours Schedule Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_office_hours_schedule_request"},"children":[]}]}]}},{"type":"link","label":"Create Or Update Company Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_or_update_company_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_or_update_company_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_or_update_company_request"},"seo":{"title":"Create Or Update Company Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Or Update Company Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_or_update_company_request"},"children":[]}]}]}},{"type":"link","label":"Create Or Update Custom Object Instance Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_or_update_custom_object_instance_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_or_update_custom_object_instance_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_or_update_custom_object_instance_request"},"seo":{"title":"Create Or Update Custom Object Instance Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Or Update Custom Object Instance Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_or_update_custom_object_instance_request"},"children":[]}]}]}},{"type":"link","label":"Create or Update Tag Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_or_update_tag_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_or_update_tag_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_or_update_tag_request"},"seo":{"title":"Create or Update Tag Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update Tag Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_or_update_tag_request"},"children":[]}]}]}},{"type":"link","label":"Create Phone Switch Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_phone_switch_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_phone_switch_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_phone_switch_request"},"seo":{"title":"Create Phone Switch Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Phone Switch Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_phone_switch_request"},"children":[]}]}]}},{"type":"link","label":"Create Ticket Reply Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_ticket_reply_with_comment_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_ticket_reply_with_comment_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_ticket_reply_with_comment_request"},"seo":{"title":"Create Ticket Reply Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Ticket Reply Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_ticket_reply_with_comment_request"},"children":[]}]}]}},{"type":"link","label":"Create Ticket Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_ticket_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_ticket_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_ticket_request"},"seo":{"title":"Create Ticket Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Ticket Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_ticket_request"},"children":[]}]}]}},{"type":"link","label":"Create Ticket Type Attribute Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_ticket_type_attribute_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_ticket_type_attribute_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_ticket_type_attribute_request"},"seo":{"title":"Create Ticket Type Attribute Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Ticket Type Attribute Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_ticket_type_attribute_request"},"children":[]}]}]}},{"type":"link","label":"Create Ticket Type Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/create_ticket_type_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/create_ticket_type_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_ticket_type_request"},"seo":{"title":"Create Ticket Type Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Ticket Type Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_ticket_type_request"},"children":[]}]}]}},{"type":"link","label":"Cursor based pages","link":"/docs/references/rest-api/api.intercom.io/models/cursor_pages","routeSlug":"/docs/references/rest-api/api.intercom.io/models/cursor_pages","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"cursor_pages"},"seo":{"title":"Cursor based pages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cursor based pages","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/cursor_pages"},"children":[]}]}]}},{"type":"link","label":"Part type - custom_action_finished","link":"/docs/references/rest-api/api.intercom.io/models/custom_action_finished","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_action_finished","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_action_finished"},"seo":{"title":"Part type - custom_action_finished"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - custom_action_finished","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_action_finished"},"children":[]}]}]}},{"type":"link","label":"Part type - custom_action_started","link":"/docs/references/rest-api/api.intercom.io/models/custom_action_started","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_action_started","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_action_started"},"seo":{"title":"Part type - custom_action_started"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - custom_action_started","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_action_started"},"children":[]}]}]}},{"type":"link","label":"Custom Attributes","link":"/docs/references/rest-api/api.intercom.io/models/custom_attributes","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_attributes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_attributes"},"seo":{"title":"Custom Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Attributes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_attributes"},"children":[]}]}]}},{"type":"link","label":"Custom Attributes (write)","link":"/docs/references/rest-api/api.intercom.io/models/custom_attributes_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_attributes_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_attributes_request"},"seo":{"title":"Custom Attributes (write)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Attributes (write)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_attributes_request"},"children":[]}]}]}},{"type":"link","label":"Custom Object Instance Deleted","link":"/docs/references/rest-api/api.intercom.io/models/custom_object_instance_deleted","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_object_instance_deleted","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_object_instance_deleted"},"seo":{"title":"Custom Object Instance Deleted"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Instance Deleted","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_object_instance_deleted"},"children":[]}]}]}},{"type":"link","label":"Custom Object Instances","link":"/docs/references/rest-api/api.intercom.io/models/custom_object_instance_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_object_instance_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_object_instance_list"},"seo":{"title":"Custom Object Instances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Instances","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_object_instance_list"},"children":[]}]}]}},{"type":"link","label":"Custom Object Instance Not Found","link":"/docs/references/rest-api/api.intercom.io/models/custom_object_instance_not_found","routeSlug":"/docs/references/rest-api/api.intercom.io/models/custom_object_instance_not_found","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"custom_object_instance_not_found"},"seo":{"title":"Custom Object Instance Not Found"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Object Instance Not Found","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/custom_object_instance_not_found"},"children":[]}]}]}},{"type":"link","label":"customer_request","link":"/docs/references/rest-api/api.intercom.io/models/customer_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/customer_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"customer_request"},"seo":{"title":"customer_request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"customer_request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/customer_request"},"children":[]}]}]}},{"type":"link","label":"CX Score reason","link":"/docs/references/rest-api/api.intercom.io/models/cx_score_reason","routeSlug":"/docs/references/rest-api/api.intercom.io/models/cx_score_reason","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"cx_score_reason"},"seo":{"title":"CX Score reason"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CX Score reason","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/cx_score_reason"},"children":[]}]}]}},{"type":"link","label":"Data Attribute List","link":"/docs/references/rest-api/api.intercom.io/models/data_attribute_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_attribute_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_attribute_list"},"seo":{"title":"Data Attribute List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Attribute List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_attribute_list"},"children":[]}]}]}},{"type":"link","label":"Data Connector Execution Result List","link":"/docs/references/rest-api/api.intercom.io/models/data_connector_execution_result_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_connector_execution_result_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector_execution_result_list"},"seo":{"title":"Data Connector Execution Result List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector Execution Result List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector_execution_result_list"},"children":[]}]}]}},{"type":"link","label":"Data Connector List","link":"/docs/references/rest-api/api.intercom.io/models/data_connector_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_connector_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector_list"},"seo":{"title":"Data Connector List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector_list"},"children":[]}]}]}},{"type":"link","label":"Data Connector Version List","link":"/docs/references/rest-api/api.intercom.io/models/data_connector_version_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_connector_version_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_connector_version_list"},"seo":{"title":"Data Connector Version List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Connector Version List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_connector_version_list"},"children":[]}]}]}},{"type":"link","label":"Data Event List","link":"/docs/references/rest-api/api.intercom.io/models/data_event_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_event_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_event_list"},"seo":{"title":"Data Event List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Event List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_event_list"},"children":[]}]}]}},{"type":"link","label":"Data Event Summary","link":"/docs/references/rest-api/api.intercom.io/models/data_event_summary","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_event_summary","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_event_summary"},"seo":{"title":"Data Event Summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Event Summary","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_event_summary"},"children":[]}]}]}},{"type":"link","label":"Data Event Summary Item","link":"/docs/references/rest-api/api.intercom.io/models/data_event_summary_item","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_event_summary_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_event_summary_item"},"seo":{"title":"Data Event Summary Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Event Summary Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_event_summary_item"},"children":[]}]}]}},{"type":"link","label":"Data Export CSV","link":"/docs/references/rest-api/api.intercom.io/models/data_export_csv","routeSlug":"/docs/references/rest-api/api.intercom.io/models/data_export_csv","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"data_export_csv"},"seo":{"title":"Data Export CSV"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Export CSV","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/data_export_csv"},"children":[]}]}]}},{"type":"link","label":"datetime","link":"/docs/references/rest-api/api.intercom.io/models/datetime","routeSlug":"/docs/references/rest-api/api.intercom.io/models/datetime","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"datetime"},"seo":{"title":"datetime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"datetime","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/datetime"},"children":[]}]}]}},{"type":"link","label":"Deleted Article Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_article_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_article_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_article_object"},"seo":{"title":"Deleted Article Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Article Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_article_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Collection Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_collection_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_collection_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_collection_object"},"seo":{"title":"Deleted Collection Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Collection Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_collection_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Company Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_company_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_company_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_company_object"},"seo":{"title":"Deleted Company Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Company Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_company_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Contact","link":"/docs/references/rest-api/api.intercom.io/models/deleted_contact","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_contact","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_contact"},"seo":{"title":"Deleted Contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Contact","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_contact"},"children":[]}]}]}},{"type":"link","label":"Deleted Contact List","link":"/docs/references/rest-api/api.intercom.io/models/deleted_contact_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_contact_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_contact_list"},"seo":{"title":"Deleted Contact List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Contact List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_contact_list"},"children":[]}]}]}},{"type":"link","label":"Conversations","link":"/docs/references/rest-api/api.intercom.io/models/deleted_conversation_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_conversation_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_conversation_list"},"seo":{"title":"Conversations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversations","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_conversation_list"},"children":[]}]}]}},{"type":"link","label":"Deleted Data Connector Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_data_connector_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_data_connector_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_data_connector_object"},"seo":{"title":"Deleted Data Connector Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Data Connector Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_data_connector_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Folder Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_folder_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_folder_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_folder_object"},"seo":{"title":"Deleted Folder Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Folder Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_folder_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Help Center Redirect Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_help_center_redirect_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_help_center_redirect_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_help_center_redirect_object"},"seo":{"title":"Deleted Help Center Redirect Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Help Center Redirect Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_help_center_redirect_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Internal Article Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_internal_article_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_internal_article_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_internal_article_object"},"seo":{"title":"Deleted Internal Article Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Internal Article Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_internal_article_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Note Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_note_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_note_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_note_object"},"seo":{"title":"Deleted Note Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Note Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_note_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Object","link":"/docs/references/rest-api/api.intercom.io/models/deleted_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/deleted_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_object"},"seo":{"title":"Deleted Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_object"},"children":[]}]}]}},{"type":"link","label":"detach_contact_from_conversation_request","link":"/docs/references/rest-api/api.intercom.io/models/detach_contact_from_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/detach_contact_from_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"detach_contact_from_conversation_request"},"seo":{"title":"detach_contact_from_conversation_request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"detach_contact_from_conversation_request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/detach_contact_from_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Create Dynamic Content Request","link":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_create_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_create_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"dynamic_content_create_request"},"seo":{"title":"Create Dynamic Content Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Dynamic Content Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/dynamic_content_create_request"},"children":[]}]}]}},{"type":"link","label":"Dynamic Content List","link":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"dynamic_content_list"},"seo":{"title":"Dynamic Content List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic Content List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/dynamic_content_list"},"children":[]}]}]}},{"type":"link","label":"Update Dynamic Content Request","link":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_update_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_update_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"dynamic_content_update_request"},"seo":{"title":"Update Dynamic Content Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Dynamic Content Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/dynamic_content_update_request"},"children":[]}]}]}},{"type":"link","label":"Dynamic Content Variation Request","link":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_variation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/dynamic_content_variation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"dynamic_content_variation_request"},"seo":{"title":"Dynamic Content Variation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dynamic Content Variation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/dynamic_content_variation_request"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Catalog Product","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_product","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_product","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_catalog_product"},"seo":{"title":"Ecommerce Catalog Product"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Catalog Product","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_catalog_product"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Catalog Upload Part Response","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_upload_part_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_upload_part_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_catalog_upload_part_response"},"seo":{"title":"Ecommerce Catalog Upload Part Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Catalog Upload Part Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_catalog_upload_part_response"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Catalog Upload Response","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_upload_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_upload_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_catalog_upload_response"},"seo":{"title":"Ecommerce Catalog Upload Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Catalog Upload Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_catalog_upload_response"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Catalog Variant","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_variant","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_variant","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_catalog_variant"},"seo":{"title":"Ecommerce Catalog Variant"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Catalog Variant","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_catalog_variant"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Product Event Error","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_error","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_product_event_error"},"seo":{"title":"Ecommerce Product Event Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Product Event Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_product_event_error"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Product Event Product","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_product","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_product","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_product_event_product"},"seo":{"title":"Ecommerce Product Event Product"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Product Event Product","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_product_event_product"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Product Event Request","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_product_event_request"},"seo":{"title":"Ecommerce Product Event Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Product Event Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_product_event_request"},"children":[]}]}]}},{"type":"link","label":"Ecommerce Product Event Response","link":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ecommerce_product_event_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ecommerce_product_event_response"},"seo":{"title":"Ecommerce Product Event Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ecommerce Product Event Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ecommerce_product_event_response"},"children":[]}]}]}},{"type":"link","label":"Email Address Header","link":"/docs/references/rest-api/api.intercom.io/models/email_address_header","routeSlug":"/docs/references/rest-api/api.intercom.io/models/email_address_header","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"email_address_header"},"seo":{"title":"Email Address Header"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Address Header","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/email_address_header"},"children":[]}]}]}},{"type":"link","label":"Email Message Metadata","link":"/docs/references/rest-api/api.intercom.io/models/email_message_metadata","routeSlug":"/docs/references/rest-api/api.intercom.io/models/email_message_metadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"email_message_metadata"},"seo":{"title":"Email Message Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Message Metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/email_message_metadata"},"children":[]}]}]}},{"type":"link","label":"Error","link":"/docs/references/rest-api/api.intercom.io/models/error","routeSlug":"/docs/references/rest-api/api.intercom.io/models/error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"error"},"seo":{"title":"Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/error"},"children":[]}]}]}},{"type":"link","label":"Event details of Workflow & actions","link":"/docs/references/rest-api/api.intercom.io/models/event_details","routeSlug":"/docs/references/rest-api/api.intercom.io/models/event_details","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"event_details"},"seo":{"title":"Event details of Workflow & actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event details of Workflow & actions","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/event_details"},"children":[]}]}]}},{"type":"link","label":"File","link":"/docs/references/rest-api/api.intercom.io/models/file_attribute","routeSlug":"/docs/references/rest-api/api.intercom.io/models/file_attribute","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"file_attribute"},"seo":{"title":"File"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/file_attribute"},"children":[]}]}]}},{"type":"link","label":"Granted Company List","link":"/docs/references/rest-api/api.intercom.io/models/granted_company_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/granted_company_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"granted_company_list"},"seo":{"title":"Granted Company List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Granted Company List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/granted_company_list"},"children":[]}]}]}},{"type":"link","label":"Group Content","link":"/docs/references/rest-api/api.intercom.io/models/group_content","routeSlug":"/docs/references/rest-api/api.intercom.io/models/group_content","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"group_content"},"seo":{"title":"Group Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group Content","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/group_content"},"children":[]}]}]}},{"type":"link","label":"Group Translated Content","link":"/docs/references/rest-api/api.intercom.io/models/group_translated_content","routeSlug":"/docs/references/rest-api/api.intercom.io/models/group_translated_content","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"group_translated_content"},"seo":{"title":"Group Translated Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group Translated Content","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/group_translated_content"},"children":[]}]}]}},{"type":"link","label":"Handling Event","link":"/docs/references/rest-api/api.intercom.io/models/handling_event","routeSlug":"/docs/references/rest-api/api.intercom.io/models/handling_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"handling_event"},"seo":{"title":"Handling Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Handling Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/handling_event"},"children":[]}]}]}},{"type":"link","label":"Handling Event List","link":"/docs/references/rest-api/api.intercom.io/models/handling_event_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/handling_event_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"handling_event_list"},"seo":{"title":"Handling Event List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Handling Event List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/handling_event_list"},"children":[]}]}]}},{"type":"link","label":"Help Center Redirects","link":"/docs/references/rest-api/api.intercom.io/models/help_center_redirect_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/help_center_redirect_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"help_center_redirect_list"},"seo":{"title":"Help Center Redirects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Help Center Redirects","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/help_center_redirect_list"},"children":[]}]}]}},{"type":"link","label":"HITL Event","link":"/docs/references/rest-api/api.intercom.io/models/hitl_event","routeSlug":"/docs/references/rest-api/api.intercom.io/models/hitl_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"hitl_event"},"seo":{"title":"HITL Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HITL Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/hitl_event"},"children":[]}]}]}},{"type":"link","label":"HITL Event List","link":"/docs/references/rest-api/api.intercom.io/models/hitl_event_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/hitl_event_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"hitl_event_list"},"seo":{"title":"HITL Event List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HITL Event List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/hitl_event_list"},"children":[]}]}]}},{"type":"link","label":"intercom_version","link":"/docs/references/rest-api/api.intercom.io/models/intercom_version","routeSlug":"/docs/references/rest-api/api.intercom.io/models/intercom_version","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"intercom_version"},"seo":{"title":"intercom_version"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"intercom_version","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/intercom_version"},"children":[]}]}]}},{"type":"link","label":"Internal Articles","link":"/docs/references/rest-api/api.intercom.io/models/internal_article_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/internal_article_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"internal_article_list"},"seo":{"title":"Internal Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal Articles","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/internal_article_list"},"children":[]}]}]}},{"type":"link","label":"IP Allowlist","link":"/docs/references/rest-api/api.intercom.io/models/ip_allowlist","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ip_allowlist","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ip_allowlist"},"seo":{"title":"IP Allowlist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Allowlist","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ip_allowlist"},"children":[]}]}]}},{"type":"link","label":"Linked Object","link":"/docs/references/rest-api/api.intercom.io/models/linked_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/linked_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"linked_object"},"seo":{"title":"Linked Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linked Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/linked_object"},"children":[]}]}]}},{"type":"link","label":"Linked Objects","link":"/docs/references/rest-api/api.intercom.io/models/linked_object_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/linked_object_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"linked_object_list"},"seo":{"title":"Linked Objects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linked Objects","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/linked_object_list"},"children":[]}]}]}},{"type":"link","label":"Merge contact data","link":"/docs/references/rest-api/api.intercom.io/models/merge_contacts_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_contacts_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_contacts_request"},"seo":{"title":"Merge contact data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge contact data","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_contacts_request"},"children":[]}]}]}},{"type":"link","label":"Merge History Item","link":"/docs/references/rest-api/api.intercom.io/models/merge_history_item","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_history_item","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_history_item"},"seo":{"title":"Merge History Item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge History Item","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_history_item"},"children":[]}]}]}},{"type":"link","label":"Merge History List","link":"/docs/references/rest-api/api.intercom.io/models/merge_history_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_history_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_history_list"},"seo":{"title":"Merge History List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge History List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_history_list"},"children":[]}]}]}},{"type":"link","label":"Merge preview allowed","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_allowed","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_allowed","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_allowed"},"seo":{"title":"Merge preview allowed"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview allowed","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_allowed"},"children":[]}]}]}},{"type":"link","label":"Merge preview attribute change","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_attribute_change","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_attribute_change","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_attribute_change"},"seo":{"title":"Merge preview attribute change"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview attribute change","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_attribute_change"},"children":[]}]}]}},{"type":"link","label":"Merge preview attribute changes","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_attribute_changes","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_attribute_changes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_attribute_changes"},"seo":{"title":"Merge preview attribute changes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview attribute changes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_attribute_changes"},"children":[]}]}]}},{"type":"link","label":"Merge preview not allowed","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_blocked","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_blocked","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_blocked"},"seo":{"title":"Merge preview not allowed"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview not allowed","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_blocked"},"children":[]}]}]}},{"type":"link","label":"Merge preview reason","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_reason","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_reason","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_reason"},"seo":{"title":"Merge preview reason"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview reason","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_reason"},"children":[]}]}]}},{"type":"link","label":"Merge preview reassignments","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_reassignments","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_reassignments","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_reassignments"},"seo":{"title":"Merge preview reassignments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview reassignments","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_reassignments"},"children":[]}]}]}},{"type":"link","label":"Merge preview request","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_request"},"seo":{"title":"Merge preview request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_request"},"children":[]}]}]}},{"type":"link","label":"Merge preview response","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_response"},"seo":{"title":"Merge preview response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_response"},"children":[]}]}]}},{"type":"link","label":"Merge preview summary","link":"/docs/references/rest-api/api.intercom.io/models/merge_preview_summary","routeSlug":"/docs/references/rest-api/api.intercom.io/models/merge_preview_summary","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"merge_preview_summary"},"seo":{"title":"Merge preview summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge preview summary","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/merge_preview_summary"},"children":[]}]}]}},{"type":"link","label":"Multiple Filter Search Request","link":"/docs/references/rest-api/api.intercom.io/models/multiple_filter_search_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/multiple_filter_search_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"multiple_filter_search_request"},"seo":{"title":"Multiple Filter Search Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Multiple Filter Search Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/multiple_filter_search_request"},"children":[]}]}]}},{"type":"link","label":"Create News Item Request","link":"/docs/references/rest-api/api.intercom.io/models/news_item_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/news_item_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"news_item_request"},"seo":{"title":"Create News Item Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create News Item Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/news_item_request"},"children":[]}]}]}},{"type":"link","label":"Paginated Response","link":"/docs/references/rest-api/api.intercom.io/models/note_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/note_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"note_list"},"seo":{"title":"Paginated Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Paginated Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/note_list"},"children":[]}]}]}},{"type":"link","label":"Office Hours Exception List","link":"/docs/references/rest-api/api.intercom.io/models/office_hours_exception_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/office_hours_exception_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"office_hours_exception_list"},"seo":{"title":"Office Hours Exception List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Office Hours Exception List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/office_hours_exception_list"},"children":[]}]}]}},{"type":"link","label":"Office Hours Schedule List","link":"/docs/references/rest-api/api.intercom.io/models/office_hours_schedule_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/office_hours_schedule_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"office_hours_schedule_list"},"seo":{"title":"Office Hours Schedule List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Office Hours Schedule List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/office_hours_schedule_list"},"children":[]}]}]}},{"type":"link","label":"Open Conversation Request","link":"/docs/references/rest-api/api.intercom.io/models/open_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/open_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"open_conversation_request"},"seo":{"title":"Open Conversation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Open Conversation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/open_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Part type - operator_workflow_event","link":"/docs/references/rest-api/api.intercom.io/models/operator_workflow_event","routeSlug":"/docs/references/rest-api/api.intercom.io/models/operator_workflow_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"operator_workflow_event"},"seo":{"title":"Part type - operator_workflow_event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - operator_workflow_event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/operator_workflow_event"},"children":[]}]}]}},{"type":"link","label":"Pagination Object","link":"/docs/references/rest-api/api.intercom.io/models/pages_link","routeSlug":"/docs/references/rest-api/api.intercom.io/models/pages_link","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"pages_link"},"seo":{"title":"Pagination Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pagination Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/pages_link"},"children":[]}]}]}},{"type":"link","label":"Paginated Response","link":"/docs/references/rest-api/api.intercom.io/models/paginated_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/paginated_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"paginated_response"},"seo":{"title":"Paginated Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Paginated Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/paginated_response"},"children":[]}]}]}},{"type":"link","label":"Part attachment","link":"/docs/references/rest-api/api.intercom.io/models/part_attachment","routeSlug":"/docs/references/rest-api/api.intercom.io/models/part_attachment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"part_attachment"},"seo":{"title":"Part attachment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part attachment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/part_attachment"},"children":[]}]}]}},{"type":"link","label":"Phone Switch","link":"/docs/references/rest-api/api.intercom.io/models/phone_switch","routeSlug":"/docs/references/rest-api/api.intercom.io/models/phone_switch","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"phone_switch"},"seo":{"title":"Phone Switch"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phone Switch","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/phone_switch"},"children":[]}]}]}},{"type":"link","label":"Predicate","link":"/docs/references/rest-api/api.intercom.io/models/predicate","routeSlug":"/docs/references/rest-api/api.intercom.io/models/predicate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"predicate"},"seo":{"title":"Predicate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Predicate","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/predicate"},"children":[]}]}]}},{"type":"link","label":"Publish Article Draft Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/publish_article_draft_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/publish_article_draft_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"publish_article_draft_request"},"seo":{"title":"Publish Article Draft Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish Article Draft Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/publish_article_draft_request"},"children":[]}]}]}},{"type":"link","label":"Quick Reply Option","link":"/docs/references/rest-api/api.intercom.io/models/quick_reply_option","routeSlug":"/docs/references/rest-api/api.intercom.io/models/quick_reply_option","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"quick_reply_option"},"seo":{"title":"Quick Reply Option"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quick Reply Option","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/quick_reply_option"},"children":[]}]}]}},{"type":"link","label":"Rate conversation request","link":"/docs/references/rest-api/api.intercom.io/models/rate_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/rate_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"rate_conversation_request"},"seo":{"title":"Rate conversation request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate conversation request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/rate_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Recipient","link":"/docs/references/rest-api/api.intercom.io/models/recipient","routeSlug":"/docs/references/rest-api/api.intercom.io/models/recipient","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"recipient"},"seo":{"title":"Recipient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipient","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/recipient"},"children":[]}]}]}},{"type":"link","label":"redact_conversation_request","link":"/docs/references/rest-api/api.intercom.io/models/redact_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/redact_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"redact_conversation_request"},"seo":{"title":"redact_conversation_request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"redact_conversation_request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/redact_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Reference","link":"/docs/references/rest-api/api.intercom.io/models/reference","routeSlug":"/docs/references/rest-api/api.intercom.io/models/reference","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"reference"},"seo":{"title":"Reference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/reference"},"children":[]}]}]}},{"type":"link","label":"Register Fin Voice Call Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/register_fin_voice_call_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/register_fin_voice_call_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"register_fin_voice_call_request"},"seo":{"title":"Register Fin Voice Call Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register Fin Voice Call Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/register_fin_voice_call_request"},"children":[]}]}]}},{"type":"link","label":"Replace Granted Companies Request","link":"/docs/references/rest-api/api.intercom.io/models/replace_granted_companies_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/replace_granted_companies_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"replace_granted_companies_request"},"seo":{"title":"Replace Granted Companies Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace Granted Companies Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/replace_granted_companies_request"},"children":[]}]}]}},{"type":"link","label":"reply_conversation_request","link":"/docs/references/rest-api/api.intercom.io/models/reply_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/reply_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"reply_conversation_request"},"seo":{"title":"reply_conversation_request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"reply_conversation_request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/reply_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Search data","link":"/docs/references/rest-api/api.intercom.io/models/search_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/search_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"search_request"},"seo":{"title":"Search data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search data","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/search_request"},"children":[]}]}]}},{"type":"link","label":"Segment List","link":"/docs/references/rest-api/api.intercom.io/models/segment_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/segment_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"segment_list"},"seo":{"title":"Segment List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Segment List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/segment_list"},"children":[]}]}]}},{"type":"link","label":"Side Conversation List","link":"/docs/references/rest-api/api.intercom.io/models/side_conversation_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/side_conversation_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"side_conversation_list"},"seo":{"title":"Side Conversation List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Side Conversation List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/side_conversation_list"},"children":[]}]}]}},{"type":"link","label":"Side Conversation Summary","link":"/docs/references/rest-api/api.intercom.io/models/side_conversation_summary","routeSlug":"/docs/references/rest-api/api.intercom.io/models/side_conversation_summary","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"side_conversation_summary"},"seo":{"title":"Side Conversation Summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Side Conversation Summary","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/side_conversation_summary"},"children":[]}]}]}},{"type":"link","label":"Single Filter Search Request","link":"/docs/references/rest-api/api.intercom.io/models/single_filter_search_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/single_filter_search_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"single_filter_search_request"},"seo":{"title":"Single Filter Search Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Single Filter Search Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/single_filter_search_request"},"children":[]}]}]}},{"type":"link","label":"Applied SLA","link":"/docs/references/rest-api/api.intercom.io/models/sla_applied","routeSlug":"/docs/references/rest-api/api.intercom.io/models/sla_applied","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"sla_applied"},"seo":{"title":"Applied SLA"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Applied SLA","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/sla_applied"},"children":[]}]}]}},{"type":"link","label":"Snooze Conversation Request","link":"/docs/references/rest-api/api.intercom.io/models/snooze_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/snooze_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"snooze_conversation_request"},"seo":{"title":"Snooze Conversation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Snooze Conversation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/snooze_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Social Profile","link":"/docs/references/rest-api/api.intercom.io/models/social_profile","routeSlug":"/docs/references/rest-api/api.intercom.io/models/social_profile","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"social_profile"},"seo":{"title":"Social Profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Social Profile","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/social_profile"},"children":[]}]}]}},{"type":"link","label":"Email Message Metadata","link":"/docs/references/rest-api/api.intercom.io/models/source_email_message_metadata","routeSlug":"/docs/references/rest-api/api.intercom.io/models/source_email_message_metadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"source_email_message_metadata"},"seo":{"title":"Email Message Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Message Metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/source_email_message_metadata"},"children":[]}]}]}},{"type":"link","label":"Part type - standalone_platform_handoff","link":"/docs/references/rest-api/api.intercom.io/models/standalone_platform_handoff","routeSlug":"/docs/references/rest-api/api.intercom.io/models/standalone_platform_handoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"standalone_platform_handoff"},"seo":{"title":"Part type - standalone_platform_handoff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Part type - standalone_platform_handoff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/standalone_platform_handoff"},"children":[]}]}]}},{"type":"link","label":"Pagination: Starting After","link":"/docs/references/rest-api/api.intercom.io/models/starting_after_paging","routeSlug":"/docs/references/rest-api/api.intercom.io/models/starting_after_paging","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"starting_after_paging"},"seo":{"title":"Pagination: Starting After"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pagination: Starting After","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/starting_after_paging"},"children":[]}]}]}},{"type":"link","label":"Subscription Types","link":"/docs/references/rest-api/api.intercom.io/models/subscription_type_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/subscription_type_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"subscription_type_list"},"seo":{"title":"Subscription Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription Types","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/subscription_type_list"},"children":[]}]}]}},{"type":"link","label":"Tag Company Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/tag_company_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/tag_company_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tag_company_request"},"seo":{"title":"Tag Company Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Company Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tag_company_request"},"children":[]}]}]}},{"type":"link","label":"Create or Update Tag Response","link":"/docs/references/rest-api/api.intercom.io/models/tag_create_response","routeSlug":"/docs/references/rest-api/api.intercom.io/models/tag_create_response","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tag_create_response"},"seo":{"title":"Create or Update Tag Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update Tag Response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tag_create_response"},"children":[]}]}]}},{"type":"link","label":"Tags","link":"/docs/references/rest-api/api.intercom.io/models/tag_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/tag_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tag_list"},"seo":{"title":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tag_list"},"children":[]}]}]}},{"type":"link","label":"Tag Users Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/tag_multiple_users_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/tag_multiple_users_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tag_multiple_users_request"},"seo":{"title":"Tag Users Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Users Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tag_multiple_users_request"},"children":[]}]}]}},{"type":"link","label":"Tags","link":"/docs/references/rest-api/api.intercom.io/models/tags","routeSlug":"/docs/references/rest-api/api.intercom.io/models/tags","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"tags"},"seo":{"title":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/tags"},"children":[]}]}]}},{"type":"link","label":"Team Handling Segment","link":"/docs/references/rest-api/api.intercom.io/models/team_handling_segment","routeSlug":"/docs/references/rest-api/api.intercom.io/models/team_handling_segment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team_handling_segment"},"seo":{"title":"Team Handling Segment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Handling Segment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team_handling_segment"},"children":[]}]}]}},{"type":"link","label":"Team Handling Segment List","link":"/docs/references/rest-api/api.intercom.io/models/team_handling_segment_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/team_handling_segment_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team_handling_segment_list"},"seo":{"title":"Team Handling Segment List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Handling Segment List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team_handling_segment_list"},"children":[]}]}]}},{"type":"link","label":"Team List","link":"/docs/references/rest-api/api.intercom.io/models/team_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/team_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team_list"},"seo":{"title":"Team List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team_list"},"children":[]}]}]}},{"type":"link","label":"team_metric","link":"/docs/references/rest-api/api.intercom.io/models/team_metric","routeSlug":"/docs/references/rest-api/api.intercom.io/models/team_metric","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team_metric"},"seo":{"title":"team_metric"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"team_metric","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team_metric"},"children":[]}]}]}},{"type":"link","label":"team_metric_list","link":"/docs/references/rest-api/api.intercom.io/models/team_metric_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/team_metric_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team_metric_list"},"seo":{"title":"team_metric_list"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"team_metric_list","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team_metric_list"},"children":[]}]}]}},{"type":"link","label":"Team Priority Level","link":"/docs/references/rest-api/api.intercom.io/models/team_priority_level","routeSlug":"/docs/references/rest-api/api.intercom.io/models/team_priority_level","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"team_priority_level"},"seo":{"title":"Team Priority Level"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Priority Level","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/team_priority_level"},"children":[]}]}]}},{"type":"link","label":"Teammate Reference","link":"/docs/references/rest-api/api.intercom.io/models/teammate_reference","routeSlug":"/docs/references/rest-api/api.intercom.io/models/teammate_reference","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"teammate_reference"},"seo":{"title":"Teammate Reference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teammate Reference","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/teammate_reference"},"children":[]}]}]}},{"type":"link","label":"Ticket Attributes","link":"/docs/references/rest-api/api.intercom.io/models/ticket_custom_attributes","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_custom_attributes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_custom_attributes"},"seo":{"title":"Ticket Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Attributes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_custom_attributes"},"children":[]}]}]}},{"type":"link","label":"Ticket Deleted","link":"/docs/references/rest-api/api.intercom.io/models/ticket_deleted","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_deleted","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_deleted"},"seo":{"title":"Ticket Deleted"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Deleted","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_deleted"},"children":[]}]}]}},{"type":"link","label":"Ticket List","link":"/docs/references/rest-api/api.intercom.io/models/ticket_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_list"},"seo":{"title":"Ticket List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_list"},"children":[]}]}]}},{"type":"link","label":"Ticket part author","link":"/docs/references/rest-api/api.intercom.io/models/ticket_part_author","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_part_author","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_part_author"},"seo":{"title":"Ticket part author"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket part author","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_part_author"},"children":[]}]}]}},{"type":"link","label":"Ticket Parts","link":"/docs/references/rest-api/api.intercom.io/models/ticket_parts","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_parts","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_parts"},"seo":{"title":"Ticket Parts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Parts","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_parts"},"children":[]}]}]}},{"type":"link","label":"A Ticket Part representing a note, comment, or quick_reply on a ticket","link":"/docs/references/rest-api/api.intercom.io/models/ticket_reply","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_reply","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_reply"},"seo":{"title":"A Ticket Part representing a note, comment, or quick_reply on a ticket"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"A Ticket Part representing a note, comment, or quick_reply on a ticket","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_reply"},"children":[]}]}]}},{"type":"link","label":"Ticket Attributes","link":"/docs/references/rest-api/api.intercom.io/models/ticket_request_custom_attributes","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_request_custom_attributes","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_request_custom_attributes"},"seo":{"title":"Ticket Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Attributes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_request_custom_attributes"},"children":[]}]}]}},{"type":"link","label":"Ticket States","link":"/docs/references/rest-api/api.intercom.io/models/ticket_state_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_state_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_state_list"},"seo":{"title":"Ticket States"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket States","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_state_list"},"children":[]}]}]}},{"type":"link","label":"Ticket Type Attribute","link":"/docs/references/rest-api/api.intercom.io/models/ticket_type_attribute","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_type_attribute","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_type_attribute"},"seo":{"title":"Ticket Type Attribute"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Type Attribute","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_type_attribute"},"children":[]}]}]}},{"type":"link","label":"Ticket Type Attributes","link":"/docs/references/rest-api/api.intercom.io/models/ticket_type_attribute_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_type_attribute_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_type_attribute_list"},"seo":{"title":"Ticket Type Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Type Attributes","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_type_attribute_list"},"children":[]}]}]}},{"type":"link","label":"Ticket Types","link":"/docs/references/rest-api/api.intercom.io/models/ticket_type_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/ticket_type_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_type_list"},"seo":{"title":"Ticket Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Types","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_type_list"},"children":[]}]}]}},{"type":"link","label":"Translation","link":"/docs/references/rest-api/api.intercom.io/models/translation","routeSlug":"/docs/references/rest-api/api.intercom.io/models/translation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"translation"},"seo":{"title":"Translation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Translation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/translation"},"children":[]}]}]}},{"type":"link","label":"Untag Company Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/untag_company_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/untag_company_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"untag_company_request"},"seo":{"title":"Untag Company Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag Company Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/untag_company_request"},"children":[]}]}]}},{"type":"link","label":"Update Article Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_article_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_article_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_article_request"},"seo":{"title":"Update Article Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Article Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_article_request"},"children":[]}]}]}},{"type":"link","label":"Update Audience Request","link":"/docs/references/rest-api/api.intercom.io/models/update_audience_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_audience_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_audience_request"},"seo":{"title":"Update Audience Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Audience Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_audience_request"},"children":[]}]}]}},{"type":"link","label":"Update Collection Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_collection_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_collection_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_collection_request"},"seo":{"title":"Update Collection Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Collection Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_collection_request"},"children":[]}]}]}},{"type":"link","label":"Update Company Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_company_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_company_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_company_request"},"seo":{"title":"Update Company Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_company_request"},"children":[]}]}]}},{"type":"link","label":"Update Contact Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_contact_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_contact_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_contact_request"},"seo":{"title":"Update Contact Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Contact Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_contact_request"},"children":[]}]}]}},{"type":"link","label":"Update Content Import Source Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_content_import_source_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_content_import_source_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_content_import_source_request"},"seo":{"title":"Update Content Import Source Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Content Import Source Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_content_import_source_request"},"children":[]}]}]}},{"type":"link","label":"Update Conversation Attribute Option Request","link":"/docs/references/rest-api/api.intercom.io/models/update_conversation_attribute_option_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_conversation_attribute_option_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_conversation_attribute_option_request"},"seo":{"title":"Update Conversation Attribute Option Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Conversation Attribute Option Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_conversation_attribute_option_request"},"children":[]}]}]}},{"type":"link","label":"Update Conversation Attribute Request","link":"/docs/references/rest-api/api.intercom.io/models/update_conversation_attribute_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_conversation_attribute_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_conversation_attribute_request"},"seo":{"title":"Update Conversation Attribute Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Conversation Attribute Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_conversation_attribute_request"},"children":[]}]}]}},{"type":"link","label":"Update Conversation Request","link":"/docs/references/rest-api/api.intercom.io/models/update_conversation_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_conversation_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_conversation_request"},"seo":{"title":"Update Conversation Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Conversation Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_conversation_request"},"children":[]}]}]}},{"type":"link","label":"Update Data Attribute Request","link":"/docs/references/rest-api/api.intercom.io/models/update_data_attribute_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_data_attribute_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_data_attribute_request"},"seo":{"title":"Update Data Attribute Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Attribute Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_data_attribute_request"},"children":[]}]}]}},{"type":"link","label":"Update Data Connector Request","link":"/docs/references/rest-api/api.intercom.io/models/update_data_connector_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_data_connector_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_data_connector_request"},"seo":{"title":"Update Data Connector Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Connector Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_data_connector_request"},"children":[]}]}]}},{"type":"link","label":"Update Data Connector Version Request","link":"/docs/references/rest-api/api.intercom.io/models/update_data_connector_version_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_data_connector_version_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_data_connector_version_request"},"seo":{"title":"Update Data Connector Version Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Data Connector Version Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_data_connector_version_request"},"children":[]}]}]}},{"type":"link","label":"Update External Page Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_external_page_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_external_page_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_external_page_request"},"seo":{"title":"Update External Page Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update External Page Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_external_page_request"},"children":[]}]}]}},{"type":"link","label":"Update Internal Article Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_internal_article_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_internal_article_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_internal_article_request"},"seo":{"title":"Update Internal Article Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Internal Article Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_internal_article_request"},"children":[]}]}]}},{"type":"link","label":"Update News Item Request","link":"/docs/references/rest-api/api.intercom.io/models/update_news_item_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_news_item_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_news_item_request"},"seo":{"title":"Update News Item Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update News Item Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_news_item_request"},"children":[]}]}]}},{"type":"link","label":"Update Office Hours Exception Request","link":"/docs/references/rest-api/api.intercom.io/models/update_office_hours_exception_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_office_hours_exception_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_office_hours_exception_request"},"seo":{"title":"Update Office Hours Exception Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Office Hours Exception Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_office_hours_exception_request"},"children":[]}]}]}},{"type":"link","label":"Update Office Hours Schedule Request","link":"/docs/references/rest-api/api.intercom.io/models/update_office_hours_schedule_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_office_hours_schedule_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_office_hours_schedule_request"},"seo":{"title":"Update Office Hours Schedule Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Office Hours Schedule Request","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_office_hours_schedule_request"},"children":[]}]}]}},{"type":"link","label":"Update Ticket Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_ticket_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_ticket_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_ticket_request"},"seo":{"title":"Update Ticket Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Ticket Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_ticket_request"},"children":[]}]}]}},{"type":"link","label":"Update Ticket Type Attribute Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_ticket_type_attribute_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_ticket_type_attribute_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_ticket_type_attribute_request"},"seo":{"title":"Update Ticket Type Attribute Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Ticket Type Attribute Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_ticket_type_attribute_request"},"children":[]}]}]}},{"type":"link","label":"Update Ticket Type Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_ticket_type_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_ticket_type_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_ticket_type_request"},"seo":{"title":"Update Ticket Type Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Ticket Type Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_ticket_type_request"},"children":[]}]}]}},{"type":"link","label":"Update Visitor Request Payload","link":"/docs/references/rest-api/api.intercom.io/models/update_visitor_request","routeSlug":"/docs/references/rest-api/api.intercom.io/models/update_visitor_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_visitor_request"},"seo":{"title":"Update Visitor Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Visitor Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_visitor_request"},"children":[]}]}]}},{"type":"link","label":"Visitor","link":"/docs/references/rest-api/api.intercom.io/models/visitor","routeSlug":"/docs/references/rest-api/api.intercom.io/models/visitor","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"visitor"},"seo":{"title":"Visitor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitor","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/visitor"},"children":[]}]}]}},{"type":"link","label":"Visitor Deleted Object","link":"/docs/references/rest-api/api.intercom.io/models/visitor_deleted_object","routeSlug":"/docs/references/rest-api/api.intercom.io/models/visitor_deleted_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"visitor_deleted_object"},"seo":{"title":"Visitor Deleted Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitor Deleted Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/visitor_deleted_object"},"children":[]}]}]}},{"type":"link","label":"whatsapp_message_status","link":"/docs/references/rest-api/api.intercom.io/models/whatsapp_message_status","routeSlug":"/docs/references/rest-api/api.intercom.io/models/whatsapp_message_status","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"whatsapp_message_status"},"seo":{"title":"whatsapp_message_status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"whatsapp_message_status","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/whatsapp_message_status"},"children":[]}]}]}},{"type":"link","label":"whatsapp_message_status_list","link":"/docs/references/rest-api/api.intercom.io/models/whatsapp_message_status_list","routeSlug":"/docs/references/rest-api/api.intercom.io/models/whatsapp_message_status_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"whatsapp_message_status_list"},"seo":{"title":"whatsapp_message_status_list"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"whatsapp_message_status_list","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/whatsapp_message_status_list"},"children":[]}]}]}},{"type":"link","label":"Workflow Export","link":"/docs/references/rest-api/api.intercom.io/models/workflow_export","routeSlug":"/docs/references/rest-api/api.intercom.io/models/workflow_export","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"workflow_export"},"seo":{"title":"Workflow Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow Export","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/workflow_export"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Models"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Models","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Activity Log","link":"/models/activity_log","deprecated":false},{"title":"Paginated Response","link":"/models/activity_log_list","deprecated":false},{"title":"Activity Log Metadata","link":"/models/activity_log_metadata","deprecated":false},{"title":"Addressable List","link":"/models/addressable_list","deprecated":false},{"title":"Admins","link":"/models/admin_list","deprecated":false},{"title":"Admin Priority Level","link":"/models/admin_priority_level","deprecated":false},{"title":"Admin Reply","link":"/models/admin_reply_conversation_request","deprecated":false},{"title":"Admin Reply on ticket","link":"/models/admin_reply_ticket_request","deprecated":false},{"title":"Admin","link":"/models/admin_with_app","deprecated":false},{"title":"Part type - ai_agent_event (otp_email_verification_failed)","link":"/models/ai_agent_event_otp_email_verification_failed","deprecated":false},{"title":"AI Call Response","link":"/models/ai_call_response","deprecated":false},{"title":"AI Topic and Subtopic","link":"/models/ai_topic_subtopic","deprecated":false},{"title":"App","link":"/models/app","deprecated":false},{"title":"Article Content","link":"/models/article_content","deprecated":false},{"title":"Articles","link":"/models/article_list","deprecated":false},{"title":"Article Statistics","link":"/models/article_statistics","deprecated":false},{"title":"Article Translated Content","link":"/models/article_translated_content","deprecated":false},{"title":"Article Versions","link":"/models/article_version_list","deprecated":false},{"title":"Assign Conversation Request","link":"/models/assign_conversation_request","deprecated":false},{"title":"Attach Contact To Conversation Request","link":"/models/attach_contact_to_conversation_request","deprecated":false},{"title":"Audience List","link":"/models/audience_list","deprecated":false},{"title":"Auth Token List","link":"/models/auth_token_list","deprecated":false},{"title":"away_status_reason","link":"/models/away_status_reason","deprecated":false},{"title":"Away Status Reasons","link":"/models/away_status_reason_list","deprecated":false},{"title":"Banner List","link":"/models/banner_list","deprecated":false},{"title":"Bot Reply","link":"/models/bot_reply_conversation_request","deprecated":false},{"title":"Bulk Create Contacts Request","link":"/models/bulk_create_contacts_request","deprecated":false},{"title":"Bulk Delete Contacts Request","link":"/models/bulk_delete_contacts_request","deprecated":false},{"title":"Bulk Update Contacts Request","link":"/models/bulk_update_contacts_request","deprecated":false},{"title":"Calls","link":"/models/call_list","deprecated":false},{"title":"Part type - call_summary","link":"/models/call_summary","deprecated":false},{"title":"Change Ticket Type Request","link":"/models/change_ticket_type_request","deprecated":false},{"title":"Close Conversation Request","link":"/models/close_conversation_request","deprecated":false},{"title":"Collections","link":"/models/collection_list","deprecated":false},{"title":"Company Attached Contacts","link":"/models/company_attached_contacts","deprecated":false},{"title":"Company Attached Segments","link":"/models/company_attached_segments","deprecated":false},{"title":"Company Data","link":"/models/company_data","deprecated":false},{"title":"Companies","link":"/models/company_list","deprecated":false},{"title":"Company Scroll","link":"/models/company_scroll","deprecated":false},{"title":"Company search request","link":"/models/company_search_request","deprecated":false},{"title":"Company Search Response","link":"/models/company_search_response","deprecated":false},{"title":"Company Users","link":"/models/company_user_list","deprecated":false},{"title":"Contact Activity","link":"/models/contact_activity","deprecated":false},{"title":"Contact Activity List","link":"/models/contact_activity_list","deprecated":false},{"title":"Contact Archived","link":"/models/contact_archived","deprecated":false},{"title":"Contact Attached Companies","link":"/models/contact_attached_companies","deprecated":false},{"title":"Contact Blocked","link":"/models/contact_blocked","deprecated":false},{"title":"Contact companies","link":"/models/contact_companies","deprecated":false},{"title":"Contact Deleted","link":"/models/contact_deleted","deprecated":false},{"title":"Contact List","link":"/models/contact_list","deprecated":false},{"title":"Contact Location","link":"/models/contact_location","deprecated":false},{"title":"Contact notes","link":"/models/contact_notes","deprecated":false},{"title":"Contact Reference","link":"/models/contact_reference","deprecated":false},{"title":"Contact Reply Base Object","link":"/models/contact_reply_base_request","deprecated":false},{"title":"Contact Reply","link":"/models/contact_reply_conversation_request","deprecated":false},{"title":"Email","link":"/models/contact_reply_email_request","deprecated":false},{"title":"Intercom User ID","link":"/models/contact_reply_intercom_user_id_request","deprecated":false},{"title":"Email","link":"/models/contact_reply_ticket_email_request","deprecated":false},{"title":"Intercom User ID","link":"/models/contact_reply_ticket_intercom_user_id_request","deprecated":false},{"title":"Contact Reply on ticket","link":"/models/contact_reply_ticket_request","deprecated":false},{"title":"User ID","link":"/models/contact_reply_ticket_user_id_request","deprecated":false},{"title":"User ID","link":"/models/contact_reply_user_id_request","deprecated":false},{"title":"Contact search request","link":"/models/contact_search_request","deprecated":false},{"title":"Segments","link":"/models/contact_segments","deprecated":false},{"title":"Social Profile","link":"/models/contact_social_profiles","deprecated":false},{"title":"Contact Subscription Types","link":"/models/contact_subscription_types","deprecated":false},{"title":"Contact Tags","link":"/models/contact_tags","deprecated":false},{"title":"Contact Unarchived","link":"/models/contact_unarchived","deprecated":false},{"title":"Content Bulk Action Request Payload","link":"/models/content_bulk_action_request","deprecated":false},{"title":"Content Bulk Action Response Envelope","link":"/models/content_bulk_action_response","deprecated":false},{"title":"Content Search Article Content Item","link":"/models/content_search_article_content_item","deprecated":false},{"title":"Content Search Article Item","link":"/models/content_search_article_item","deprecated":false},{"title":"Content Search Default Item","link":"/models/content_search_default_item","deprecated":false},{"title":"Content Search Response","link":"/models/content_search_response","deprecated":false},{"title":"Content Search Result","link":"/models/content_search_result","deprecated":false},{"title":"Create Content Snippet Request","link":"/models/content_snippet_create_request","deprecated":false},{"title":"Content Snippet List","link":"/models/content_snippet_list","deprecated":false},{"title":"Update Content Snippet Request","link":"/models/content_snippet_update_request","deprecated":false},{"title":"Content Source List","link":"/models/content_sources_list","deprecated":false},{"title":"Conversation attachment files","link":"/models/conversation_attachment_files","deprecated":false},{"title":"Conversation Attribute Base","link":"/models/conversation_attribute_base","deprecated":false},{"title":"Conversation Attribute (Boolean)","link":"/models/conversation_attribute_boolean_type","deprecated":false},{"title":"Conversation Attribute (Datetime)","link":"/models/conversation_attribute_datetime_type","deprecated":false},{"title":"Conversation Attribute (Decimal)","link":"/models/conversation_attribute_decimal_type","deprecated":false},{"title":"Conversation Attribute (Files)","link":"/models/conversation_attribute_files_type","deprecated":false},{"title":"Conversation Attribute (Integer)","link":"/models/conversation_attribute_integer_type","deprecated":false},{"title":"Conversation Attribute List","link":"/models/conversation_attribute_list","deprecated":false},{"title":"Conversation Attribute (List)","link":"/models/conversation_attribute_list_type","deprecated":false},{"title":"Conversation Attribute Option","link":"/models/conversation_attribute_option","deprecated":false},{"title":"Conversation Attribute (Relationship)","link":"/models/conversation_attribute_relationship_type","deprecated":false},{"title":"Conversation Attribute (String)","link":"/models/conversation_attribute_string_type","deprecated":false},{"title":"Part type - conversation_attribute_updated_by_admin","link":"/models/conversation_attribute_updated_by_admin","deprecated":false},{"title":"Part type - conversation_attribute_updated_by_user","link":"/models/conversation_attribute_updated_by_user","deprecated":false},{"title":"Part type - conversation_attribute_updated_by_workflow","link":"/models/conversation_attribute_updated_by_workflow","deprecated":false},{"title":"Conversation Channel","link":"/models/conversation_channel","deprecated":false},{"title":"Contacts","link":"/models/conversation_contacts","deprecated":false},{"title":"Conversation Deleted","link":"/models/conversation_deleted","deprecated":false},{"title":"Conversation External Reference","link":"/models/conversation_external_reference","deprecated":false},{"title":"First contact reply","link":"/models/conversation_first_contact_reply","deprecated":false},{"title":"Conversation List","link":"/models/conversation_list","deprecated":false},{"title":"Conversation Part","link":"/models/conversation_part","deprecated":false},{"title":"Conversation part author","link":"/models/conversation_part_author","deprecated":false},{"title":"Conversation Part Metadata","link":"/models/conversation_part_metadata","deprecated":false},{"title":"Conversation Participants Response","link":"/models/conversation_participants_response","deprecated":false},{"title":"Conversation Parts","link":"/models/conversation_parts","deprecated":false},{"title":"Conversation Rating","link":"/models/conversation_rating","deprecated":false},{"title":"Conversation response time","link":"/models/conversation_response_time","deprecated":false},{"title":"Conversation source","link":"/models/conversation_source","deprecated":false},{"title":"Conversation source author","link":"/models/conversation_source_author","deprecated":false},{"title":"Conversation statistics","link":"/models/conversation_statistics","deprecated":false},{"title":"Conversation teammates","link":"/models/conversation_teammates","deprecated":false},{"title":"Convert Ticket Request Payload","link":"/models/convert_conversation_to_ticket_request","deprecated":false},{"title":"Convert Visitor Request Payload","link":"/models/convert_visitor_request","deprecated":false},{"title":"Create Article Request Payload","link":"/models/create_article_request","deprecated":false},{"title":"Create Audience Request","link":"/models/create_audience_request","deprecated":false},{"title":"Create Collection Request Payload","link":"/models/create_collection_request","deprecated":false},{"title":"Create Contact Request Payload","link":"/models/create_contact_request","deprecated":false},{"title":"Create Content Import Source Payload","link":"/models/create_content_import_source_request","deprecated":false},{"title":"Create Conversation Attribute Request (Boolean)","link":"/models/create_conversation_attribute_boolean_request","deprecated":false},{"title":"Create Conversation Attribute Request (Datetime)","link":"/models/create_conversation_attribute_datetime_request","deprecated":false},{"title":"Create Conversation Attribute Request (Decimal)","link":"/models/create_conversation_attribute_decimal_request","deprecated":false},{"title":"Create Conversation Attribute Request (Files)","link":"/models/create_conversation_attribute_files_request","deprecated":false},{"title":"Create Conversation Attribute Request (Integer)","link":"/models/create_conversation_attribute_integer_request","deprecated":false},{"title":"Create Conversation Attribute Request (List)","link":"/models/create_conversation_attribute_list_request","deprecated":false},{"title":"Create Conversation Attribute Option Request","link":"/models/create_conversation_attribute_option_request","deprecated":false},{"title":"Create Conversation Attribute Request (Relationship)","link":"/models/create_conversation_attribute_relationship_request","deprecated":false},{"title":"Create Conversation Attribute Request","link":"/models/create_conversation_attribute_request","deprecated":false},{"title":"Create Conversation Attribute Request Base","link":"/models/create_conversation_attribute_request_base","deprecated":false},{"title":"Create Conversation Attribute Request (String)","link":"/models/create_conversation_attribute_string_request","deprecated":false},{"title":"Create Conversation Request Payload","link":"/models/create_conversation_request","deprecated":false},{"title":"Create conversation stream token request","link":"/models/create_conversation_stream_token_request","deprecated":false},{"title":"Create Data Attribute Request","link":"/models/create_data_attribute_request","deprecated":false},{"title":"Create Data Connector Request","link":"/models/create_data_connector_request","deprecated":false},{"title":"Create Data Event Request","link":"/models/create_data_event_request","deprecated":false},{"title":"Create Data Event Summaries Request","link":"/models/create_data_event_summaries_request","deprecated":false},{"title":"Create Data Export Request","link":"/models/create_data_exports_request","deprecated":false},{"title":"Create External Page Payload","link":"/models/create_external_page_request","deprecated":false},{"title":"Create Help Center Redirect Request Payload","link":"/models/create_help_center_redirect_request","deprecated":false},{"title":"Create Internal Article Request Payload","link":"/models/create_internal_article_request","deprecated":false},{"title":"Create Message Request Payload","link":"/models/create_message_request","deprecated":false},{"title":"Create Office Hours Exception Request","link":"/models/create_office_hours_exception_request","deprecated":false},{"title":"Create Office Hours Schedule Request","link":"/models/create_office_hours_schedule_request","deprecated":false},{"title":"Create Or Update Company Request Payload","link":"/models/create_or_update_company_request","deprecated":false},{"title":"Create Or Update Custom Object Instance Request Payload","link":"/models/create_or_update_custom_object_instance_request","deprecated":false},{"title":"Create or Update Tag Request Payload","link":"/models/create_or_update_tag_request","deprecated":false},{"title":"Create Phone Switch Request Payload","link":"/models/create_phone_switch_request","deprecated":false},{"title":"Create Ticket Reply Request Payload","link":"/models/create_ticket_reply_with_comment_request","deprecated":false},{"title":"Create Ticket Request Payload","link":"/models/create_ticket_request","deprecated":false},{"title":"Create Ticket Type Attribute Request Payload","link":"/models/create_ticket_type_attribute_request","deprecated":false},{"title":"Create Ticket Type Request Payload","link":"/models/create_ticket_type_request","deprecated":false},{"title":"Cursor based pages","link":"/models/cursor_pages","deprecated":false},{"title":"Part type - custom_action_finished","link":"/models/custom_action_finished","deprecated":false},{"title":"Part type - custom_action_started","link":"/models/custom_action_started","deprecated":false},{"title":"Custom Attributes","link":"/models/custom_attributes","deprecated":false},{"title":"Custom Attributes (write)","link":"/models/custom_attributes_request","deprecated":false},{"title":"Custom Object Instance Deleted","link":"/models/custom_object_instance_deleted","deprecated":false},{"title":"Custom Object Instances","link":"/models/custom_object_instance_list","deprecated":false},{"title":"Custom Object Instance Not Found","link":"/models/custom_object_instance_not_found","deprecated":false},{"title":"customer_request","link":"/models/customer_request","deprecated":false},{"title":"CX Score reason","link":"/models/cx_score_reason","deprecated":false},{"title":"Data Attribute List","link":"/models/data_attribute_list","deprecated":false},{"title":"Data Connector Execution Result List","link":"/models/data_connector_execution_result_list","deprecated":false},{"title":"Data Connector List","link":"/models/data_connector_list","deprecated":false},{"title":"Data Connector Version List","link":"/models/data_connector_version_list","deprecated":false},{"title":"Data Event List","link":"/models/data_event_list","deprecated":false},{"title":"Data Event Summary","link":"/models/data_event_summary","deprecated":false},{"title":"Data Event Summary Item","link":"/models/data_event_summary_item","deprecated":false},{"title":"Data Export CSV","link":"/models/data_export_csv","deprecated":false},{"title":"datetime","link":"/models/datetime","deprecated":false},{"title":"Deleted Article Object","link":"/models/deleted_article_object","deprecated":false},{"title":"Deleted Collection Object","link":"/models/deleted_collection_object","deprecated":false},{"title":"Deleted Company Object","link":"/models/deleted_company_object","deprecated":false},{"title":"Deleted Contact","link":"/models/deleted_contact","deprecated":false},{"title":"Deleted Contact List","link":"/models/deleted_contact_list","deprecated":false},{"title":"Conversations","link":"/models/deleted_conversation_list","deprecated":false},{"title":"Deleted Data Connector Object","link":"/models/deleted_data_connector_object","deprecated":false},{"title":"Deleted Folder Object","link":"/models/deleted_folder_object","deprecated":false},{"title":"Deleted Help Center Redirect Object","link":"/models/deleted_help_center_redirect_object","deprecated":false},{"title":"Deleted Internal Article Object","link":"/models/deleted_internal_article_object","deprecated":false},{"title":"Deleted Note Object","link":"/models/deleted_note_object","deprecated":false},{"title":"Deleted Object","link":"/models/deleted_object","deprecated":false},{"title":"detach_contact_from_conversation_request","link":"/models/detach_contact_from_conversation_request","deprecated":false},{"title":"Create Dynamic Content Request","link":"/models/dynamic_content_create_request","deprecated":false},{"title":"Dynamic Content List","link":"/models/dynamic_content_list","deprecated":false},{"title":"Update Dynamic Content Request","link":"/models/dynamic_content_update_request","deprecated":false},{"title":"Dynamic Content Variation Request","link":"/models/dynamic_content_variation_request","deprecated":false},{"title":"Ecommerce Catalog Product","link":"/models/ecommerce_catalog_product","deprecated":false},{"title":"Ecommerce Catalog Upload Part Response","link":"/models/ecommerce_catalog_upload_part_response","deprecated":false},{"title":"Ecommerce Catalog Upload Response","link":"/models/ecommerce_catalog_upload_response","deprecated":false},{"title":"Ecommerce Catalog Variant","link":"/models/ecommerce_catalog_variant","deprecated":false},{"title":"Ecommerce Product Event Error","link":"/models/ecommerce_product_event_error","deprecated":false},{"title":"Ecommerce Product Event Product","link":"/models/ecommerce_product_event_product","deprecated":false},{"title":"Ecommerce Product Event Request","link":"/models/ecommerce_product_event_request","deprecated":false},{"title":"Ecommerce Product Event Response","link":"/models/ecommerce_product_event_response","deprecated":false},{"title":"Email Address Header","link":"/models/email_address_header","deprecated":false},{"title":"Email Message Metadata","link":"/models/email_message_metadata","deprecated":false},{"title":"Error","link":"/models/error","deprecated":false},{"title":"Event details of Workflow & actions","link":"/models/event_details","deprecated":false},{"title":"File","link":"/models/file_attribute","deprecated":false},{"title":"Granted Company List","link":"/models/granted_company_list","deprecated":false},{"title":"Group Content","link":"/models/group_content","deprecated":false},{"title":"Group Translated Content","link":"/models/group_translated_content","deprecated":false},{"title":"Handling Event","link":"/models/handling_event","deprecated":false},{"title":"Handling Event List","link":"/models/handling_event_list","deprecated":false},{"title":"Help Center Redirects","link":"/models/help_center_redirect_list","deprecated":false},{"title":"HITL Event","link":"/models/hitl_event","deprecated":false},{"title":"HITL Event List","link":"/models/hitl_event_list","deprecated":false},{"title":"intercom_version","link":"/models/intercom_version","deprecated":false},{"title":"Internal Articles","link":"/models/internal_article_list","deprecated":false},{"title":"IP Allowlist","link":"/models/ip_allowlist","deprecated":false},{"title":"Linked Object","link":"/models/linked_object","deprecated":false},{"title":"Linked Objects","link":"/models/linked_object_list","deprecated":false},{"title":"Merge contact data","link":"/models/merge_contacts_request","deprecated":false},{"title":"Merge History Item","link":"/models/merge_history_item","deprecated":false},{"title":"Merge History List","link":"/models/merge_history_list","deprecated":false},{"title":"Merge preview allowed","link":"/models/merge_preview_allowed","deprecated":false},{"title":"Merge preview attribute change","link":"/models/merge_preview_attribute_change","deprecated":false},{"title":"Merge preview attribute changes","link":"/models/merge_preview_attribute_changes","deprecated":false},{"title":"Merge preview not allowed","link":"/models/merge_preview_blocked","deprecated":false},{"title":"Merge preview reason","link":"/models/merge_preview_reason","deprecated":false},{"title":"Merge preview reassignments","link":"/models/merge_preview_reassignments","deprecated":false},{"title":"Merge preview request","link":"/models/merge_preview_request","deprecated":false},{"title":"Merge preview response","link":"/models/merge_preview_response","deprecated":false},{"title":"Merge preview summary","link":"/models/merge_preview_summary","deprecated":false},{"title":"Multiple Filter Search Request","link":"/models/multiple_filter_search_request","deprecated":false},{"title":"Create News Item Request","link":"/models/news_item_request","deprecated":false},{"title":"Paginated Response","link":"/models/note_list","deprecated":false},{"title":"Office Hours Exception List","link":"/models/office_hours_exception_list","deprecated":false},{"title":"Office Hours Schedule List","link":"/models/office_hours_schedule_list","deprecated":false},{"title":"Open Conversation Request","link":"/models/open_conversation_request","deprecated":false},{"title":"Part type - operator_workflow_event","link":"/models/operator_workflow_event","deprecated":false},{"title":"Pagination Object","link":"/models/pages_link","deprecated":false},{"title":"Paginated Response","link":"/models/paginated_response","deprecated":false},{"title":"Part attachment","link":"/models/part_attachment","deprecated":false},{"title":"Phone Switch","link":"/models/phone_switch","deprecated":false},{"title":"Predicate","link":"/models/predicate","deprecated":false},{"title":"Publish Article Draft Request Payload","link":"/models/publish_article_draft_request","deprecated":false},{"title":"Quick Reply Option","link":"/models/quick_reply_option","deprecated":false},{"title":"Rate conversation request","link":"/models/rate_conversation_request","deprecated":false},{"title":"Recipient","link":"/models/recipient","deprecated":false},{"title":"redact_conversation_request","link":"/models/redact_conversation_request","deprecated":false},{"title":"Reference","link":"/models/reference","deprecated":false},{"title":"Register Fin Voice Call Request Payload","link":"/models/register_fin_voice_call_request","deprecated":false},{"title":"Replace Granted Companies Request","link":"/models/replace_granted_companies_request","deprecated":false},{"title":"reply_conversation_request","link":"/models/reply_conversation_request","deprecated":false},{"title":"Search data","link":"/models/search_request","deprecated":false},{"title":"Segment List","link":"/models/segment_list","deprecated":false},{"title":"Side Conversation List","link":"/models/side_conversation_list","deprecated":false},{"title":"Side Conversation Summary","link":"/models/side_conversation_summary","deprecated":false},{"title":"Single Filter Search Request","link":"/models/single_filter_search_request","deprecated":false},{"title":"Applied SLA","link":"/models/sla_applied","deprecated":false},{"title":"Snooze Conversation Request","link":"/models/snooze_conversation_request","deprecated":false},{"title":"Social Profile","link":"/models/social_profile","deprecated":false},{"title":"Email Message Metadata","link":"/models/source_email_message_metadata","deprecated":false},{"title":"Part type - standalone_platform_handoff","link":"/models/standalone_platform_handoff","deprecated":false},{"title":"Pagination: Starting After","link":"/models/starting_after_paging","deprecated":false},{"title":"Subscription Types","link":"/models/subscription_type_list","deprecated":false},{"title":"Tag Company Request Payload","link":"/models/tag_company_request","deprecated":false},{"title":"Create or Update Tag Response","link":"/models/tag_create_response","deprecated":false},{"title":"Tags","link":"/models/tag_list","deprecated":false},{"title":"Tag Users Request Payload","link":"/models/tag_multiple_users_request","deprecated":false},{"title":"Tags","link":"/models/tags","deprecated":false},{"title":"Team Handling Segment","link":"/models/team_handling_segment","deprecated":false},{"title":"Team Handling Segment List","link":"/models/team_handling_segment_list","deprecated":false},{"title":"Team List","link":"/models/team_list","deprecated":false},{"title":"team_metric","link":"/models/team_metric","deprecated":false},{"title":"team_metric_list","link":"/models/team_metric_list","deprecated":false},{"title":"Team Priority Level","link":"/models/team_priority_level","deprecated":false},{"title":"Teammate Reference","link":"/models/teammate_reference","deprecated":false},{"title":"Ticket Attributes","link":"/models/ticket_custom_attributes","deprecated":false},{"title":"Ticket Deleted","link":"/models/ticket_deleted","deprecated":false},{"title":"Ticket List","link":"/models/ticket_list","deprecated":false},{"title":"Ticket part author","link":"/models/ticket_part_author","deprecated":false},{"title":"Ticket Parts","link":"/models/ticket_parts","deprecated":false},{"title":"A Ticket Part representing a note, comment, or quick_reply on a ticket","link":"/models/ticket_reply","deprecated":false},{"title":"Ticket Attributes","link":"/models/ticket_request_custom_attributes","deprecated":false},{"title":"Ticket States","link":"/models/ticket_state_list","deprecated":false},{"title":"Ticket Type Attribute","link":"/models/ticket_type_attribute","deprecated":false},{"title":"Ticket Type Attributes","link":"/models/ticket_type_attribute_list","deprecated":false},{"title":"Ticket Types","link":"/models/ticket_type_list","deprecated":false},{"title":"Translation","link":"/models/translation","deprecated":false},{"title":"Untag Company Request Payload","link":"/models/untag_company_request","deprecated":false},{"title":"Update Article Request Payload","link":"/models/update_article_request","deprecated":false},{"title":"Update Audience Request","link":"/models/update_audience_request","deprecated":false},{"title":"Update Collection Request Payload","link":"/models/update_collection_request","deprecated":false},{"title":"Update Company Request Payload","link":"/models/update_company_request","deprecated":false},{"title":"Update Contact Request Payload","link":"/models/update_contact_request","deprecated":false},{"title":"Update Content Import Source Payload","link":"/models/update_content_import_source_request","deprecated":false},{"title":"Update Conversation Attribute Option Request","link":"/models/update_conversation_attribute_option_request","deprecated":false},{"title":"Update Conversation Attribute Request","link":"/models/update_conversation_attribute_request","deprecated":false},{"title":"Update Conversation Request","link":"/models/update_conversation_request","deprecated":false},{"title":"Update Data Attribute Request","link":"/models/update_data_attribute_request","deprecated":false},{"title":"Update Data Connector Request","link":"/models/update_data_connector_request","deprecated":false},{"title":"Update Data Connector Version Request","link":"/models/update_data_connector_version_request","deprecated":false},{"title":"Update External Page Payload","link":"/models/update_external_page_request","deprecated":false},{"title":"Update Internal Article Request Payload","link":"/models/update_internal_article_request","deprecated":false},{"title":"Update News Item Request","link":"/models/update_news_item_request","deprecated":false},{"title":"Update Office Hours Exception Request","link":"/models/update_office_hours_exception_request","deprecated":false},{"title":"Update Office Hours Schedule Request","link":"/models/update_office_hours_schedule_request","deprecated":false},{"title":"Update Ticket Request Payload","link":"/models/update_ticket_request","deprecated":false},{"title":"Update Ticket Type Attribute Request Payload","link":"/models/update_ticket_type_attribute_request","deprecated":false},{"title":"Update Ticket Type Request Payload","link":"/models/update_ticket_type_request","deprecated":false},{"title":"Update Visitor Request Payload","link":"/models/update_visitor_request","deprecated":false},{"title":"Visitor","link":"/models/visitor","deprecated":false},{"title":"Visitor Deleted Object","link":"/models/visitor_deleted_object","deprecated":false},{"title":"whatsapp_message_status","link":"/models/whatsapp_message_status","deprecated":false},{"title":"whatsapp_message_status_list","link":"/models/whatsapp_message_status_list","deprecated":false},{"title":"Workflow Export","link":"/models/workflow_export","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/office_hours_time_interval":{"id":"components/schemas/office_hours_time_interval","kind":"json-schema","title":"Office Hours Time Interval","data":{"type":"object","title":"Office Hours Time Interval","x-tags":["Office Hours"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single open interval. For schedules, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are minute offsets from the start of the week (Monday 00:00 = 0), in the range 0 to 10080. For exceptions, they are minute offsets from midnight on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exception_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in the range 0 to 1440."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In requests, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be multiples of 15. The one exception is a schedule's whole-week interval, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10079"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which makes the schedule open 24/7. A request interval can contain only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any other field, including the read-only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is rejected with a 400 error."},"children":[]}]}]}],"properties":{"start_minute":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minute the interval starts. For schedules, offset from the start of the week (Monday 00:00 = 0); for exceptions, offset from midnight on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exception_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":540},"end_minute":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minute the interval ends. For schedules, offset from the start of the week (Monday 00:00 = 0); for exceptions, offset from midnight on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exception_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1020},"day_of_week":{"type":"integer","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Derived day of the week the interval falls on (0 = Monday … 6 = Sunday). For exceptions, this is derived from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exception_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is returned in responses only; a request that includes it is rejected with a 400 error."},"children":[]}]}]}],"example":0}}}},"components/schemas/office_hours_schedule":{"id":"components/schemas/office_hours_schedule","kind":"json-schema","title":"Office Hours Schedule","data":{"type":"object","title":"Office Hours Schedule","x-tags":["Office Hours"],"description":"An office hours schedule defines the recurring weekly hours during which the workspace is open.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"office_hours_schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"office_hours_schedule"},"id":{"type":"string","description":"The unique identifier for the office hours schedule.","example":"123"},"name":{"type":"string","description":"The name of the office hours schedule.","example":"Standard Support Hours"},"time_zone_name":{"type":"string","description":"The IANA time zone the schedule's hours are evaluated in.","example":"America/New_York"},"time_intervals":{"type":"array","description":"The open intervals that make up the weekly schedule.","items":{"$ref":"#/components/schemas/office_hours_time_interval"}},"twenty_four_seven":{"type":"boolean","description":"Whether the schedule is open 24/7.","example":false},"created_at":{"type":"integer","description":"The time the schedule was created as a Unix timestamp.","example":1717200000},"updated_at":{"type":"integer","description":"The time the schedule was last updated as a Unix timestamp.","example":1717200000}}}},"components/schemas/office_hours_schedule_list":{"id":"components/schemas/office_hours_schedule_list","kind":"json-schema","title":"Office Hours Schedule List","data":{"type":"object","title":"Office Hours Schedule List","description":"A list of office hours schedules.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"office_hours_schedule.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"office_hours_schedule.list"},"data":{"type":"array","description":"An array of office hours schedules.","items":{"$ref":"#/components/schemas/office_hours_schedule"}}}}},"components/schemas/create_office_hours_schedule_request":{"id":"components/schemas/create_office_hours_schedule_request","kind":"json-schema","title":"Create Office Hours Schedule Request","data":{"type":"object","title":"Create Office Hours Schedule Request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for creating an office hours schedule. Any other field, apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is rejected with a 400 error."},"children":[]}]}]}],"required":["name","time_intervals"],"properties":{"name":{"type":"string","description":"The name of the office hours schedule. It must be unique among the workspace's schedules; a duplicate name returns a 422 error.","example":"Standard Support Hours"},"time_zone_name":{"type":"string","description":"The IANA time zone the schedule's hours are evaluated in. Optional; defaults to the workspace's time zone.","example":"America/New_York"},"time_intervals":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The open intervals for the schedule. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be on a 15-minute boundary, except for the whole-week interval "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10079"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Don't send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it is read-only and a request that includes it is rejected with a 400 error."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/office_hours_time_interval"}}}}},"components/schemas/update_office_hours_schedule_request":{"id":"components/schemas/update_office_hours_schedule_request","kind":"json-schema","title":"Update Office Hours Schedule Request","data":{"type":"object","title":"Update Office Hours Schedule Request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for updating an office hours schedule. Only the provided fields are updated. Any other field, apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is rejected with a 400 error."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"The name of the office hours schedule. It must be unique among the workspace's schedules; a duplicate name returns a 422 error.","example":"Extended Support Hours"},"time_zone_name":{"type":"string","description":"The IANA time zone the schedule's hours are evaluated in.","example":"America/New_York"},"time_intervals":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The open intervals for the schedule. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be on a 15-minute boundary, except for the whole-week interval "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10079"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Don't send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it is read-only and a request that includes it is rejected with a 400 error. When provided, the intervals replace all of the schedule's existing intervals."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/office_hours_time_interval"}}}}},"components/schemas/office_hours_exception":{"id":"components/schemas/office_hours_exception","kind":"json-schema","title":"Office Hours Exception","data":{"type":"object","title":"Office Hours Exception","x-tags":["Office Hours"],"description":"An exception overrides a schedule's regular hours on a specific date, such as a public holiday.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"office_hours_exception"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"office_hours_exception"},"id":{"type":"string","description":"The unique identifier for the office hours exception.","example":"456"},"office_hours_schedule_id":{"type":"string","description":"The unique identifier for the schedule this exception belongs to.","example":"123"},"exception_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the exception applies to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-12-25"},"exception_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the workspace is closed all day; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces the regular hours with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["closed","custom_hours"],"example":"closed"},"name":{"type":"string","nullable":true,"description":"An optional name for the exception.","example":"Christmas Day"},"time_intervals":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The open intervals for the exception date. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exception_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/office_hours_time_interval"}},"recurring_annually":{"type":"boolean","description":"Whether the exception repeats every year on the same date.","example":true},"created_at":{"type":"integer","description":"The time the exception was created as a Unix timestamp.","example":1717200000},"updated_at":{"type":"integer","description":"The time the exception was last updated as a Unix timestamp.","example":1717200000}}}},"components/schemas/office_hours_exception_list":{"id":"components/schemas/office_hours_exception_list","kind":"json-schema","title":"Office Hours Exception List","data":{"type":"object","title":"Office Hours Exception List","description":"A list of office hours exceptions.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"office_hours_exception.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"office_hours_exception.list"},"data":{"type":"array","description":"An array of office hours exceptions.","items":{"$ref":"#/components/schemas/office_hours_exception"}}}}},"components/schemas/create_office_hours_exception_request":{"id":"components/schemas/create_office_hours_exception_request","kind":"json-schema","title":"Create Office Hours Exception Request","data":{"type":"object","title":"Create Office Hours Exception Request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for creating an office hours exception. Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exception_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Any other field, apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"office_hours_schedule_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is rejected with a 400 error."},"children":[]}]}]}],"required":["exception_date","exception_type"],"properties":{"exception_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the exception applies to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. A schedule can have only one exception for each date; a second one returns a 422 error."},"children":[]}]}]}],"example":"2026-12-25"},"exception_type":{"type":"string","enum":["closed","custom_hours"],"description":"The type of exception.","example":"closed"},"name":{"type":"string","description":"An optional name for the exception.","example":"Christmas Day"},"time_intervals":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The open intervals for the exception date. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; omit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which returns a 422 error if intervals are sent. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be on a 15-minute boundary. Don't send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it is read-only and a request that includes it is rejected with a 400 error."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/office_hours_time_interval"}},"recurring_annually":{"type":"boolean","description":"Whether the exception repeats every year on the same date.","example":true}}}},"components/schemas/update_office_hours_exception_request":{"id":"components/schemas/update_office_hours_exception_request","kind":"json-schema","title":"Update Office Hours Exception Request","data":{"type":"object","title":"Update Office Hours Exception Request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for updating an office hours exception. Only the provided fields are updated. Any other field, apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"office_hours_schedule_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is rejected with a 400 error."},"children":[]}]}]}],"properties":{"exception_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the exception applies to, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. A schedule can have only one exception for each date."},"children":[]}]}]}],"example":"2026-12-25"},"exception_type":{"type":"string","enum":["closed","custom_hours"],"description":"The type of exception.","example":"custom_hours"},"name":{"type":"string","description":"An optional name for the exception.","example":"Christmas Day (reduced hours)"},"time_intervals":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The open intervals for the exception date. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; omit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which returns a 422 error if intervals are sent. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_minute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be on a 15-minute boundary. Don't send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it is read-only and a request that includes it is rejected with a 400 error."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/office_hours_time_interval"}},"recurring_annually":{"type":"boolean","description":"Whether the exception repeats every year on the same date.","example":true}}}},"components/schemas/datetime":{"id":"components/schemas/datetime","kind":"json-schema","title":"datetime","data":{"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."}]}},"components/schemas/activity_log":{"id":"components/schemas/activity_log","kind":"json-schema","title":"Activity Log","data":{"title":"Activity Log","type":"object","description":"Activities performed by Admins.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_activity_log_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin_activity_log_event"},"id":{"type":"string","description":"The id representing the activity.","example":"6"},"performed_by":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the Admin involved in the activity. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the admin who performed the activity isn't available."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin"},"id":{"type":"string","description":"The id representing the admin.","example":"1295"},"email":{"type":"string","description":"The email of the admin.","example":"john@example.com"},"ip":{"type":"string","description":"The IP address of the admin.","example":"198.51.100.255"}}},"metadata":{"$ref":"#/components/schemas/activity_log_metadata"},"created_at":{"type":"integer","format":"date-time","description":"The time the activity was created.","example":1671028894},"activity_type":{"type":"string","enum":["admin_avatar_change","admin_away_mode_change","admin_occupancy_state_change","admin_channel_change","admin_deletion","admin_deprovisioned","intercom_teammate_removal","admin_impersonation_consent_approved","admin_impersonation_consent_revoked","admin_impersonation_end","admin_impersonation_start","admin_invite_change","admin_bulk_invite_creation","admin_bulk_notification_settings_change","admin_invite_creation","admin_invite_deletion","admin_unauthorized_sign_in_method","admin_login_failure","admin_login_success","admin_logout","admin_login_attempts_reset","admin_mobile_login_failure","admin_mobile_login_success","admin_sign_in_method_expired","admin_password_reset_request","admin_password_reset_success","admin_permission_change","admin_provisioned","admin_name_change","admin_email_change","admin_password_change","admin_locale_change","app_admin_join","app_authentication_method_change","app_data_deletion","app_data_export","request_log_export_requested","workspace_deletion_request","workspace_owner_designation_change","app_google_sso_domain_change","app_identity_verification_change","app_identity_verification_reminder_disabled","identity_verification_unmarked","app_name_change","app_outbound_address_change","app_package_installation","app_package_token_regeneration","app_package_uninstallation","developer_hub_secret_revealed","developer_hub_secret_copied","app_team_creation","app_team_deletion","app_team_membership_modification","app_timezone_change","app_webhook_creation","app_webhook_deletion","articles_in_messenger_enabled_change","automatic_domain_authentication_started","automatic_domain_authentication_complete","messenger_api_secret_creation","messenger_api_secret_deletion","messenger_search_required_change","messenger_spaces_change","bulk_data_export_creation","bulk_data_export_delete","bulk_data_export_run","bulk_data_export_settings_change","bulk_delete","bulk_export","call_settings_change","campaign_deletion","campaign_state_change","content_sync_pair_creation","content_sync_pair_deletion","content_sync_pair_run","content_sync_pair_update","conversation_attribute_archive","conversation_deletion","conversation_deletion_schedule_creation","conversation_deletion_schedule_state_change","conversation_deletion_schedule_update","conversation_hard_deletion_enqueued","conversation_part_deletion","conversation_part_edited","conversation_part_redaction","conversation_pdf_export","conversation_redaction_enqueued","conversation_sla_change","conversation_topic_change","conversation_topic_creation","conversation_topic_deletion","csv_import_completion","csv_import_creation","taxonomy_upload_creation","automation_roadmap_form_submission_creation","data_connector_log_retention_setting_creation","data_connector_log_retention_setting_update","email_settings_change","strip_inbound_email_links_change","help_center_settings_change","inbound_conversations_change","inbox_access_change","inbox_bulk_action","internal_agent_proposal_applied","message_deletion","ruleset_activation","ruleset_deletion","ruleset_creation","workflow_creation","workflow_deletion","workflow_update","workflow_status_change","workflow_participant_action_configured","oauth_token_revocation","article_creation","article_deletion","article_content_creation","article_content_update","article_content_deletion","article_content_published","article_content_unpublished","article_content_audience_updated","message_state_change","messenger_look_and_feel_change","office_hours_change","office_hours_exception_change","role_change","role_creation","role_deletion","seat_change","seat_revoke","pre_migration_seat_expiration_date_change","post_migration_seat_deletion","post_migration_seat_update","post_migration_seat_creation","security_settings_change","temporary_expectation_auto_expired","temporary_expectation_change","temporary_expectation_messages_change","welcome_message_change","start_conversation_button_text_change","upfront_email_collection_change","admin_assignment_limit_change","admin_channel_limit_change","admin_conversation_assignment_limit_change","admin_ticket_assignment_limit_change","admin_unassign_unsnoozed_at_capacity_change","team_assignment_limit_change","teammate_skills_synced","skill_category_created","skill_category_updated","snooze_presets_change","team_skill_categories_updated","admin_two_factor_auth_change","admin_two_factor_login_failure","email_signature_change","recovery_code_sent","billing_addressees_change","billing_addressees_bounced_and_removed","billing_details_change","broadcast_deletion","fin_opt_in","fin_free_usage_window_create","fin_free_usage_window_extension","fin_ingestion_consent","ip_allowlist_setting_change","rest_api_ip_allowlist_setting_change","messenger_platform_availability_change","messenger_platform_inactivity_disable_event","custom_report_update","custom_report_delete","custom_report_create","reporting_folder_create","reporting_folder_delete","teammate_office_hours_schedule_assign","teammate_office_hours_schedule_unassign","report_snapshot_create","report_scheduled_share_create","report_scheduled_share_update","report_scheduled_share_delete","reporting_folder_name_change","reporting_folder_position_change","reporting_folder_reports_change","reporting_folder_pin_change","reporting_csv_export","pii_data_revealed","privacy_policy_notice_change","privacy_policy_notice_contents_change","report_access_create","report_access_delete","report_access_update","fin_persisted_data_context_attribute_change","fin_sdr_connector_generated","fin_sdr_connector_activated","fin_sdr_marketo_connected","fin_sdr_marketo_partition_selected","fin_sdr_marketo_disconnected","fin_sdr_playbook_updated","generic_ecommerce_connector_creation","ai_agent_customization_settings_change","ai_agent_identity_settings_change","ai_agent_multilingual_settings_change","ai_agent_safety_guard_settings_change","messenger_language_change","ai_agent_guidance_change","ai_category_change","escalation_rule_change","hitl_rule_change","safety_response_category_config_change","hitl_inbox_action","brand_creation","brand_update","brand_deletion","brand_settings_change","action_created","action_risk_accepted_change","data_connector_security_warning_acknowledged","action_published","action_status_change","action_update","allowed_attachment_filetypes_setting_change","ai_agent_fin_playground_change","ai_agent_preview_token_generated","selection_set_creation","selection_set_archive","series_creation","series_deletion","series_settings_update","series_status_change","series_update","messenger_launch_to_conversation_change","messenger_launcher_display_condition_change","alias_mode_change","alias_name_change","hippa_compliance_settings_change","ai_inbox_translation_setting_change","slack_integration_auto_promoted","slack_oauth_fresh_install","slack_oauth_reinstall","slack_oauth_reauthentication","slack_integration_uninstalled","telegram_identity_reset","telegram_integration_installed","telegram_integration_uninstalled","slack_user_association_setting_change","ms_teams_user_association_setting_change","slack_integration_type_change","slack_multi_conversational_changed","whatsapp_direct_send_changed","slack_user_token_creation","standalone_channel_change","standalone_connection_config_change","standalone_schedule_sync_deletion","skill_category_deleted","skill_based_routing_toggled","consent_banner_settings_change","content_redaction_rule_creation","content_redaction_rule_deletion","content_redaction_rule_update","content_suggestions_change","suggestions_limiters_reset","custom_authentication_token_creation","custom_authentication_token_update","custom_authentication_token_deletion","device_token_deletion","predictive_answers_settings_change","custom_emoji_deletion","customer_facing_name_change","attach_uploads_inline_setting_change","user_camera_attachments_setting_change","user_media_attachments_setting_change","user_file_attachments_setting_change","file_upload_audience_predicates_setting_change","user_gifs_setting_change","user_emojis_setting_change","user_voice_notes_setting_change","user_conversation_attachments_setting_change","teammate_gifs_setting_change","scim_group_creation","scim_group_update","scim_groups_bulk_update","scim_group_deletion","scim_group_membership_change","scim_admin_role_change","scim_admin_bulk_role_assignment","scim_admin_profile_update","scim_admin_password_update","scim_system_enabled","scim_system_disabled","scim_settings_change","macro_content_export_run","personal_macro_admin_read","personal_macro_admin_convert","personal_macro_admin_destroy","macro_creation","macro_deletion","macro_update","macro_usage_export","mcp_server_created","mcp_server_updated","mcp_server_deleted","mcp_server_enabled","mcp_server_disabled","mcp_server_oauth_connected","mcp_server_oauth_disconnected","mcp_server_reconnected","mcp_action_added","mcp_actions_batch_added","mcp_action_updated","mcp_action_removed","fin_agent_api_settings_change","fin_procedures_hitl_settings_change","fin_procedures_hitl_access_token_rotated","fin_agent_api_secret_revealed","fin_agent_api_secret_copied","a2a_agent_registered","a2a_agent_oauth_connected","automatic_away_mode_setting_change","admin_occupancy_setting_change","unassign_unsnoozed_at_capacity_setting_change","unassign_unsnoozed_when_away_setting_change","unassign_triggers_setting_change","malicious_domains_setting_change","trusted_domains_setting_change","messenger_allowed_domains_change","qa_monitor_creation","qa_monitor_update","qa_monitor_archive","qa_monitor_restore","qa_scorecard_creation","qa_scorecard_update","qa_scorecard_archive","qa_review_plan_creation","qa_review_plan_archive","lead_to_user_merge","user_to_user_merge","sales_messenger_configuration_change","shopify_refund_order","shopify_replacement_order","shopify_gift_card_compensation","shopify_add_replacement_item","shopify_disable_discount_code","shopify_disable_gift_card","shopify_create_discount_code","shopify_update_shipping_address","channel_identity_rule_change","topic_curation_set_live","hide_csat_from_agents_setting_change","phone_purchase_diagnostic","phone_number_purchase","sip_domain_provisioned","sip_domain_deleted","sip_integration_stage_confirmed","sip_header_mappings_updated","phone_queue_call_pinned","phone_queue_call_unpinned","phone_queue_call_pin_cleared","outbound_phone_campaign_creation","outbound_phone_campaign_change","outbound_phone_campaign_deletion","outbound_phone_campaign_state_change","outbound_phone_campaign_csv_upload","outbound_phone_campaign_import","outbound_phone_campaign_session_start","channel_wrap_up_settings_change","ticket_state_customer_notifications_change","schedule_template_update","schedule_template_creation","schedule_template_deletion","schedule_template_apply","wfm_google_calendar_connected","wfm_google_calendar_disconnected","wfm_google_calendar_sync_setting_change","github_sync_disconnected","github_sync_cleanup_deleted_folder","github_sync_installed","github_sync_connector_cloned","github_sync_pulled","fallback_admin_alias_change","spam_email_deletion","snowflake_share_activated","snowflake_share_torn_down","calendar_mapping_rule_creation","calendar_mapping_rule_deletion","calendar_mapping_rule_update","activity_type_creation","masked_admin_avatar_change"],"example":"app_name_change"},"activity_description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sentence or two describing the activity. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the admin who performed the activity isn't available."},"children":[]}]}]}],"example":"Admin updated the app's name to \"My App\"."}}}},"components/schemas/activity_log_event_type_list":{"id":"components/schemas/activity_log_event_type_list","kind":"json-schema","title":"Activity Log Event Types","data":{"title":"Activity Log Event Types","type":"object","x-tags":["Admins"],"description":"A list of all activity log event types.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_log_event_type.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"activity_log_event_type.list"},"event_types":{"type":"array","description":"An array of activity log event type strings.","items":{"type":"string"},"example":["admin_login_success","admin_logout","app_name_change"]}}}},"components/schemas/activity_log_list":{"id":"components/schemas/activity_log_list","kind":"json-schema","title":"Paginated Response","data":{"title":"Paginated Response","type":"object","description":"A paginated list of activity logs.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_log.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"activity_log.list"},"pages":{"$ref":"#/components/schemas/pages_link"},"activity_logs":{"type":"array","description":"An array of activity logs","items":{"$ref":"#/components/schemas/activity_log"}}}}},"components/schemas/activity_log_metadata":{"id":"components/schemas/activity_log_metadata","kind":"json-schema","title":"Activity Log Metadata","data":{"title":"Activity Log Metadata","type":"object","description":"Additional data provided about Admin activity.","nullable":true,"properties":{"sign_in_method":{"type":"string","nullable":true,"description":"The way the admin signed in.","example":"email_password"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"f3b87a2e09d514c6c2e79b9a"},"away_mode":{"type":"boolean","nullable":true,"description":"The away mode status which is set to true when away and false when returned.","example":true},"away_status_reason":{"type":"string","nullable":true,"description":"The reason the Admin is away.","example":"😌 On a break"},"reassign_conversations":{"type":"boolean","nullable":true,"description":"Indicates if conversations should be reassigned while an Admin is away.","example":false},"source":{"type":"string","nullable":true,"description":"The action that initiated the status change.","example":"admin update from web - Admin id: 93"},"auto_changed":{"type":"string","nullable":true,"description":"Indicates if the status was changed automatically or manually.","example":false},"update_by":{"type":"integer","nullable":true,"description":"The ID of the Admin who initiated the activity.","example":93},"update_by_name":{"type":"string","nullable":true,"description":"The name of the Admin who initiated the activity.","example":"Joe Example"},"previous_state":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state before the change. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an occupancy change, and null when the Admin had not been classified yet; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an IP allowlist change."},"children":[]}]}]}],"example":"idle"},"new_state":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state after the change. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an occupancy change; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an IP allowlist change."},"children":[]}]}]}],"example":"occupied"},"threshold_minutes":{"type":"integer","nullable":true,"description":"The inactivity window, in minutes, used to classify the Admin.","example":15},"last_activity_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time of the Admin's last recorded activity.","example":1671028894},"auto":{"type":"boolean","nullable":true,"description":"Indicates the state was derived automatically rather than set by an Admin.","example":true},"setting_type":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The group of workspace settings the change belongs to, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teammate_occupancy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic_away_mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"teammate_occupancy"},"changes":{"type":"object","nullable":true,"description":"The settings altered by the change, keyed by setting name. Only settings whose value actually moved are included, so an unchanged setting is absent rather than present with equal values.","additionalProperties":{"type":"object","properties":{"before":{"description":"The value before the change."},"after":{"description":"The value after the change."}}},"example":{"occupancy_window_minutes":{"before":15,"after":30}}},"conversation_assignment_limit":{"type":"integer","nullable":true,"description":"The conversation assignment limit value for an admin.","example":15},"ticket_assignment_limit":{"type":"integer","nullable":true,"description":"The ticket assignment limit value for an admin.","example":20},"team":{"type":"object","nullable":true,"description":"Details about the team whose assignment limit was changed.","properties":{"id":{"type":"integer","description":"The ID of the team.","example":123},"name":{"type":"string","description":"The name of the team.","example":"Support Team"}}},"team_assignment_limit":{"type":"integer","nullable":true,"description":"The team assignment limit value (null if limit was removed).","example":50},"enabled":{"type":"boolean","nullable":true,"description":"Indicates if the setting is enabled or disabled.","example":true},"mode":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mode of the setting (e.g., when_away_only, when_away_and_reassign)."},"children":[]}]}]}],"example":"when_away_only"},"consent_id":{"type":"integer","nullable":true,"description":"The ID of the impersonation consent.","example":149673},"expired_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp when the impersonation consent expires.","example":"2025-12-04T09:31:57.000Z"},"before":{"type":"object","nullable":true,"description":"The state of settings or values before the change. Structure varies by activity type."},"after":{"type":"object","nullable":true,"description":"The state of settings or values after the change. Structure varies by activity type."}}}},"components/schemas/addressable_list":{"id":"components/schemas/addressable_list","kind":"json-schema","title":"Addressable List","data":{"title":"Addressable List","type":"object","nullable":false,"description":"A list used to access other resources from a parent model.","properties":{"type":{"type":"string","format":"uri","description":"The addressable object type","example":"note"},"id":{"type":"string","description":"The id of the addressable object","example":"123"},"url":{"type":"string","format":"uri","description":"Url to get more company resources for this contact","example":"/contacts/5ba682d23d7cf92bef87bfd4/notes"}}}},"components/schemas/admin":{"id":"components/schemas/admin","kind":"json-schema","title":"Admin","data":{"title":"Admin","type":"object","x-tags":["Admins"],"description":"Admins are teammate accounts that have access to a workspace.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin"},"id":{"type":"string","description":"The id representing the admin.","example":"1295"},"name":{"type":"string","description":"The name of the admin.","example":"Joe Example"},"email":{"type":"string","description":"The email of the admin.","example":"jdoe@example.com"},"job_title":{"type":"string","description":"The job title of the admin.","example":"Associate"},"away_mode_enabled":{"type":"boolean","description":"Identifies if this admin is currently set in away mode.","example":false},"away_mode_reassign":{"type":"boolean","description":"Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.","example":false},"away_status_reason_id":{"type":"integer","nullable":true,"description":"The unique identifier of the away status reason. Not returned by List all admins.","example":12345},"has_inbox_seat":{"type":"boolean","description":"Identifies if this admin has a paid inbox seat to restrict/allow features that require them.","example":true},"team_ids":{"type":"array","description":"The ids of the teams the admin belongs to. When the workspace has a default team, its id is the last item.","example":[814865],"items":{"type":"integer"}},"avatar":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The teammate's avatar image. On List all admins it is only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"display_avatar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Elsewhere it is left out when the teammate has neither an uploaded avatar nor a gravatar."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"avatar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returned by List all admins only."},"children":[]}]}]}],"example":"avatar"},"image_url":{"type":"string","format":"uri","nullable":true,"description":"The URL of the avatar image.","example":"https://picsum.photos/200/300"}}},"team_priority_level":{"$ref":"#/components/schemas/team_priority_level"},"role":{"type":"object","nullable":true,"description":"The role assigned to this admin. Only present if the admin has a role assigned.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"role"},"id":{"type":"string","description":"The id of the role.","example":"1"},"name":{"type":"string","description":"The name of the role.","example":"Support Agent"}}}}}},"components/schemas/admin_list":{"id":"components/schemas/admin_list","kind":"json-schema","title":"Admins","data":{"title":"Admins","type":"object","description":"A list of admins associated with a given workspace.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin.list"},"admins":{"type":"array","description":"A list of admins associated with a given workspace.","items":{"$ref":"#/components/schemas/admin"}}}}},"components/schemas/admin_priority_level":{"id":"components/schemas/admin_priority_level","kind":"json-schema","title":"Admin Priority Level","data":{"title":"Admin Priority Level","type":"object","nullable":true,"description":"Admin priority levels for the team","properties":{"primary_admin_ids":{"type":"array","description":"The primary admin ids for the team","nullable":true,"example":[493881],"items":{"type":"integer"}},"secondary_admin_ids":{"type":"array","description":"The secondary admin ids for the team","nullable":true,"example":[814865],"items":{"type":"integer"}}}}},"components/schemas/admin_reply_conversation_request":{"id":"components/schemas/admin_reply_conversation_request","kind":"json-schema","title":"Admin Reply","data":{"title":"Admin Reply","type":"object","description":"Payload of the request to reply on behalf of an admin","properties":{"message_type":{"type":"string","enum":["comment","note","quick_reply"],"example":"comment"},"type":{"type":"string","enum":["admin"],"example":"admin"},"body":{"type":"string","description":"The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.","example":"Hello there!"},"admin_id":{"type":"string","description":"The id of the admin who is authoring the comment.","example":"3156780"},"created_at":{"type":"integer","description":"The time the reply was created. If not provided, the current time will be used.","example":1590000000},"reply_options":{"title":"Quick Reply Options","type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quick reply options to display to the end user. Must be present for quick_reply message types."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/quick_reply_option"}},"attachment_urls":{"type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10},"attachment_files":{"type":"array","description":"A list of files that will be added as attachments. You can include up to 10 files","items":{"$ref":"#/components/schemas/conversation_attachment_files"},"maxItems":10},"skip_notifications":{"type":"boolean","description":"Option to disable notifications when replying to a conversation.","example":true},"assignee_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the admin or team to assign the conversation to with this reply."},"children":[]}]}]}],"example":"4324241"},"skip_reopen":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, a reply that assigns the conversation (a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") doesn't reopen or unsnooze it. A plain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" still reopens a closed conversation. Available from API version 2.17."},"children":[]}]}]}],"example":true}},"required":["message_type","type","admin_id"]}},"components/schemas/bot_reply_conversation_request":{"id":"components/schemas/bot_reply_conversation_request","kind":"json-schema","title":"Bot Reply","data":{"title":"Bot Reply","type":"object","description":"Payload of the request to reply on behalf of a bot","properties":{"message_type":{"type":"string","enum":["comment","note","quick_reply"],"example":"comment"},"type":{"type":"string","enum":["bot"],"example":"bot"},"bot_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the bot that is authoring the reply. A bot that doesn't exist returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":"3156780"},"body":{"type":"string","description":"The text body of the reply. Must be present for comment and note message types.","example":"Hello there!"},"created_at":{"type":"integer","description":"The time the reply was created. If not provided, the current time will be used.","example":1590000000},"reply_options":{"title":"Quick Reply Options","type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quick reply options to display to the end user. Must be present for quick_reply message types."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/quick_reply_option"}},"attachment_urls":{"type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10},"skip_notifications":{"type":"boolean","description":"Option to disable notifications when replying to a conversation. Available from API version 2.15.","example":true}},"required":["message_type","type","bot_id"]}},"components/schemas/admin_reply_ticket_request":{"id":"components/schemas/admin_reply_ticket_request","kind":"json-schema","title":"Admin Reply on ticket","data":{"title":"Admin Reply on ticket","type":"object","description":"Payload of the request to reply on behalf of an admin","properties":{"message_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of reply. Tracker tickets and back-office tickets that are not shared with the customer do not support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"enum":["comment","note","quick_reply"],"example":"comment"},"type":{"type":"string","enum":["admin"],"example":"admin"},"body":{"type":"string","description":"The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.","example":"Hello there!"},"admin_id":{"type":"string","description":"The id of the admin who is authoring the comment.","example":"3156780"},"created_at":{"type":"integer","description":"The time the reply was created. If not provided, the current time will be used.","example":1590000000},"reply_options":{"title":"Quick Reply Options","type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quick reply options to display. Must be present for quick_reply message types."},"children":[]}]}]}],"items":{"title":"Quick Reply Option","type":"object","properties":{"text":{"type":"string","description":"The text to display in this quick reply option."},"uuid":{"type":"string","format":"uuid","description":"A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option."}},"required":["text","uuid"]}},"attachment_urls":{"type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10},"attachment_files":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of files that will be added as attachments. You can include up to 10 files. If both attachment_files and attachment_urls are provided, attachment_files takes precedence."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_attachment_files"},"maxItems":10},"cross_post":{"type":"boolean","description":"If set to true, the note will be cross-posted to all linked conversations. Only applicable to note message types on back-office tickets.","example":true}},"required":["message_type","type","admin_id"]}},"components/schemas/admin_with_app":{"id":"components/schemas/admin_with_app","kind":"json-schema","title":"Admin","data":{"title":"Admin","type":"object","description":"Admins are the teammate accounts that have access to a workspace","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin"},"id":{"type":"string","description":"The id representing the admin.","example":"1295"},"name":{"type":"string","description":"The name of the admin.","example":"Joe Example"},"email":{"type":"string","description":"The email of the admin.","example":"jdoe@example.com"},"job_title":{"type":"string","description":"The job title of the admin.","example":"Associate"},"away_mode_enabled":{"type":"boolean","description":"Identifies if this admin is currently set in away mode.","example":false},"away_mode_reassign":{"type":"boolean","description":"Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.","example":false},"has_inbox_seat":{"type":"boolean","description":"Identifies if this admin has a paid inbox seat to restrict/allow features that require them.","example":true},"team_ids":{"type":"array","description":"This is a list of ids of the teams that this admin is part of.","example":[814865],"items":{"type":"integer"}},"avatar":{"type":"object","description":"This object represents the avatar associated with the admin.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a string that identifies the type of the object. It will always have the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"avatar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"avatar","example":"avatar"},"image_url":{"type":"string","format":"uri","nullable":true,"description":"This object represents the avatar associated with the admin.","example":"https://example.com/avatar.png"}}},"email_verified":{"type":"boolean","description":"Identifies if this admin's email is verified.","nullable":true,"example":true},"role":{"type":"object","nullable":true,"description":"The role assigned to this admin. Only present if the admin has a role assigned.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"role"},"id":{"type":"string","description":"The id of the role.","example":"1"},"name":{"type":"string","description":"The name of the role.","example":"Support Agent"}}},"app":{"$ref":"#/components/schemas/app","nullable":true,"description":"App that the admin belongs to."}}}},"components/schemas/ai_agent":{"id":"components/schemas/ai_agent","kind":"json-schema","title":"AI Agent","data":{"title":"AI Agent","type":"object","x-tags":["Ai Agent"],"description":"Data related to AI Agent involvement in the conversation.","properties":{"source_type":{"type":"string","nullable":true,"description":"The type of the source that triggered AI Agent involvement in the conversation.","enum":["essentials_plan_setup","profile","workflow","workflow_preview","fin_preview"],"example":"workflow"},"source_title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title of the source that triggered AI Agent involvement in the conversation. If this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"essentials_plan_setup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"My AI Workflow","nullable":true},"last_answer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the last answer delivered by AI Agent. If no answer was delivered then this will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"enum":[null,"ai_answer","custom_answer"],"example":"ai_answer","nullable":true},"resolution_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["assumed_resolution","confirmed_resolution","escalated","negative_feedback","procedure_handoff",null],"example":"assumed_resolution","nullable":true},"rating":{"type":"integer","description":"The customer satisfaction rating given to AI Agent, from 1-5.","example":4,"nullable":true},"rating_remark":{"type":"string","description":"The customer satisfaction rating remark given to AI Agent.","example":"Very helpful!","nullable":true},"created_at":{"type":"integer","format":"date-time","description":"The time when the AI agent rating was created.","example":1663597260,"nullable":true},"updated_at":{"type":"integer","format":"date-time","description":"The time when the AI agent rating was last updated.","example":1663597260,"nullable":true},"content_sources":{"$ref":"#/components/schemas/content_sources_list"}}}},"components/schemas/sales_agent":{"id":"components/schemas/sales_agent","kind":"json-schema","title":"Sales Agent","data":{"title":"Sales Agent","type":"object","x-tags":["Sales Agent"],"description":"Data related to Sales Agent involvement in the conversation.","properties":{"outcome":{"type":"string","nullable":true,"description":"The fixed outcome of the sales agent interaction, used for billing and tracking.","enum":["qualified","disqualified","product_discovery","escalated_to_support","spam"],"example":"qualified"},"routing_outcome":{"type":"string","nullable":true,"description":"The identifier of the user-defined routing outcome selected by the sales agent.","example":"enterprise_sales"},"collected_data":{"type":"object","nullable":true,"description":"A flat key-value map of memory fields collected by the sales agent during the conversation.","additionalProperties":{"type":"string"},"example":{"email":"user@example.com","company.name":"Acme Inc"}}}}},"components/schemas/ai_call_response":{"id":"components/schemas/ai_call_response","kind":"json-schema","title":"AI Call Response","data":{"title":"AI Call Response","type":"object","description":"Response containing information about a Fin Voice call","properties":{"id":{"type":"integer","description":"The unique identifier for the external reference","example":12345},"app_id":{"type":"integer","description":"The workspace identifier","example":12345},"user_phone_number":{"type":"string","description":"Phone number in E.164 format for the call","example":"+1234567890"},"status":{"type":"string","description":"Status of the call. Can be \"registered\", \"in-progress\", or a resolution state","example":"registered"},"intercom_call_id":{"type":"string","nullable":true,"description":"The Intercom call identifier, if the call has been matched","example":"1234"},"external_call_id":{"type":"string","description":"The external call identifier from the call provider","example":"call-123-abc"},"vendor_internal_id":{"type":"string","nullable":true,"description":"Vendor-supplied identifier provided at registration time, for linking the Fin Voice session to records in the vendor's own systems. Null when the vendor did not supply one.","example":"vendor-internal-abc-123"},"intercom_conversation_id":{"type":"string","nullable":true,"description":"The Intercom conversation identifier, if a conversation has been created","example":"5678"},"call_transcript":{"type":"array","description":"Array of transcript entries for the call","items":{"type":"object"},"example":[]},"call_summary":{"type":"string","description":"Summary of the call conversation, truncated to 256 characters. Empty string if no summary available.","example":"Customer called about billing issue..."},"intent":{"type":"array","description":"Array of intent classifications for the call","items":{"type":"object"},"example":[]},"fin_call_duration":{"type":"string","nullable":true,"description":"How long the most recent AI Agent (Fin) part of the call lasted, in seconds, returned as a string. Null until the call is matched and that part has ended, or when the call has no AI Agent part.","example":"45"},"data":{"type":"object","description":"The metadata object supplied when the call was registered, returned verbatim. Empty object when none was supplied.","example":{"masterContactID":"abc123","DNIS":"+18005551212"}},"language":{"type":"string","nullable":true,"description":"The language of the call's conversation, as a locale code. Null until the call is matched to a conversation or while no language has been set.","example":"fr"}}}},"components/schemas/ai_topic_subtopic":{"id":"components/schemas/ai_topic_subtopic","kind":"json-schema","title":"AI Topic and Subtopic","data":{"title":"AI Topic and Subtopic","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single AI-generated topic and subtopic classification for a conversation. Surfaced inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the \"AI Topic and Subtopic\" key as an array of these objects. Requires the AI add-on; the key is omitted when the conversation has no classification."},"children":[]}]}]}],"properties":{"topic_name":{"type":"string","description":"The name of the AI-generated topic.","example":"Billing"},"subtopic_name":{"type":"string","nullable":true,"description":"The name of the AI-generated subtopic, if any.","example":"Payment Issues"},"id":{"type":"integer","nullable":true,"description":"The id of the subtopic.","example":42}}}},"components/schemas/app":{"id":"components/schemas/app","kind":"json-schema","title":"App","data":{"title":"App","type":"object","description":"App is a workspace on Intercom","nullable":true,"properties":{"type":{"type":"string","description":"","default":"app","example":"app"},"id_code":{"type":"string","description":"The id of the app.","example":"xyz789"},"name":{"type":"string","description":"The name of the app.","example":"ACME"},"region":{"type":"string","description":"The Intercom region the app is located in.","example":"US"},"timezone":{"type":"string","description":"The timezone of the region where the app is located.","example":"America/Los_Angeles"},"created_at":{"type":"integer","description":"When the app was created.","example":1671465577},"identity_verification":{"type":"boolean","description":"Whether or not the app uses identity verification.","example":false},"secure":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not the app uses identity verification. Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false}}}},"components/schemas/audience":{"id":"components/schemas/audience","kind":"json-schema","title":"Audience","data":{"title":"Audience","type":"object","x-tags":["Audiences"],"description":"An audience represents a group of contacts that can be targeted by Fin.","properties":{"type":{"type":"string","description":"The type of object.","enum":["audience"],"example":"audience","readOnly":true},"id":{"type":"string","description":"The unique identifier representing the audience.","example":"123","readOnly":true},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the audience. Returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"VIP Customers"},"predicates":{"type":"array","description":"The predicates that define which contacts belong to the audience.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"company.name","type":"string","comparison":"contains","value":"Acme"}]},"role_predicates":{"type":"array","description":"Role-based predicates that further filter audience membership by contact role.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}]},"created_at":{"type":"integer","description":"The time the audience was created as a Unix timestamp.","example":1717200000,"readOnly":true},"updated_at":{"type":"integer","description":"The time the audience was last updated as a Unix timestamp.","example":1717200000,"readOnly":true}}}},"components/schemas/audience_list":{"id":"components/schemas/audience_list","kind":"json-schema","title":"Audience List","data":{"title":"Audience List","type":"object","description":"A paginated list of audience objects.","properties":{"type":{"type":"string","description":"The type of the object.","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of audience objects.","items":{"$ref":"#/components/schemas/audience"}},"total_count":{"type":"integer","description":"The total number of audiences.","example":2},"page":{"type":"integer","description":"The current page number.","example":1},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total_pages":{"type":"integer","description":"The total number of pages.","example":1}}}},"components/schemas/predicate":{"id":"components/schemas/predicate","kind":"json-schema","title":"Predicate","data":{"title":"Predicate","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A condition used to filter contacts in an audience. An attribute predicate compares one attribute. A logical predicate has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and groups other predicates instead."},"children":[]}]}]}],"properties":{"attribute":{"type":"string","description":"The attribute to filter on. Required on an attribute predicate.","example":"company.name"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the attribute, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a logical predicate."},"children":[]}]}]}],"example":"string"},"comparison":{"type":"string","description":"The comparison operator. Required on an attribute predicate.","example":"contains"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value to compare against. The accepted value depends on the attribute and the comparison, and can be a string, a number, a boolean, an array or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Acme"},"predicates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The predicates grouped by a logical predicate. Only used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/predicate"}}}}},"components/schemas/article":{"id":"components/schemas/article","kind":"json-schema","title":"Article","data":{"title":"Article","type":"object","x-tags":["Articles"],"description":"The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.","properties":{"statistics":{"nullable":true,"$ref":"#/components/schemas/article_statistics"}},"allOf":[{"$ref":"#/components/schemas/article_list_item"}]}},"components/schemas/internal_article":{"id":"components/schemas/internal_article","kind":"json-schema","title":"Internal Article","data":{"title":"Internal Article","type":"object","x-tags":["Articles"],"description":"The Internal Articles API is a central place to gather all information and take actions on your internal articles.","allOf":[{"$ref":"#/components/schemas/internal_article_list_item"}]}},"components/schemas/article_content":{"id":"components/schemas/article_content","kind":"json-schema","title":"Article Content","data":{"title":"Article Content","type":"object","description":"The Content of an Article.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ."},"children":[]}]}]}],"enum":[null,"article_content"],"example":"article_content","nullable":true},"content_id":{"type":"string","readOnly":true,"description":"The unique identifier for the article's content in this locale.","example":"6871120"},"title":{"type":"string","description":"The title of the article.","example":"How to create a new article"},"description":{"type":"string","description":"The description of the article.","example":"This article will show you how to create a new article."},"body":{"type":"string","description":"The body of the article in HTML.","example":"This is the body of the article."},"body_markdown":{"type":"string","nullable":true,"description":"The body of the article in markdown.","example":"# How to create a new article\n\nThis is the body of the article.\n"},"author_id":{"type":"integer","description":"The ID of the author of the article.","example":"5017691"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the article is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ."},"children":[]}]}]}],"enum":["published","draft"],"example":"draft"},"created_at":{"type":"integer","format":"date-time","description":"The time when the article was created (seconds).","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The time when the article was last updated (seconds).","example":1663597260},"has_unpublished_changes":{"type":"boolean","description":"Whether this locale's published content has unpublished changes staged as a draft on top of its live content.","example":false},"draft_updated_at":{"type":"integer","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time, in seconds, when this locale's staged draft was last edited, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when there is no staged draft."},"children":[]}]}]}],"example":1663597260},"url":{"type":"string","description":"The URL of the article."},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs this article content is targeted to for Fin AI Agent. On multilingual help centers this field appears per-locale inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On single-language help centers it appears at the article root level. Empty array means no audience targeting is set."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the article is available for AI Chatbot.","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the article is available for AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the article is available for AI Sales Agent.","example":true},"created_by_id":{"type":"integer","nullable":true,"readOnly":true,"description":"The ID of the teammate who created this content version.","example":5017691},"updated_by_id":{"type":"integer","nullable":true,"readOnly":true,"description":"The ID of the teammate who last updated this content version.","example":5017691}}}},"components/schemas/internal_article_list":{"id":"components/schemas/internal_article_list","kind":"json-schema","title":"Internal Articles","data":{"title":"Internal Articles","type":"object","description":"This will return a list of internal articles for the App.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of internal articles.","example":1},"data":{"type":"array","description":"An array of Internal Article objects","items":{"$ref":"#/components/schemas/internal_article_list_item"}}}}},"components/schemas/folder":{"id":"components/schemas/folder","kind":"json-schema","title":"Folder","data":{"title":"Folder","type":"object","x-tags":["Folders"],"description":"A folder for organizing content","properties":{"id":{"type":"integer","description":"The unique identifier for the folder","example":6},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the folder. Returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Product Documentation"},"description":{"type":"string","nullable":true,"description":"The description of the folder","example":"Internal product documentation"},"emoji":{"type":"string","nullable":true,"description":"An emoji associated with the folder","example":"📚"},"parent_folder_id":{"type":"integer","nullable":true,"description":"The ID of the parent folder, or null if this is a root folder","example":null},"content_count":{"type":"integer","description":"The number of content items in this folder","example":5},"created_at":{"type":"integer","format":"date-time","description":"The time when the folder was created (seconds)","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the folder was last updated (seconds)","example":1672928610}}}},"components/schemas/deleted_folder_object":{"id":"components/schemas/deleted_folder_object","kind":"json-schema","title":"Deleted Folder Object","data":{"title":"Deleted Folder Object","type":"object","description":"Response returned when a folder is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the deleted folder","example":"6"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["folder"],"example":"folder"},"deleted":{"type":"boolean","description":"Whether the folder was successfully deleted.","example":true}}}},"components/schemas/article_list":{"id":"components/schemas/article_list","kind":"json-schema","title":"Articles","data":{"title":"Articles","type":"object","description":"This will return a list of articles for the App.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of articles.","example":1},"data":{"type":"array","description":"An array of Article objects","items":{"$ref":"#/components/schemas/article_list_item"}}}}},"components/schemas/article_list_item":{"id":"components/schemas/article_list_item","kind":"json-schema","title":"Articles","data":{"title":"Articles","type":"object","x-tags":["Articles"],"description":"The data returned about your articles when you list them.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["article"],"default":"article","example":"article"},"id":{"type":"string","description":"The unique identifier for the article which is given by Intercom.","example":"6871119"},"workspace_id":{"type":"string","description":"The id of the workspace which the article belongs to.","example":"hfi1bx4l"},"content_id":{"type":"string","description":"The unique identifier for the article's content. For multilingual articles, this will be the identifier of the default language's content.","example":"6871120"},"title":{"type":"string","description":"The title of the article. For multilingual articles, this will be the title of the default language's content.","example":"Default language title"},"description":{"type":"string","nullable":true,"description":"The description of the article. For multilingual articles, this will be the description of the default language's content.","example":"Default language description"},"body":{"type":"string","nullable":true,"description":"The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.","example":"Default language body in html"},"body_markdown":{"type":"string","nullable":true,"description":"The body of the article in markdown. For multilingual articles, this will be the body of the default language's content.","example":"# Default language title\n\nDefault language body in markdown\n"},"author_id":{"type":"integer","description":"The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.","example":"5017691"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the article is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For multilingual articles, this will be the state of the default language's content."},"children":[]}]}]}],"enum":["published","draft"],"default":"draft","example":"published"},"created_at":{"type":"integer","format":"date-time","description":"The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.","example":1672928610},"has_unpublished_changes":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the published article has unpublished changes staged as a draft on top of its live content. For multilingual articles this reflects the default language's content; a pure draft (never published) reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"draft_updated_at":{"type":"integer","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time, in seconds, when the staged draft was last edited, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when there is no staged draft."},"children":[]}]}]}],"example":1672928610},"url":{"type":"string","nullable":true,"description":"The URL of the article. For multilingual articles, this will be the URL of the default language's content.","example":"http://intercom.test/help/en/articles/3-default-language"},"parent_ids":{"type":"array","description":"The ids of the article's parent collections or sections. An article without this field stands alone.","items":{"type":"integer"},"example":[18,19]},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs this article is targeted to for Fin AI Agent. This field is only returned for single-language help centers. For multilingual help centers it appears per locale inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Empty array means no audience targeting is set."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the article is available for AI Chatbot. For multilingual articles, this will be the value of the default language's content.","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the article is available for AI Copilot. For multilingual articles, this will be the value of the default language's content.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the article is available for AI Sales Agent. For multilingual articles, this will be the value of the default language's content.","example":true},"created_by_id":{"type":"integer","nullable":true,"readOnly":true,"description":"The ID of the teammate who created the article. For multilingual articles, this will be the creator of the default language's content.","example":5017691},"updated_by_id":{"type":"integer","nullable":true,"readOnly":true,"description":"The ID of the teammate who last updated the article. For multilingual articles, this will be the last editor of the default language's content.","example":5017691},"exclude_from_article_suggestions":{"type":"boolean","readOnly":true,"description":"Whether the article is excluded from Fin AI Agent article suggestions.","example":false},"help_center_audience":{"type":"string","nullable":true,"readOnly":true,"enum":["everyone","all_users","all_visitors","all_leads","all_visitors_and_leads","restricted"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The audience that can view this article in the Help Center. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"everyone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means all users and visitors can view it; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restricted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates a custom audience ruleset. For multilingual articles, this is the article-level audience."},"children":[]}]}]}],"example":"everyone"},"scheduled_publish_at":{"type":"integer","format":"date-time","nullable":true,"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Unix timestamp (in seconds) at which the article is scheduled to be published. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no publish is scheduled. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_unpublish_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — at most one pending schedule exists per article."},"children":[]}]}]}],"example":1769443200},"scheduled_unpublish_at":{"type":"integer","format":"date-time","nullable":true,"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Unix timestamp (in seconds) at which the article is scheduled to be unpublished. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no unpublish is scheduled. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_publish_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — at most one pending schedule exists per article."},"children":[]}]}]}],"example":1769443200},"default_locale":{"type":"string","description":"The default locale of the help center. This field is only returned for multilingual help centers.","example":"en"},"translated_content":{"nullable":true,"$ref":"#/components/schemas/article_translated_content"},"tags":{"$ref":"#/components/schemas/tags"},"folder_id":{"type":"integer","nullable":true,"description":"The ID of the folder this article belongs to, or null if not in a folder.","example":6}}}},"components/schemas/internal_article_list_item":{"id":"components/schemas/internal_article_list_item","kind":"json-schema","title":"Internal Articles","data":{"title":"Internal Articles","type":"object","x-tags":["Internal Articles"],"description":"The data returned about your internal articles when you list them.","properties":{"id":{"type":"integer","description":"The unique identifier for the article which is given by Intercom.","example":6871119},"title":{"type":"string","description":"The title of the article."},"body":{"type":"string","nullable":true,"description":"The body of the article in HTML.","example":"Default language body in html"},"body_markdown":{"type":"string","nullable":true,"description":"The body of the article in markdown.","example":"# Internal Guide\n\nBody of the article in markdown\n"},"owner_id":{"type":"integer","description":"The id of the owner of the article.","example":5017691},"author_id":{"type":"integer","description":"The id of the author of the article.","example":5017691},"created_at":{"type":"integer","format":"date-time","description":"The time when the article was created.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the article was last updated.","example":1672928610},"locale":{"type":"string","description":"The default locale of the article."},"folder_id":{"type":"integer","nullable":true,"description":"The ID of the folder this article belongs to, or null if not in a folder.","example":6},"audience_ids":{"type":"array","nullable":true,"description":"The list of audience IDs this internal article is targeted to for Fin AI Agent. Empty array means no audience targeting is set.","items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the internal article is available for AI Chatbot (Fin).","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the internal article is available for AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the internal article is available for AI Sales Agent.","example":true},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/article_search_highlights":{"id":"components/schemas/article_search_highlights","kind":"json-schema","title":"Article Search Highlights","data":{"title":"Article Search Highlights","type":"object","x-tags":["Articles"],"description":"The highlighted results of an Article search. In the examples provided my search query is always \"my query\".","properties":{"article_id":{"type":"string","description":"The ID of the corresponding article.","example":"123"},"highlighted_title":{"type":"array","description":"An Article title highlighted.","items":{"type":"object","description":"A highlighted article title.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of text - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"highlight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["highlight","plain"],"example":"The highlight is "},"text":{"type":"string","description":"The text of the title.","example":"my query"}}}},"highlighted_summary":{"type":"array","description":"An Article description and body text highlighted.","items":{"type":"array","description":"An array containing the highlighted summary text split into chunks of plain and highlighted text.","items":{"type":"object","description":"An instance of highlighted summary text.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of text - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"highlight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["highlight","plain"],"example":"How to highlight "},"text":{"type":"string","description":"The text of the title.","example":"my query"}}}}}}}},"components/schemas/article_search_response":{"id":"components/schemas/article_search_response","kind":"json-schema","title":"Article Search Response","data":{"title":"Article Search Response","type":"object","x-tags":["Articles"],"description":"The results of an Article search","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"total_count":{"type":"integer","description":"The total number of Articles matching the search query","example":5},"data":{"type":"object","description":"An object containing the results of the search. When no articles match, this is an empty array instead.","properties":{"articles":{"type":"array","description":"An array of Article objects","items":{"$ref":"#/components/schemas/article"}},"highlights":{"type":"array","description":"A corresponding array of highlighted Article content","items":{"$ref":"#/components/schemas/article_search_highlights"}}}},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"components/schemas/internal_article_search_response":{"id":"components/schemas/internal_article_search_response","kind":"json-schema","title":"Internal Article Search Response","data":{"title":"Internal Article Search Response","type":"object","x-tags":["Internal Articles"],"description":"The results of an Internal Article search","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"total_count":{"type":"integer","description":"The total number of Internal Articles matching the search query","example":5},"internal_articles":{"type":"array","description":"An array of Internal Article objects","items":{"$ref":"#/components/schemas/internal_article"}},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"components/schemas/article_statistics":{"id":"components/schemas/article_statistics","kind":"json-schema","title":"Article Statistics","data":{"title":"Article Statistics","type":"object","description":"The statistics of an article.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_statistics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["article_statistics"],"default":"article_statistics","example":"article_statistics"},"views":{"type":"integer","description":"The number of total views the article has received.","example":10},"conversations":{"type":"integer","description":"The number of conversations started from the article.","example":0},"reactions":{"type":"integer","description":"The number of total reactions the article has received.","example":10},"happy_reaction_percentage":{"type":"number","format":"float","description":"The percentage of happy reactions the article has received against other types of reaction.","example":40},"neutral_reaction_percentage":{"type":"number","format":"float","description":"The percentage of neutral reactions the article has received against other types of reaction.","example":40},"sad_reaction_percentage":{"type":"number","format":"float","description":"The percentage of sad reactions the article has received against"},"fin_involvements":{"type":"integer","readOnly":true,"description":"The number of conversations in which Fin AI Agent used this article, summed across all of the article's locales.","example":10},"fin_resolutions":{"type":"integer","readOnly":true,"description":"The number of conversations Fin AI Agent resolved using this article, summed across all of the article's locales.","example":8},"fin_resolution_rate":{"type":"number","format":"float","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of Fin AI Agent involvements that resulted in a resolution (fin_resolutions / fin_involvements * 100)."},"children":[]}]}]}],"example":80}}}},"components/schemas/article_translated_content":{"id":"components/schemas/article_translated_content","kind":"json-schema","title":"Article Translated Content","data":{"title":"Article Translated Content","type":"object","description":"The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - article_translated_content."},"children":[]}]}]}],"enum":[null,"article_translated_content"],"example":"article_translated_content","nullable":true},"ar":{"description":"The content of the article in Arabic","$ref":"#/components/schemas/article_content"},"bg":{"description":"The content of the article in Bulgarian","$ref":"#/components/schemas/article_content"},"bs":{"description":"The content of the article in Bosnian","$ref":"#/components/schemas/article_content"},"ca":{"description":"The content of the article in Catalan","$ref":"#/components/schemas/article_content"},"cs":{"description":"The content of the article in Czech","$ref":"#/components/schemas/article_content"},"da":{"description":"The content of the article in Danish","$ref":"#/components/schemas/article_content"},"de":{"description":"The content of the article in German","$ref":"#/components/schemas/article_content"},"el":{"description":"The content of the article in Greek","$ref":"#/components/schemas/article_content"},"en":{"description":"The content of the article in English","$ref":"#/components/schemas/article_content"},"es":{"description":"The content of the article in Spanish","$ref":"#/components/schemas/article_content"},"et":{"description":"The content of the article in Estonian","$ref":"#/components/schemas/article_content"},"fi":{"description":"The content of the article in Finnish","$ref":"#/components/schemas/article_content"},"fr":{"description":"The content of the article in French","$ref":"#/components/schemas/article_content"},"he":{"description":"The content of the article in Hebrew","$ref":"#/components/schemas/article_content"},"hr":{"description":"The content of the article in Croatian","$ref":"#/components/schemas/article_content"},"hu":{"description":"The content of the article in Hungarian","$ref":"#/components/schemas/article_content"},"id":{"description":"The content of the article in Indonesian","$ref":"#/components/schemas/article_content"},"it":{"description":"The content of the article in Italian","$ref":"#/components/schemas/article_content"},"ja":{"description":"The content of the article in Japanese","$ref":"#/components/schemas/article_content"},"ko":{"description":"The content of the article in Korean","$ref":"#/components/schemas/article_content"},"lt":{"description":"The content of the article in Lithuanian","$ref":"#/components/schemas/article_content"},"lv":{"description":"The content of the article in Latvian","$ref":"#/components/schemas/article_content"},"mn":{"description":"The content of the article in Mongolian","$ref":"#/components/schemas/article_content"},"nb":{"description":"The content of the article in Norwegian","$ref":"#/components/schemas/article_content"},"nl":{"description":"The content of the article in Dutch","$ref":"#/components/schemas/article_content"},"pl":{"description":"The content of the article in Polish","$ref":"#/components/schemas/article_content"},"pt":{"description":"The content of the article in Portuguese (Portugal)","$ref":"#/components/schemas/article_content"},"ro":{"description":"The content of the article in Romanian","$ref":"#/components/schemas/article_content"},"ru":{"description":"The content of the article in Russian","$ref":"#/components/schemas/article_content"},"sl":{"description":"The content of the article in Slovenian","$ref":"#/components/schemas/article_content"},"sr":{"description":"The content of the article in Serbian","$ref":"#/components/schemas/article_content"},"sv":{"description":"The content of the article in Swedish","$ref":"#/components/schemas/article_content"},"tr":{"description":"The content of the article in Turkish","$ref":"#/components/schemas/article_content"},"vi":{"description":"The content of the article in Vietnamese","$ref":"#/components/schemas/article_content"},"pt-BR":{"description":"The content of the article in Portuguese (Brazil)","$ref":"#/components/schemas/article_content"},"zh-CN":{"description":"The content of the article in Chinese (China)","$ref":"#/components/schemas/article_content"},"zh-TW":{"description":"The content of the article in Chinese (Taiwan)","$ref":"#/components/schemas/article_content"}}}},"components/schemas/article_version":{"id":"components/schemas/article_version","kind":"json-schema","title":"Article Version","data":{"title":"Article Version","type":"object","x-tags":["Articles"],"description":"A historical version of an article, including its content.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["article_version"],"example":"article_version"},"id":{"type":"string","description":"The unique identifier for the version.","example":"301"},"article_id":{"type":"string","description":"The unique identifier of the article this version belongs to.","example":"123"},"title":{"type":"string","description":"The title of the article at this version.","example":"This is the article title"},"description":{"type":"string","nullable":true,"description":"The description of the article at this version.","example":""},"body":{"type":"string","nullable":true,"description":"The HTML body of the article at this version.","example":"<p class=\"no-margin\">Body of this version</p>"},"body_markdown":{"type":"string","nullable":true,"description":"The Markdown body of the article at this version.","example":"Body of this version\n"},"author_id":{"type":"string","description":"The id of the teammate listed as the article's author at this version.","example":"991267502"},"created_by_id":{"type":"string","nullable":true,"description":"The id of the teammate who created this version.","example":"5017691"},"created_via":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How this version was created (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"web"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"web"},"from_version_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the version this version was created from, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the first version."},"children":[]}]}]}],"example":"300"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the version that is currently live; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for every other version, including earlier versions that are no longer live and staged changes that have not been published."},"children":[]}]}]}],"enum":["published","draft"],"example":"published"},"created_at":{"type":"integer","format":"date-time","description":"The time the version was created, as a UTC Unix timestamp.","example":1734537292},"updated_at":{"type":"integer","format":"date-time","description":"The time the version was last updated, as a UTC Unix timestamp.","example":1734537292}}}},"components/schemas/article_version_list":{"id":"components/schemas/article_version_list","kind":"json-schema","title":"Article Versions","data":{"title":"Article Versions","type":"object","description":"A paginated list of versions of an article.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of versions.","example":2},"data":{"type":"array","description":"An array of Article version summary objects.","items":{"$ref":"#/components/schemas/article_version_summary"}}}}},"components/schemas/article_version_summary":{"id":"components/schemas/article_version_summary","kind":"json-schema","title":"Article Version Summary","data":{"title":"Article Version Summary","type":"object","x-tags":["Articles"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A metadata summary of an article version, as returned by the version-history list endpoint. Omits the version's body content - fetch a single version to retrieve its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["article_version"],"example":"article_version"},"id":{"type":"string","description":"The unique identifier for the version.","example":"301"},"article_id":{"type":"string","description":"The unique identifier of the article this version belongs to.","example":"123"},"title":{"type":"string","description":"The title of the article at this version.","example":"This is the article title"},"description":{"type":"string","nullable":true,"description":"The description of the article at this version.","example":""},"author_id":{"type":"string","description":"The id of the teammate listed as the article's author at this version.","example":"991267502"},"created_by_id":{"type":"string","nullable":true,"description":"The id of the teammate who created this version.","example":"5017691"},"created_via":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How this version was created (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"web"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"web"},"from_version_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the version this version was created from, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the first version."},"children":[]}]}]}],"example":"300"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the version that is currently live; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for every other version, including earlier versions that are no longer live and staged changes that have not been published."},"children":[]}]}]}],"enum":["published","draft"],"example":"published"},"created_at":{"type":"integer","format":"date-time","description":"The time the version was created, as a UTC Unix timestamp.","example":1734537292}}}},"components/schemas/assign_conversation_request":{"id":"components/schemas/assign_conversation_request","kind":"json-schema","title":"Assign Conversation Request","data":{"title":"Assign Conversation Request","type":"object","description":"Payload of the request to assign a conversation","properties":{"message_type":{"type":"string","enum":["assignment"],"example":"assignment"},"type":{"type":"string","enum":["admin","team"],"example":"admin"},"admin_id":{"type":"string","description":"The id of the admin who is performing the action.","example":"12345"},"assignee_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which will be assigned the conversation. A conversation can be assigned both an admin and a team.\\nSet "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want this assign to no admin or team (ie. Unassigned)."},"children":[]}]}]}],"example":"4324241"},"body":{"type":"string","description":"Optionally you can send a response in the conversation when it is assigned.","example":"Let me pass you over to one of my colleagues."},"skip_reopen":{"type":"boolean","default":false,"description":"When true, assigning a closed conversation leaves it closed instead of reopening it. No reopen event is recorded, so the conversation keeps its original close timestamp and the assignment does not count as a new closure in reporting.","example":true},"skip_notifications":{"type":"boolean","description":"Option to disable notifications when assigning a conversation. Available from API version 2.15.","example":true}},"required":["message_type","type","admin_id","assignee_id"]}},"components/schemas/attach_contact_to_conversation_request":{"id":"components/schemas/attach_contact_to_conversation_request","kind":"json-schema","title":"Attach Contact To Conversation Request","data":{"title":"Attach Contact To Conversation Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to add a contact to a conversation. Say who is adding the contact in one of two ways: send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to act as an admin, or send one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to act as a contact. Sending both, or neither, returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify the contact to add."},"children":[]}]}]}],"properties":{"admin_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the admin who is adding the new participant. Send this to act as an admin."},"children":[]}]}]}],"example":"12345"},"intercom_user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier, as given by Intercom, of the contact who is adding the new participant. Send this, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to act as a contact."},"children":[]}]}]}],"example":"6329bd9ffe4e2e91dac76188"},"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you have defined for the contact who is adding the new participant."},"children":[]}]}]}],"example":"2e91dac761886329bd9ffe4e"},"email":{"type":"string","description":"The email of the contact who is adding the new participant.","example":"winstonsmith@truth.org"},"customer":{"$ref":"#/components/schemas/customer_request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact to add as a participant. Identify them with exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["customer"]}},"components/schemas/conversation_participants_response":{"id":"components/schemas/conversation_participants_response","kind":"json-schema","title":"Conversation Participants Response","data":{"title":"Conversation Participants Response","type":"object","description":"The participants of the conversation, returned after attaching or detaching a contact","properties":{"customers":{"type":"array","description":"The conversation participants after the change","items":{"type":"object","properties":{"type":{"type":"string","description":"The role of the participant. Can be \"user\" or \"lead\"","example":"user"},"id":{"type":"string","description":"The unique identifier for the participant","example":"6762f1a61bb69f9f2193bbd8"}},"required":["type","id"]},"example":[{"type":"user","id":"6762f1a61bb69f9f2193bbd8"}]}},"required":["customers"]}},"components/schemas/brand":{"id":"components/schemas/brand","kind":"json-schema","title":"Brand","data":{"type":"object","title":"Brand","description":"Represents a branding configuration for the workspace","x-tags":["Brands"],"properties":{"type":{"type":"string","description":"The type of object","example":"brand"},"id":{"type":"string","description":"Unique brand identifier. For default brand, matches the workspace ID","example":"10"},"name":{"type":"string","description":"Display name of the brand","example":"Default Brand"},"is_default":{"type":"boolean","description":"Whether this is the workspace's default brand","example":true},"created_at":{"type":"integer","format":"date-time","description":"Unix timestamp of brand creation","example":1673778600},"updated_at":{"type":"integer","format":"date-time","description":"Unix timestamp of last modification","example":1711031100},"help_center_id":{"type":"string","description":"Associated help center identifier","example":"10"},"default_address_settings_id":{"type":"string","description":"Default email settings ID for this brand","example":"15"}}}},"components/schemas/brand_list":{"id":"components/schemas/brand_list","kind":"json-schema","title":"Brand List","data":{"type":"object","title":"Brand List","description":"A list of brands","x-tags":["Brands"],"properties":{"type":{"type":"string","description":"The type of object","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/brand"}}}}},"components/schemas/team_metric":{"id":"components/schemas/team_metric","kind":"json-schema","title":"team_metric","data":{"type":"object","description":"Per-admin activity metrics within a team.","properties":{"type":{"type":"string","example":"team_metric"},"admin_id":{"type":"string","description":"The unique identifier for the admin.","example":"123"},"open":{"type":"integer","description":"The number of open conversations assigned to the admin.","example":5},"idle":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of idle conversations assigned to the admin. A conversation is idle when it has been open and waiting for an admin reply longer than the idle_threshold."},"children":[]}]}]}],"example":2},"snoozed":{"type":"integer","description":"The number of snoozed conversations assigned to the admin.","example":1}}}},"components/schemas/team_metric_list":{"id":"components/schemas/team_metric_list","kind":"json-schema","title":"team_metric_list","data":{"type":"object","description":"A list of team metrics.","properties":{"type":{"type":"string","example":"team_metric.list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/team_metric"}}}}},"components/schemas/auth_token":{"id":"components/schemas/auth_token","kind":"json-schema","title":"Auth Token","data":{"title":"Auth Token","type":"object","x-tags":["Auth Tokens"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata for a stored third-party credential that data connectors use to authenticate outbound requests. Only metadata is returned — the credential value itself, and its refresh and OAuth configuration, are never exposed."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["auth_token"],"example":"auth_token"},"id":{"type":"string","description":"The unique identifier for the auth token.","example":"12345"},"name":{"type":"string","description":"The name given to the credential when it was created.","example":"Fulfilment API key","nullable":true},"description":{"type":"string","description":"An optional description of what the credential is used for.","example":"Used by the order status connector","nullable":true},"token_type":{"type":"string","description":"How the credential is presented to the external API, for example as a header value or an HMAC signature.","example":"text","nullable":true},"request_header_key":{"type":"string","description":"The request header the credential is sent in.","example":"Authorization","nullable":true},"token_prefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The prefix placed before the credential value in the header, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Bearer","nullable":true},"domain":{"type":"string","description":"The domain the credential is scoped to, if one was set.","example":"api.fulfilment.example.com","nullable":true},"created_at":{"type":"integer","description":"The time the credential was created as a Unix timestamp.","example":1763199000,"nullable":true},"updated_at":{"type":"integer","description":"The time the credential was last updated as a Unix timestamp.","example":1768918935,"nullable":true}}}},"components/schemas/create_auth_token_request":{"id":"components/schemas/create_auth_token_request","kind":"json-schema","title":"Create Auth Token Request","data":{"title":"Create Auth Token Request","type":"object","x-tags":["Auth Tokens"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields accepted when storing a new third-party credential. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default) to store a plain credential value, or to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to have Intercom obtain and manage an access token via the OAuth client-credentials grant."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"A name for the credential, so a teammate can identify it later.","example":"Fulfilment API key"},"token_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of credential to store. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["text","oauth"],"example":"text"},"token_value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credential value. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Stored encrypted and never returned by any endpoint."},"children":[]}]}]}],"example":"example-token-value"},"request_header_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request header the credential is sent in. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where it is fixed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Authorization"},"token_prefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional prefix placed before the credential value in the header, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where it is fixed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Bearer"},"description":{"type":"string","description":"An optional description of what the credential is used for.","example":"Used by the order status connector"},"oauth_configuration":{"$ref":"#/components/schemas/oauth_configuration"}},"required":["name"]}},"components/schemas/oauth_configuration":{"id":"components/schemas/oauth_configuration","kind":"json-schema","title":"OAuth Configuration","data":{"title":"OAuth Configuration","type":"object","x-tags":["Auth Tokens"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAuth client-credentials configuration Intercom uses to obtain and refresh an access token. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"token_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token endpoint Intercom exchanges the client credentials with. Must be an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL."},"children":[]}]}]}],"example":"https://auth.fulfilment.example.com/oauth/token"},"client_id":{"type":"string","description":"The OAuth client ID.","example":"fulfilment-connector"},"client_secret":{"type":"string","description":"The OAuth client secret. Stored encrypted and never returned by any endpoint.","example":"8f6e2b1a9c4d7e05"},"scope":{"type":"string","description":"An optional scope to request from the token endpoint.","example":"orders.read"},"audience":{"type":"string","description":"An optional audience to request from the token endpoint.","example":"https://api.fulfilment.example.com"},"request_format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format the client credentials are sent in when requesting a token. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["json","form_encoded"],"example":"json"}},"required":["token_url","client_id","client_secret"]}},"components/schemas/update_auth_token_request":{"id":"components/schemas/update_auth_token_request","kind":"json-schema","title":"Update Auth Token Request","data":{"title":"Update Auth Token Request","type":"object","x-tags":["Auth Tokens"],"description":"The fields accepted when updating a stored third-party credential. Every field is optional, and one you omit keeps its current value. The credential value cannot be changed here.\n","properties":{"name":{"type":"string","description":"A name for the credential, so a teammate can identify it later.","example":"Fulfilment API key"},"request_header_key":{"type":"string","description":"The request header the credential is sent in.","example":"Authorization"},"token_prefix":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional prefix placed before the credential value in the header, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Bearer"},"description":{"type":"string","description":"An optional description of what the credential is used for.","example":"Used by the order status connector"}}}},"components/schemas/auth_token_list":{"id":"components/schemas/auth_token_list","kind":"json-schema","title":"Auth Token List","data":{"title":"Auth Token List","type":"object","description":"A paginated list of auth tokens.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of auth token objects.","items":{"$ref":"#/components/schemas/auth_token"}},"pages":{"type":"object","description":"Pagination information.","properties":{"type":{"type":"string","example":"pages","enum":["pages"]},"per_page":{"type":"integer","description":"The number of results per page.","example":20},"next":{"type":"object","nullable":true,"description":"Cursor for the next page of results.","properties":{"starting_after":{"type":"string","description":"The cursor value to use for the next page.","example":"WzE3MDc1OTQ3MTUuMCwxMjM0NV0="}}}}}}}},"components/schemas/away_status_reason":{"id":"components/schemas/away_status_reason","kind":"json-schema","title":"away_status_reason","data":{"type":"object","properties":{"type":{"type":"string","example":"away_status_reason"},"id":{"type":"string","description":"The unique identifier for the away status reason"},"label":{"type":"string","description":"The display text for the away status reason","example":"On a break"},"emoji":{"type":"string","description":"The emoji associated with the status reason","example":"☕"},"order":{"type":"integer","description":"The display order of the status reason","example":1},"deleted":{"type":"boolean","description":"Whether the status reason has been soft deleted","example":false},"associated_to_phone_status":{"type":"string","nullable":true,"description":"The phone status this away status reason is configured for, or null if it is not associated with one.","enum":["wrap_up","on_a_call","coaching",null],"example":"wrap_up"}}}},"components/schemas/away_status_reason_list":{"id":"components/schemas/away_status_reason_list","kind":"json-schema","title":"Away Status Reasons","data":{"title":"Away Status Reasons","type":"object","description":"A list of away status reasons.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of away status reason objects.","items":{"$ref":"#/components/schemas/away_status_reason"}}}}},"components/schemas/banner_list":{"id":"components/schemas/banner_list","kind":"json-schema","title":"Banner List","data":{"title":"Banner List","type":"object","description":"A list of banners a contact currently matches.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"An array of banners.","items":{"$ref":"#/components/schemas/banner"}}}}},"components/schemas/banner":{"id":"components/schemas/banner","kind":"json-schema","title":"Banner","data":{"title":"Banner","type":"object","x-tags":["Banners"],"description":"A banner the contact currently matches, with the content and view identifier needed to display and dismiss it.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"banner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"banner"},"id":{"type":"string","description":"The id of the banner.","example":"486517"},"view_id":{"type":"string","description":"The id of the contact's view of this banner. Pass this to the dismiss endpoint to record a dismissal.","example":"645719311"},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The banner's title. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the banner has no title."},"children":[]}]}]}],"example":"Hi there"},"body":{"type":"string","nullable":true,"description":"The banner's body content as HTML.","example":"<p class=\"no-margin\">Hi there!</p>"},"style":{"type":"string","description":"How the banner is displayed.","example":"inline"},"position":{"type":"string","description":"Where the banner is positioned.","example":"top"},"show_dismiss_button":{"type":"boolean","description":"Whether the banner should display a dismiss control.","example":true},"action":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action a contact can take on the banner, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the banner has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no action. The fields present depend on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reaction_set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_collector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_tour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tour_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tour_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of action. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_collector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_tour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"url"},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions, the label shown on the action link or button."},"children":[]}]}]}],"example":"Learn more"},"target":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions, the URL the contact is sent to."},"children":[]}]}]}],"example":"https://www.intercom.com/pricing"},"reaction_set":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions, the reactions a contact can choose from."},"children":[]}]}]}],"items":{"type":"object","properties":{"index":{"type":"integer","description":"The reaction's position in the set.","example":0},"unicode_emoticon":{"type":"string","description":"The reaction's unicode emoji.","example":"👍"}}}},"tour_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_tour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions, the id of the product tour to launch."},"children":[]}]}]}],"example":"12345"},"tour_url":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_tour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actions, the URL that launches the product tour."},"children":[]}]}]}],"example":"https://app.intercom.com/tours/12345"}}},"client_targeting":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserved for future use. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the current version — banners"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that depend on client-side targeting rules (such as page URL or time on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page) are not returned by this endpoint."},"children":[]}]}]}],"items":{"type":"object"}},"created_at":{"type":"integer","format":"timestamp","description":"The time the contact's view of this banner was created.","example":1780580493}}}},"components/schemas/banner_dismiss":{"id":"components/schemas/banner_dismiss","kind":"json-schema","title":"Banner Dismiss","data":{"title":"Banner Dismiss","type":"object","x-tags":["Banners"],"description":"The result of dismissing a banner for a contact.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"banner_dismiss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"banner_dismiss"},"view_id":{"type":"string","description":"The id of the dismissed banner view.","example":"645719311"},"dismissed":{"type":"boolean","description":"Whether the banner view is dismissed.","example":true}}}},"components/schemas/change_ticket_type_request":{"id":"components/schemas/change_ticket_type_request","kind":"json-schema","title":"Change Ticket Type Request","data":{"title":"Change Ticket Type Request","description":"You can change the type of a Ticket","type":"object","properties":{"ticket_type_id":{"type":"string","description":"The ID of the new ticket type. Must be in the same category as the current type.","example":"1234"},"ticket_state_id":{"type":"string","description":"The ID of the ticket state for the new ticket type.","example":"5678"},"ticket_attributes":{"type":"object","description":"The attributes to set on the ticket for the new type. Attributes matching by name and type are transferred automatically from the old type; values provided here override the transferred values.","example":{"_default_title_":"example","_default_description_":"having a problem"}}},"required":["ticket_type_id","ticket_state_id"]}},"components/schemas/close_conversation_request":{"id":"components/schemas/close_conversation_request","kind":"json-schema","title":"Close Conversation Request","data":{"title":"Close Conversation Request","type":"object","description":"Payload of the request to close a conversation","properties":{"message_type":{"type":"string","enum":["close"],"example":"close"},"type":{"type":"string","enum":["admin"],"example":"admin"},"admin_id":{"type":"string","description":"The id of the admin who is performing the action.","example":"12345"},"body":{"type":"string","description":"Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.","example":" This conversation is now closed!"},"assignee_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to assign the conversation to when it is closed. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unassign it, which clears both the teammate and the team assignee."},"children":[]}]}]}],"example":"4324241"},"skip_notifications":{"type":"boolean","description":"Option to disable notifications when closing a conversation. Available from API version 2.15.","example":true}},"required":["message_type","type","admin_id"]}},"components/schemas/collection":{"id":"components/schemas/collection","kind":"json-schema","title":"Collection","data":{"title":"Collection","type":"object","x-tags":["Help Center"],"description":"Collections are top level containers for Articles within the Help Center.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["collection"],"example":"collection"},"id":{"type":"string","description":"The unique identifier for the collection which is given by Intercom.","example":"6871119"},"workspace_id":{"type":"string","description":"The id of the workspace which the collection belongs to.","example":"hfi1bx4l"},"name":{"type":"string","description":"The name of the collection. For multilingual collections, this will be the name of the default language's content.","example":"Default language name"},"description":{"type":"string","nullable":true,"description":"The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.","example":"Default language description"},"created_at":{"type":"integer","format":"date-time","description":"The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.","example":1672928610},"url":{"type":"string","nullable":true,"description":"The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.","example":"http://intercom.test/help/collection/name"},"icon":{"type":"string","nullable":true,"description":"The icon of the collection.","example":"book-bookmark"},"order":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the section in relation to others sections within a collection. Values go from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" upwards. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the default if there's no order."},"children":[]}]}]}],"example":"1"},"default_locale":{"type":"string","description":"The default locale of the help center. This field is only returned for multilingual help centers.","example":"en"},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"},"parent_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the parent collection. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it is the first level collection."},"children":[]}]}]}],"example":"6871118"},"help_center_id":{"type":"integer","nullable":true,"description":"The id of the help center the collection is in.","example":"123"}}}},"components/schemas/help_center_redirect":{"id":"components/schemas/help_center_redirect","kind":"json-schema","title":"Help Center Redirect","data":{"title":"Help Center Redirect","type":"object","x-tags":["Help Center"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A redirect maps a source URL ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to an article, a collection or the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"home page of a help center, so that links to old or external URLs resolve to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"live content."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"The unique identifier for the redirect.","example":"26"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center_redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["help_center_redirect"],"example":"help_center_redirect"},"from_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source URL that is redirected. This is an absolute URL within the help center's URL space, or a relative path such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/old-page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for some existing redirects."},"children":[]}]}]}],"example":"http://help-center.test/lovelyhelpcenter/old-page"},"locale":{"type":"string","description":"The locale of the redirect's target. For article targets this is the bound translation's locale, which may differ from the requested locale if no translation exists in that locale.","example":"en"},"help_center_id":{"type":"string","description":"The unique identifier for the help center the redirect belongs to.","example":"7"},"target_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the redirect target. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" targets the help center's home page."},"children":[]}]}]}],"enum":["article","collection","help_center"],"example":"article"},"target_id":{"type":"string","description":"The unique identifier of the target article, collection or help center. For article targets this is the Article ID.","example":"11"},"created_at":{"type":"integer","description":"The time the redirect was created as a UTC Unix timestamp.","example":1781619405},"updated_at":{"type":"integer","description":"The time the redirect was last updated as a UTC Unix timestamp.","example":1781619405}}}},"components/schemas/help_center_redirect_list":{"id":"components/schemas/help_center_redirect_list","kind":"json-schema","title":"Help Center Redirects","data":{"title":"Help Center Redirects","type":"object","description":"This will return a list of redirects for the help center.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of redirects.","example":1},"data":{"type":"array","description":"An array of help center redirect objects.","items":{"$ref":"#/components/schemas/help_center_redirect"}}}}},"components/schemas/create_help_center_redirect_request":{"id":"components/schemas/create_help_center_redirect_request","kind":"json-schema","title":"Create Help Center Redirect Request Payload","data":{"description":"You can create a help center redirect.","type":"object","title":"Create Help Center Redirect Request Payload","properties":{"from_url":{"type":"string","description":"The source URL to redirect. Must be an absolute URL within the help center's URL space.","example":"http://help-center.test/lovelyhelpcenter/old-page"},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale of the target translation (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For article targets this selects the ArticleContent variant."},"children":[]}]}]}],"example":"en"},"target_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the redirect target. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" targets the help center's home page."},"children":[]}]}]}],"enum":["article","collection","help_center"],"example":"article"},"target_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the target article, collection or help center. The target must be a member of the help center. Required unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where it defaults to the help center in the path and must match it if provided."},"children":[]}]}]}],"example":"11"}},"required":["from_url","locale","target_type","target_id"]}},"components/schemas/deleted_help_center_redirect_object":{"id":"components/schemas/deleted_help_center_redirect_object","kind":"json-schema","title":"Deleted Help Center Redirect Object","data":{"title":"Deleted Help Center Redirect Object","type":"object","description":"Response returned when a redirect is deleted.","properties":{"id":{"type":"string","description":"The unique identifier for the redirect which you provided in the URL.","example":"26"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object which was deleted. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"help_center_redirect"},"children":[]}]}]}],"enum":["help_center_redirect"],"example":"help_center_redirect"},"deleted":{"type":"boolean","description":"Whether the redirect was deleted successfully or not.","example":true}}}},"components/schemas/collection_list":{"id":"components/schemas/collection_list","kind":"json-schema","title":"Collections","data":{"title":"Collections","type":"object","description":"This will return a list of Collections for the App.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of collections.","example":1},"data":{"type":"array","description":"An array of collection objects","items":{"$ref":"#/components/schemas/collection"}}}}},"components/schemas/bulk_create_contacts_request":{"id":"components/schemas/bulk_create_contacts_request","kind":"json-schema","title":"Bulk Create Contacts Request","data":{"title":"Bulk Create Contacts Request","type":"object","description":"Request body for bulk creating contacts.","required":["contacts"],"properties":{"contacts":{"type":"array","description":"An array of contact objects to create. Maximum 100 contacts per request.","maxItems":100,"items":{"type":"object","properties":{"external_id":{"type":"string","description":"A unique identifier for the contact which you have defined.","example":"abc123"},"email":{"type":"string","description":"The contact's email address.","example":"joe@example.com"},"email_verified":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the contact has proved they own this email address, for example through a confirmation link or one-time code you sent. Send it together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing a contact's email resets it to not verified. Intercom reuses leads with a verified email when an inbound email, conversation or ticket matches the address."},"children":[]}]}]}],"example":true},"name":{"type":"string","description":"The contact's name.","example":"Joe Bloggs"},"role":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's role. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Leads are exempt from the uniqueness check described above."},"children":[]}]}]}],"example":"user"},"phone":{"type":"string","description":"The contact's phone number."},"avatar":{"type":"string","description":"An image URL containing the avatar of the contact.","example":"https://www.example.com/avatar_image.jpg"},"language_override":{"type":"string","description":"A preferred language setting for the contact, used by the Intercom Messenger.","example":"fr"},"custom_attributes":{"type":"object","description":"Custom attributes to set on the contact."},"signed_up_at":{"type":"integer","description":"The time the contact signed up, in Unix timestamp format."},"last_seen_at":{"type":"integer","description":"The time the contact was last seen, in Unix timestamp format."},"owner_id":{"type":"string","description":"The ID of an admin that has been assigned account ownership of the contact.","example":"321"},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the contact is unsubscribed from emails.","example":true},"companies":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of companies to associate with the contact. Each company is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you have defined. A company that does not exist is created, and one that already exists has the supplied attributes applied to it."},"children":[]}]}]}],"items":{"type":"object","required":["company_id"],"properties":{"company_id":{"type":"string","description":"The company ID you have defined for the company.","example":"6"},"name":{"type":"string","description":"The name of the company.","example":"Blue Sun"}}}},"tags":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags to add to the contact. Each tag is identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must be a positive integer for a tag that already exists in your workspace. Tag application is best-effort: unknown tag IDs are skipped while the rest of the contact create still applies. Per-tag results are not yet returned in the job status."},"children":[]}]}]}],"properties":{"add":{"type":"array","description":"Tags to add to the contact.","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of an existing tag to add to the contact.","example":"123"}}}}}}}}},"job":{"type":"object","description":"Optional. Include to append tasks to an existing job.","properties":{"id":{"type":"string","description":"The ID of an existing bulk job to append to.","example":"job_v2_1"}}}}}},"components/schemas/bulk_delete_contacts_request":{"id":"components/schemas/bulk_delete_contacts_request","kind":"json-schema","title":"Bulk Delete Contacts Request","data":{"title":"Bulk Delete Contacts Request","type":"object","description":"Request body for permanently bulk deleting contacts.","required":["contacts"],"properties":{"contacts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of contacts to delete, each identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Maximum 1,000 contacts per request."},"children":[]}]}]}],"maxItems":1000,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the contact.","example":"abc123"}}}},"job":{"type":"object","description":"Optional. Include to append tasks to an existing job.","properties":{"id":{"type":"string","description":"The ID of an existing bulk job to append to.","example":"job_v2_1"}}}}}},"components/schemas/bulk_update_contacts_request":{"id":"components/schemas/bulk_update_contacts_request","kind":"json-schema","title":"Bulk Update Contacts Request","data":{"title":"Bulk Update Contacts Request","type":"object","description":"Request body for bulk updating contacts.","required":["contacts"],"properties":{"contacts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of contact objects to update. Each must include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the fields to update. Maximum 100 contacts per request."},"children":[]}]}]}],"maxItems":100,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the contact.","example":"abc123"},"role":{"type":"string","description":"The updated contact's role (optional).","example":"user"},"signed_up_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time specified for when a contact signed up.","example":1571672154},"last_seen_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact was last seen.","example":1571672154},"sms_consent":{"type":"boolean","description":"Whether the contact has consented to receive SMS messages.","example":false},"unsubscribed_from_sms":{"type":"boolean","description":"Whether the contact is unsubscribed from SMS messages.","example":false},"external_id":{"type":"string","description":"A unique identifier for the contact which you have defined.","example":"abc123"},"email":{"type":"string","description":"The contact's email address.","example":"joe@example.com"},"email_verified":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the contact has proved they own this email address, for example through a confirmation link or one-time code you sent. Send it together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing a contact's email resets it to not verified. Intercom reuses leads with a verified email when an inbound email, conversation or ticket matches the address."},"children":[]}]}]}],"example":true},"name":{"type":"string","description":"The contact's name.","example":"Joe Bloggs"},"phone":{"type":"string","description":"The contact's phone number."},"avatar":{"type":"string","description":"An image URL containing the avatar of the contact.","example":"https://www.example.com/avatar_image.jpg"},"owner_id":{"type":"string","description":"The ID of an admin that has been assigned account ownership of the contact.","example":"321"},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the contact is unsubscribed from emails.","example":true},"language_override":{"type":"string","description":"A preferred language setting for the contact, used by the Intercom Messenger.","example":"fr"},"custom_attributes":{"type":"object","description":"Custom attributes to update on the contact. For a relationship attribute, send the IDs of the custom object records to link the contact to."},"companies":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of companies to associate with the contact. Each company is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you have defined. A company that does not exist is created, and one that already exists has the supplied attributes applied to it."},"children":[]}]}]}],"items":{"type":"object","required":["company_id"],"properties":{"company_id":{"type":"string","description":"The company ID you have defined for the company.","example":"6"},"name":{"type":"string","description":"The name of the company.","example":"Blue Sun"},"remove":{"type":"boolean","description":"Set to true to detach this company from the contact instead of attaching it.","example":true}}}},"tags":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags to add to or remove from the contact. Each tag is identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which must be a positive integer for a tag that already exists in your workspace. Tag application is best-effort: unknown tag IDs are skipped while the rest of the contact update still applies. Per-tag results are not yet returned in the job status."},"children":[]}]}]}],"properties":{"add":{"type":"array","description":"Tags to add to the contact.","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of an existing tag to add to the contact.","example":"123"}}}},"remove":{"type":"array","description":"Tags to remove from the contact.","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of an existing tag to remove from the contact.","example":"789"}}}}}}}}},"job":{"type":"object","description":"Optional. Include to append tasks to an existing job.","properties":{"id":{"type":"string","description":"The ID of an existing bulk job to append to.","example":"job_v2_1"}}}}}},"components/schemas/company":{"id":"components/schemas/company","kind":"json-schema","title":"Company","data":{"title":"Company","type":"object","x-tags":["Companies"],"description":"Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]}]}]}],"enum":["company"],"example":"company"},"id":{"type":"string","description":"The Intercom defined id representing the company.","example":"531ee472cce572a6ec000006"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company. Returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Blue Sun"},"app_id":{"type":"string","description":"The Intercom defined code of the workspace the company is associated to.","example":"ecahpwf5"},"plan":{"type":"object","properties":{"type":{"type":"string","description":"Value is always \"plan\"","example":"plan"},"id":{"type":"string","description":"The id of the plan","example":"269315"},"name":{"type":"string","description":"The name of the plan","example":"Pro"}}},"company_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The company id you have defined for the company. Returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"6"},"remote_created_at":{"type":"integer","description":"The time the company was created by you.","example":1663597223},"created_at":{"type":"integer","description":"The time the company was added in Intercom.","example":1663597223},"updated_at":{"type":"integer","description":"The last time the company was updated.","example":1663597223},"last_request_at":{"type":"integer","description":"The time the company last recorded making a request.","example":1663597223},"size":{"type":"integer","description":"The number of employees in the company.","example":100},"website":{"type":"string","description":"The URL for the company website.","example":"https://www.intercom.com"},"industry":{"type":"string","description":"The industry that the company operates in.","example":"Software"},"monthly_spend":{"type":"integer","description":"How much revenue the company generates for your business.","example":100},"session_count":{"type":"integer","description":"How many sessions the company has recorded.","example":100},"user_count":{"type":"integer","description":"The number of users in the company.","example":100},"custom_attributes":{"type":"object","description":"The custom attributes you have set on the company.","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"tags":{"type":"object","description":"The list of tags associated with the company","properties":{"type":{"type":"string","description":"The type of the object","enum":["tag.list"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/tag_basic"}}}},"segments":{"type":"object","description":"Always returned empty. Fetch a company's segments with the list attached segments endpoint.","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment.list"]},"segments":{"type":"array","items":{"$ref":"#/components/schemas/segment"}}}},"notes":{"type":"object","description":"The list of notes associated with the company","properties":{"type":{"type":"string","description":"The type of the object","enum":["note.list"]},"data":{"type":"array","description":"The notes on the company, newest first.","items":{"$ref":"#/components/schemas/company_note"}},"url":{"type":"string","description":"The relative URL of the company's notes.","example":"/companies/531ee472cce572a6ec000006/notes"},"total_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of notes in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"has_more":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every note on the company is returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false}}}}}},"components/schemas/company_attached_contacts":{"id":"components/schemas/company_attached_contacts","kind":"json-schema","title":"Company Attached Contacts","data":{"title":"Company Attached Contacts","type":"object","description":"A list of Contact Objects","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array containing Contact Objects","items":{"$ref":"#/components/schemas/contact"}},"total_count":{"type":"integer","description":"The total number of contacts","example":100},"pages":{"$ref":"#/components/schemas/cursor_pages"}}}},"components/schemas/company_attached_segments":{"id":"components/schemas/company_attached_segments","kind":"json-schema","title":"Company Attached Segments","data":{"title":"Company Attached Segments","type":"object","description":"A list of Segment Objects","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array containing Segment Objects","items":{"$ref":"#/components/schemas/segment"}}}}},"components/schemas/company_note":{"id":"components/schemas/company_note","kind":"json-schema","title":"Company Note","data":{"title":"Company Note","type":"object","x-tags":["Notes"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A note as it appears inside a company's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list. Fetch the full note with the retrieve note endpoint."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"note"},"id":{"type":"string","description":"The id of the note.","example":"17495962"},"url":{"type":"string","description":"The relative URL of the note.","example":"/notes/17495962"},"body":{"type":"string","description":"The body text of the note.","example":"<p>Text for the note.</p>"}}}},"components/schemas/company_list":{"id":"components/schemas/company_list","kind":"json-schema","title":"Companies","data":{"title":"Companies","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will return a list of companies for the App. On the last page, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"The total number of companies.","example":100},"data":{"type":"array","description":"An array containing Company Objects.","items":{"$ref":"#/components/schemas/company"}}}}},"components/schemas/company_search_response":{"id":"components/schemas/company_search_response","kind":"json-schema","title":"Company Search Response","data":{"title":"Company Search Response","type":"object","description":"This will return a list of companies matching a search query.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/cursor_pages"},"total_count":{"type":"integer","description":"The total number of companies.","example":100},"data":{"type":"array","description":"An array containing Company Objects.","items":{"$ref":"#/components/schemas/company"}}}}},"components/schemas/company_scroll":{"id":"components/schemas/company_scroll","kind":"json-schema","title":"Company Scroll","data":{"title":"Company Scroll","type":"object","description":"Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/company"}},"pages":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Page through a scroll with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scroll_param"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"nullable":true},"total_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The scroll endpoint does not count the companies it returns."},"children":[]}]}]}],"nullable":true},"scroll_param":{"type":"string","description":"The scroll parameter to use in the next request to fetch the next page of results.","example":"25b649f7-4d33-4ef6-88f5-60e5b8244309"}}}},"components/schemas/company_user_list":{"id":"components/schemas/company_user_list","kind":"json-schema","title":"Company Users","data":{"title":"Company Users","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contacts attached to one company, returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the request names a single company. Contacts are in the legacy user format. On the last page, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["user.list"],"example":"user.list"},"users":{"type":"array","description":"The contacts attached to the company, in the legacy user format.","items":{"type":"object"}},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"The total number of contacts attached to the company.","example":1},"limited":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this list."},"children":[]}]}]}],"example":false}}}},"components/schemas/contact":{"id":"components/schemas/contact","kind":"json-schema","title":"Contact","data":{"title":"Contact","type":"object","x-tags":["Contacts"],"x-fern-sdk-group-name":"contacts","description":"Contacts represent your leads and users in Intercom.","properties":{"type":{"type":"string","description":"The type of object.","example":"contact"},"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"5ba682d23d7cf92bef87bfd4"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"f3b87a2e09d514c6c2e79b9a"},"workspace_id":{"type":"string","description":"The id of the workspace which the contact belongs to.","example":"ecahpwf5"},"role":{"type":"string","description":"The role of the contact.","example":"user"},"email":{"type":"string","description":"The contact's email.","example":"joe@example.com"},"email_domain":{"type":"string","description":"The contact's email domain.","example":"example.com"},"email_verified":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the contact has proved they own their current email address. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when this address was marked verified through the Contacts API ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_verified: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on create or update) and has not changed since; it becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again if the contact's email changes, until the new address is verified. Intercom reuses a lead with a verified email when it later matches an inbound email, or an outbound conversation or ticket, to that address, instead of creating a new lead. In List contacts and Search contacts responses it is left out only if the contact can't be loaded, for example when it is deleted while the request runs."},"children":[]}]}]}],"example":true},"phone":{"type":"string","nullable":true,"description":"The contacts phone.","example":"+1123456789"},"whatsapp_number":{"type":"string","nullable":true,"description":"The contact's WhatsApp number. It is read-only; sending it when creating or updating a contact has no effect.","example":"+34666666666"},"name":{"type":"string","nullable":true,"description":"The contacts name.","example":"John Doe"},"owner_id":{"type":"string","nullable":true,"description":"The id of an admin that has been assigned account ownership of the contact.","example":"321"},"has_hard_bounced":{"type":"boolean","description":"Whether the contact has had an email sent to them hard bounce.","example":true},"marked_email_as_spam":{"type":"boolean","description":"Whether the contact has marked an email sent to them as spam.","example":true},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the contact is unsubscribed from emails.","example":true},"created_at":{"type":"integer","format":"date-time","description":"(Unix timestamp in seconds) The time when the contact was created.","example":1571672154},"updated_at":{"type":"integer","format":"date-time","description":"(Unix timestamp in seconds) The time when the contact was last updated.","example":1571672154},"signed_up_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time specified for when a contact signed up.","example":1571672154},"last_seen_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).","example":1571672154},"last_replied_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact last messaged in.","example":1571672154},"last_contacted_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact was last messaged.","example":1571672154},"last_email_opened_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact last opened an email.","example":1571672154},"last_email_clicked_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact last clicked a link in an email.","example":1571672154},"language_override":{"type":"string","nullable":true,"description":"A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.","example":"en"},"browser":{"type":"string","nullable":true,"description":"The name of the browser which the contact is using.","example":"Chrome"},"browser_version":{"type":"string","nullable":true,"description":"The version of the browser which the contact is using.","example":"80.0.3987.132"},"browser_language":{"type":"string","nullable":true,"description":"The language set by the browser which the contact is using.","example":"en-US"},"os":{"type":"string","nullable":true,"description":"The operating system which the contact is using.","example":"Mac OS X"},"android_app_name":{"type":"string","nullable":true,"description":"The name of the Android app which the contact is using.","example":"Intercom"},"android_app_version":{"type":"string","nullable":true,"description":"The version of the Android app which the contact is using.","example":"5.0.0"},"android_device":{"type":"string","nullable":true,"description":"The Android device which the contact is using.","example":"Pixel 3"},"android_os_version":{"type":"string","nullable":true,"description":"The version of the Android OS which the contact is using.","example":"10"},"android_sdk_version":{"type":"string","nullable":true,"description":"The version of the Android SDK which the contact is using.","example":"28"},"android_last_seen_at":{"type":"integer","nullable":true,"format":"date-time","description":"(Unix timestamp in seconds) The time when the contact was last seen on an Android device.","example":1571672154},"ios_app_name":{"type":"string","nullable":true,"description":"The name of the iOS app which the contact is using.","example":"Intercom"},"ios_app_version":{"type":"string","nullable":true,"description":"The version of the iOS app which the contact is using.","example":"5.0.0"},"ios_device":{"type":"string","nullable":true,"description":"The iOS device which the contact is using.","example":"iPhone 11"},"ios_os_version":{"type":"string","nullable":true,"description":"The version of iOS which the contact is using.","example":"13.3.1"},"ios_sdk_version":{"type":"string","nullable":true,"description":"The version of the iOS SDK which the contact is using.","example":"13.3.1"},"ios_last_seen_at":{"type":"integer","nullable":true,"format":"date-time","description":"(Unix timestamp in seconds) The last time the contact used the iOS app.","example":1571672154},"custom_attributes":{"type":"object","description":"The custom attributes which are set for the contact."},"avatar":{"type":"string","format":"uri","nullable":true,"description":"An image URL containing the avatar of a contact.","example":"https://example.org/128Wash.jpg"},"tags":{"$ref":"#/components/schemas/contact_tags"},"notes":{"$ref":"#/components/schemas/contact_notes"},"companies":{"$ref":"#/components/schemas/contact_companies"},"location":{"$ref":"#/components/schemas/contact_location"},"social_profiles":{"$ref":"#/components/schemas/contact_social_profiles"},"opted_out_subscription_types":{"$ref":"#/components/schemas/contact_subscription_types"},"opted_in_subscription_types":{"$ref":"#/components/schemas/contact_subscription_types"},"utm_campaign":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utm_campaign"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value recorded for the contact."},"children":[]}]}]}],"example":"spring_launch"},"utm_content":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utm_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value recorded for the contact."},"children":[]}]}]}],"example":"banner_ad"},"utm_medium":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utm_medium"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value recorded for the contact."},"children":[]}]}]}],"example":"email"},"utm_source":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utm_source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value recorded for the contact."},"children":[]}]}]}],"example":"newsletter"},"utm_term":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"utm_term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value recorded for the contact."},"children":[]}]}]}],"example":"support_software"},"referrer":{"type":"string","nullable":true,"description":"The URL of the page the contact came from, as recorded by the Messenger.","example":"https://example.com/pricing"},"sms_consent":{"type":"boolean","description":"Whether the contact has consented to receive SMS messages.","example":false},"unsubscribed_from_sms":{"type":"boolean","description":"Whether the contact is unsubscribed from SMS messages.","example":false},"enabled_push_messaging":{"type":"boolean","nullable":true,"description":"Whether the contact has a mobile device registered to receive push messages.","example":true},"merge_history":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of contacts that were merged into this contact, most recent first, capped at 10. Only included in the response when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_merge_history=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed as a query parameter."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/merge_history_item"}}}}},"components/schemas/contact_attached_companies":{"id":"components/schemas/contact_attached_companies","kind":"json-schema","title":"Contact Attached Companies","data":{"title":"Contact Attached Companies","type":"object","description":"A list of Company Objects","properties":{"type":{"type":"string","description":"The type of object","enum":["list"],"example":"list"},"data":{"type":"array","description":"An array containing Company Objects","items":{"$ref":"#/components/schemas/company"}},"total_count":{"type":"integer","description":"The total number of companies associated to this contact","example":100},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"components/schemas/contact_companies":{"id":"components/schemas/contact_companies","kind":"json-schema","title":"Contact companies","data":{"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.","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","description":"Url to get more company resources for this contact","example":"/contacts/5ba682d23d7cf92bef87bfd4/companies"},"total_count":{"type":"integer","description":"Integer representing the total number of companies attached to this contact","example":100},"has_more":{"type":"boolean","description":"Whether there's more Addressable Objects to be viewed. If true, use the url to view all","example":true}}}},"components/schemas/company_data":{"id":"components/schemas/company_data","kind":"json-schema","title":"Company Data","data":{"title":"Company Data","type":"object","description":"An object containing data about the companies that a contact is associated with.","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.","enum":["company"],"example":"company"},"url":{"type":"string","format":"uri","description":"The relative URL of the company.","example":"/companies/5ba682d23d7cf92bef87bfd4"}}}},"components/schemas/contact_deleted":{"id":"components/schemas/contact_deleted","kind":"json-schema","title":"Contact Deleted","data":{"title":"Contact Deleted","description":"deleted contact object","allOf":[{"$ref":"#/components/schemas/contact_reference"}],"properties":{"deleted":{"type":"boolean","description":"Whether the contact is deleted or not.","example":true}}}},"components/schemas/contact_activity":{"id":"components/schemas/contact_activity","kind":"json-schema","title":"Contact Activity","data":{"title":"Contact Activity","type":"object","description":"An activity event that occurred for a contact, such as creation, merge, or deletion.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always contact_activity"},"children":[]}]}]}],"enum":["contact_activity"],"example":"contact_activity"},"id":{"type":"string","description":"The unique identifier for the activity event.","example":"1717000000000.0000a1"},"event_type":{"type":"string","description":"The type of activity event.","enum":["contact.created","contact.role_updated","contact.deleted","contact.merged","contact.merge_failed"],"example":"contact.created"},"contact_id":{"type":"string","description":"The unique identifier for the contact the event relates to.","example":"6329bd9ffe4e2e91dc5d6a1e"},"external_id":{"type":"string","description":"The external identifier of the contact. Omitted when not set.","example":"user-42"},"role":{"type":"string","description":"The role of the contact at the time of the event, either user, lead, or visitor. Omitted when not recorded.","example":"user"},"merge_source_id":{"type":"string","description":"For merge events, the identifier of the contact that was merged away. Omitted on other events.","example":"5f7f0d217c3f2e001a4e8b12"},"merge_target_id":{"type":"string","description":"For merge events, the identifier of the contact that was merged into. Omitted on other events.","example":"6329bd9ffe4e2e91dc5d6a1e"},"failure_reason":{"type":"string","description":"For failed events, the reason the activity did not succeed. Omitted on other events.","example":"duplicate_external_id"},"created_at":{"type":"integer","format":"date-time","description":"The time the activity event occurred, as a Unix timestamp in seconds.","example":1717000000}}}},"components/schemas/contact_activity_list":{"id":"components/schemas/contact_activity_list","kind":"json-schema","title":"Contact Activity List","data":{"title":"Contact Activity List","type":"object","description":"A paginated list of contact activity events.","properties":{"type":{"type":"string","description":"Always list","enum":["list"],"example":"list"},"data":{"type":"array","description":"The list of contact activity objects.","items":{"$ref":"#/components/schemas/contact_activity"}},"pages":{"type":"object","description":"Pagination information.","properties":{"type":{"type":"string","example":"pages","enum":["pages"]},"per_page":{"type":"integer","description":"The number of results per page.","example":10},"next":{"type":"object","description":"Cursor for the next page of results. Omitted on the last page.","properties":{"starting_after":{"type":"string","description":"The cursor value to use for the next page.","example":"1717000000000.0000a1"}}}}}}}},"components/schemas/contact_list":{"id":"components/schemas/contact_list","kind":"json-schema","title":"Contact List","data":{"title":"Contact List","type":"object","description":"Contacts are your users in Intercom.","properties":{"type":{"type":"string","description":"Always list","enum":["list"],"example":"list"},"data":{"type":"array","description":"The list of contact objects","items":{"$ref":"#/components/schemas/contact"}},"total_count":{"type":"integer","description":"A count of the total number of objects.","example":100},"pages":{"$ref":"#/components/schemas/cursor_pages"}}}},"components/schemas/contacts_bulk_job":{"id":"components/schemas/contacts_bulk_job","kind":"json-schema","title":"Contacts Bulk Job","data":{"title":"Contacts Bulk Job","type":"object","x-tags":["Contacts"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A bulk job for updating contacts asynchronously. Track the job status using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"The unique identifier for the bulk job.","example":"job_v2_1"},"type":{"type":"string","description":"The type of the object.","enum":["contacts.bulk.job"],"example":"contacts.bulk.job"},"state":{"type":"string","description":"The current state of the job.","enum":["running","completed","completed_with_errors"],"example":"running"},"created_at":{"type":"integer","format":"date-time","description":"The time the job was created as a Unix timestamp.","example":1713360000},"updated_at":{"type":"integer","format":"date-time","description":"The time the job was last updated as a Unix timestamp.","example":1713360060},"completed_at":{"type":"integer","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time the most recent task completed as a Unix timestamp. Set as soon as any task completes, so check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to know whether the whole job has finished. Null until a task completes."},"children":[]}]}]}],"example":1713360120},"tasks":{"type":"array","description":"The tasks that make up this bulk job.","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the task.","example":"task_v2_1"},"item_count":{"type":"integer","description":"The number of items in this task.","example":3},"state":{"type":"string","description":"The current state of the task.","enum":["pending","running","completed","completed_with_errors"],"example":"pending"},"created_at":{"type":"integer","format":"date-time","description":"The time the task was created as a Unix timestamp.","example":1713360000},"started_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time the task started as a Unix timestamp. Null if not yet started.","example":1713360060},"completed_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time the task completed as a Unix timestamp. Null if not yet completed.","example":1713360120}}}},"url":{"type":"string","description":"The URL to check the job status.","example":"https://api.intercom.io/contacts/bulk/job_v2_1"}}}},"components/schemas/contact_location":{"id":"components/schemas/contact_location","kind":"json-schema","title":"Contact Location","data":{"title":"Contact Location","type":"object","nullable":false,"description":"An object containing location meta data about a Intercom contact.","properties":{"type":{"type":"string","nullable":true,"description":"Always location","example":"location"},"country":{"type":"string","nullable":true,"description":"The country that the contact is located in","example":"Ireland"},"region":{"type":"string","nullable":true,"description":"The overal region that the contact is located in","example":"Dublin"},"city":{"type":"string","nullable":true,"description":"The city that the contact is located in","example":"Dublin"},"country_code":{"type":"string","nullable":true,"description":"The ISO 3166-1 alpha-3 code of the country that the contact is located in","example":"IRL"},"continent_code":{"type":"string","nullable":true,"description":"The code of the continent that the contact is located in","example":"EU"}}}},"components/schemas/contact_notes":{"id":"components/schemas/contact_notes","kind":"json-schema","title":"Contact notes","data":{"title":"Contact notes","type":"object","nullable":false,"description":"An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.","properties":{"data":{"type":"array","description":"This object represents the notes attached to a contact.","items":{"$ref":"#/components/schemas/addressable_list"}},"url":{"type":"string","format":"uri","description":"Url to get more company resources for this contact","example":"/contacts/5ba682d23d7cf92bef87bfd4/notes"},"total_count":{"type":"integer","description":"Int representing the total number of companyies attached to this contact","example":100},"has_more":{"type":"boolean","description":"Whether there's more Addressable Objects to be viewed. If true, use the url to view all","example":true}}}},"components/schemas/contact_reference":{"id":"components/schemas/contact_reference","kind":"json-schema","title":"Contact Reference","data":{"title":"Contact Reference","type":"object","description":"reference to contact object","properties":{"type":{"type":"string","description":"always contact","enum":["contact"],"example":"contact"},"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"5ba682d23d7cf92bef87bfd4"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"70"},"email":{"type":"string","nullable":true,"description":"The contact's email.","example":"joe@example.com"}}}},"components/schemas/contact_reply_base_request":{"id":"components/schemas/contact_reply_base_request","kind":"json-schema","title":"Contact Reply Base Object","data":{"title":"Contact Reply Base Object","type":"object","properties":{"message_type":{"type":"string","enum":["comment"]},"type":{"type":"string","enum":["user"]},"body":{"type":"string","description":"The text body of the comment. Required unless the reply includes attachments. Always required when replying to a ticket."},"created_at":{"type":"integer","description":"The time the reply was created. If not provided, the current time will be used.","example":1590000000},"attachment_urls":{"title":"Attachment URLs","type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10},"reply_options":{"title":"Contact Quick Reply","type":"array","description":"The quick reply selection the contact wishes to respond with. These map to buttons displayed in the Messenger UI if sent by a bot, or the reply options sent by an Admin via the API.","items":{"title":"Quick Reply Option","type":"object","properties":{"text":{"type":"string","description":"The text of the chosen reply option."},"uuid":{"type":"string","format":"uuid","description":"The unique identifier for the quick reply option selected."}},"required":["text","uuid"]}}},"required":["message_type","type"]}},"components/schemas/contact_reply_conversation_request":{"id":"components/schemas/contact_reply_conversation_request","kind":"json-schema","title":"Contact Reply","data":{"title":"Contact Reply","oneOf":[{"$ref":"#/components/schemas/contact_reply_intercom_user_id_request"},{"$ref":"#/components/schemas/contact_reply_email_request"},{"$ref":"#/components/schemas/contact_reply_user_id_request"}]}},"components/schemas/contact_reply_email_request":{"id":"components/schemas/contact_reply_email_request","kind":"json-schema","title":"Email","data":{"title":"Email","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to reply on behalf of a contact using their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]}],"properties":{"email":{"type":"string","description":"The email you have defined for the user."},"attachment_files":{"type":"array","description":"A list of files that will be added as attachments.","items":{"$ref":"#/components/schemas/conversation_attachment_files"}}},"allOf":[{"$ref":"#/components/schemas/contact_reply_base_request"}],"required":["email"]}},"components/schemas/contact_reply_intercom_user_id_request":{"id":"components/schemas/contact_reply_intercom_user_id_request","kind":"json-schema","title":"Intercom User ID","data":{"title":"Intercom User ID","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to reply on behalf of a contact using their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/contact_reply_base_request"}],"properties":{"intercom_user_id":{"type":"string","description":"The identifier for the contact as given by Intercom."},"attachment_files":{"type":"array","description":"A list of files that will be added as attachments.","items":{"$ref":"#/components/schemas/conversation_attachment_files"}}},"required":["intercom_user_id"]}},"components/schemas/contact_reply_ticket_email_request":{"id":"components/schemas/contact_reply_ticket_email_request","kind":"json-schema","title":"Email","data":{"title":"Email","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to reply on behalf of a contact using their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]}],"properties":{"email":{"type":"string","description":"The email you have defined for the user."}},"allOf":[{"$ref":"#/components/schemas/contact_reply_base_request"}],"required":["email","body"]}},"components/schemas/contact_reply_ticket_intercom_user_id_request":{"id":"components/schemas/contact_reply_ticket_intercom_user_id_request","kind":"json-schema","title":"Intercom User ID","data":{"title":"Intercom User ID","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to reply on behalf of a contact using their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_id"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/contact_reply_base_request"}],"properties":{"intercom_user_id":{"type":"string","description":"The identifier for the contact as given by Intercom."}},"required":["intercom_user_id","body"]}},"components/schemas/contact_reply_ticket_request":{"id":"components/schemas/contact_reply_ticket_request","kind":"json-schema","title":"Contact Reply on ticket","data":{"title":"Contact Reply on ticket","oneOf":[{"$ref":"#/components/schemas/contact_reply_ticket_intercom_user_id_request"},{"$ref":"#/components/schemas/contact_reply_ticket_user_id_request"},{"$ref":"#/components/schemas/contact_reply_ticket_email_request"}]}},"components/schemas/contact_reply_ticket_user_id_request":{"id":"components/schemas/contact_reply_ticket_user_id_request","kind":"json-schema","title":"User ID","data":{"title":"User ID","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to reply on behalf of a contact using their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/contact_reply_base_request"}],"properties":{"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external_id you have defined for the contact."},"children":[]}]}]}]}},"required":["user_id","body"]}},"components/schemas/contact_reply_user_id_request":{"id":"components/schemas/contact_reply_user_id_request","kind":"json-schema","title":"User ID","data":{"title":"User ID","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload of the request to reply on behalf of a contact using their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/contact_reply_base_request"}],"properties":{"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external_id you have defined for the contact."},"children":[]}]}]}]},"attachment_files":{"type":"array","description":"A list of files that will be added as attachments. You can include up to 10 files.","items":{"$ref":"#/components/schemas/conversation_attachment_files"},"maxItems":10}},"required":["user_id"]}},"components/schemas/contact_search_request":{"id":"components/schemas/contact_search_request","kind":"json-schema","title":"Contact search request","data":{"description":"Search for contacts using Intercom's Search API.","type":"object","title":"Contact search request","properties":{"query":{"oneOf":[{"$ref":"#/components/schemas/single_filter_search_request","title":"Single filter search request"},{"$ref":"#/components/schemas/multiple_filter_search_request","title":"multiple filter search request"}]},"pagination":{"$ref":"#/components/schemas/starting_after_paging"},"sort":{"type":"object","description":"An optional object to sort the results by.","properties":{"field":{"type":"string","description":"The field to sort the results on.","example":"created_at"},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order to sort the results in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted. Values other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ascending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_sort_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ascending","descending"],"default":"descending","example":"descending"}}}},"required":["query"]}},"components/schemas/contact_segments":{"id":"components/schemas/contact_segments","kind":"json-schema","title":"Segments","data":{"title":"Segments","type":"object","description":"A list of segments objects attached to a specific contact.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"Segment objects associated with the contact.","items":{"$ref":"#/components/schemas/segment"}}}}},"components/schemas/contact_social_profiles":{"id":"components/schemas/contact_social_profiles","kind":"json-schema","title":"Social Profile","data":{"title":"Social Profile","type":"object","nullable":false,"description":"An object containing social profiles that a contact has.","properties":{"data":{"type":"array","description":"A list of social profiles objects associated with the contact.","items":{"$ref":"#/components/schemas/social_profile"}}}}},"components/schemas/contact_subscription_types":{"id":"components/schemas/contact_subscription_types","kind":"json-schema","title":"Contact Subscription Types","data":{"title":"Contact Subscription Types","type":"object","nullable":false,"description":"An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"This object represents the subscriptions attached to a contact.","items":{"$ref":"#/components/schemas/addressable_list"}},"url":{"type":"string","format":"uri","description":"Url to get more subscription type resources for this contact","example":"/contacts/5ba682d23d7cf92bef87bfd4/subscriptions"},"total_count":{"type":"integer","description":"Int representing the total number of subscription types attached to this contact","example":100},"has_more":{"type":"boolean","description":"Whether there's more Addressable Objects to be viewed. If true, use the url to view all","example":true}}}},"components/schemas/contact_tags":{"id":"components/schemas/contact_tags","kind":"json-schema","title":"Contact Tags","data":{"title":"Contact Tags","type":"object","nullable":true,"description":"An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.","properties":{"data":{"type":"array","description":"This object represents the tags attached to a contact.","items":{"$ref":"#/components/schemas/addressable_list"}},"url":{"type":"string","format":"uri","description":"url to get more tag resources for this contact","example":"/contacts/5ba682d23d7cf92bef87bfd4/tags"},"total_count":{"type":"integer","description":"Int representing the total number of tags attached to this contact","example":100},"has_more":{"type":"boolean","description":"Whether there's more Addressable Objects to be viewed. If true, use the url to view all","example":true}}}},"components/schemas/contact_archived":{"id":"components/schemas/contact_archived","kind":"json-schema","title":"Contact Archived","data":{"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}}}},"components/schemas/contact_unarchived":{"id":"components/schemas/contact_unarchived","kind":"json-schema","title":"Contact Unarchived","data":{"title":"Contact Unarchived","description":"unarchived contact object","allOf":[{"$ref":"#/components/schemas/contact_reference"}],"properties":{"archived":{"type":"boolean","description":"Whether the contact is archived or not.","example":false}}}},"components/schemas/deleted_contact":{"id":"components/schemas/deleted_contact","kind":"json-schema","title":"Deleted Contact","data":{"title":"Deleted Contact","type":"object","description":"A contact that is no longer active, returned by the list deleted contacts endpoint.","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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the contact which is provided by the Client. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for permanently deleted contacts."},"children":[]}]}]}],"example":"70"},"email":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's email address. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for permanently deleted contacts."},"children":[]}]}]}],"example":"joe@example.com"},"role":{"type":"string","description":"The role of the contact.","enum":["user","lead"],"example":"user"},"status":{"type":"string","description":"Why the contact is no longer active.","enum":["archived","blocked","merged","pending_deletion","permanently_deleted"],"example":"archived"},"merged_into_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the contact this one was merged into. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5ba682d23d7cf92bef87bfd9"},"updated_at":{"type":"integer","format":"date-time","description":"The time the contact record was last updated as a UNIX timestamp. This is a last-modified time, not a deletion time.","example":1756636800}}}},"components/schemas/deleted_contact_list":{"id":"components/schemas/deleted_contact_list","kind":"json-schema","title":"Deleted Contact List","data":{"title":"Deleted Contact List","type":"object","description":"A paginated list of deleted contacts.","properties":{"type":{"type":"string","description":"Always list","enum":["list"],"example":"list"},"data":{"type":"array","description":"The list of deleted contact objects.","items":{"$ref":"#/components/schemas/deleted_contact"},"example":[{"type":"contact","id":"5ba682d23d7cf92bef87bfd4","external_id":"70","email":"joe@example.com","role":"user","status":"archived","updated_at":1756636800}]},"total_count":{"type":"integer","description":"A count of the total number of deleted contacts.","example":100},"pages":{"type":"object","description":"Offset-based pagination metadata.","example":{"type":"pages","page":1,"per_page":10,"total_pages":1},"properties":{"type":{"type":"string","enum":["pages"],"example":"pages"},"page":{"type":"integer","example":1},"per_page":{"type":"integer","example":10},"total_pages":{"type":"integer","example":1}}}}}},"components/schemas/contact_blocked":{"id":"components/schemas/contact_blocked","kind":"json-schema","title":"Contact Blocked","data":{"title":"Contact Blocked","type":"object","description":"blocked contact object","allOf":[{"$ref":"#/components/schemas/contact_reference"}],"properties":{"blocked":{"type":"boolean","description":"Always true.","example":true}}}},"components/schemas/content_bulk_action_request":{"id":"components/schemas/content_bulk_action_request","kind":"json-schema","title":"Content Bulk Action Request Payload","data":{"title":"Content Bulk Action Request Payload","type":"object","required":["action","content_ids"],"properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulk action to perform. Allowed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_ids[].type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values vary per action:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publish"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpublish"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_snippet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_source_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_article"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_audience"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_snippet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_source_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_article"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the parent Article id, not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_snippet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_source_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_article"},"children":[]}]}]}]}],"enum":["publish","unpublish","delete","set_availability","set_audience","update_tags"],"example":"publish"},"content_ids":{"type":"array","maxItems":1000,"description":"Up to 1,000 content items to apply the action to.","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["article","article_content","content_snippet","external_content","file_source_content","internal_article"],"example":"article_content"},"id":{"type":"string","example":"12345678"}}}},"availability":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each field is optional — only the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"properties present in the request are toggled."},"children":[]}]}]}],"properties":{"ai_agent":{"type":"boolean","description":"Toggle Fin AI Agent availability."},"copilot":{"type":"boolean","description":"Toggle Copilot availability."},"sales_agent":{"type":"boolean","description":"Toggle Sales Agent availability."}}},"audience":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_audience"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Manages segment membership."},"children":[]}]}]}],"properties":{"add_segment_ids":{"type":"array","description":"Segment IDs to assign to the selected content.","items":{"type":"integer"},"example":[100]},"remove_segment_ids":{"type":"array","description":"Segment IDs to remove from the selected content.","items":{"type":"integer"},"example":[200]},"remove_all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", removes all segments from the selected content."},"children":[]}]}]}],"example":false}}},"tags":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Applies and/or removes existing tags."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply at least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". At most 100 distinct tag IDs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may be supplied across "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_tag_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" combined. Tag IDs must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference existing, non-archived tags; exceeding the limit or referencing unknown or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archived IDs is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (HTTP 422)."},"children":[]}]}]}],"properties":{"add_tag_ids":{"type":"array","description":"Tag IDs to apply to the selected content.","items":{"type":"integer"},"example":[100]},"remove_tag_ids":{"type":"array","description":"Tag IDs to remove from the selected content.","items":{"type":"integer"},"example":[200]}}}}}},"components/schemas/content_bulk_action_response":{"id":"components/schemas/content_bulk_action_response","kind":"json-schema","title":"Content Bulk Action Response Envelope","data":{"title":"Content Bulk Action Response Envelope","type":"object","description":"Phase 1 envelope returned immediately after the request is enqueued. A future\nPreview release will replace this with a polling-friendly job resource that\nsurfaces progress and per-item results (updated, unchanged, skipped, failed).\n","properties":{"type":{"type":"string","example":"content_bulk_action"},"status":{"type":"string","example":"queued"}}}},"components/schemas/content_import_source":{"id":"components/schemas/content_import_source","kind":"json-schema","title":"Content Import Source","data":{"title":"Content Import Source","type":"object","x-tags":["AI Content"],"description":"An external source for External Pages that you add to your Fin Content Library.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always content_import_source"},"children":[]}]}]}],"enum":["content_import_source"],"default":"content_import_source","example":"content_import_source"},"id":{"type":"integer","description":"The unique identifier for the content import source which is given by Intercom.","example":1234},"last_synced_at":{"type":"integer","format":"date-time","description":"The time when the content import source was last synced.","example":1672928610},"sync_behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you intend to create or update External Pages via the API, this should be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["api","automatic","manual"],"example":"api"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the content import source. A source that is being deleted has the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deletion_in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","deactivated","deletion_in_progress"],"default":"active","example":"active"},"url":{"type":"string","description":"The URL of the root of the external source.","example":"https://help.example.com/"},"created_at":{"type":"integer","format":"date-time","description":"The time when the content import source was created.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the content import source was last updated.","example":1672928610},"audience_ids":{"type":"array","nullable":true,"items":{"type":"integer"},"description":"The unique identifiers for the audiences associated with this content import source.","example":[5678]}},"required":["id","type","url","sync_behavior","status","created_at","updated_at","last_synced_at"]}},"components/schemas/content_import_sources_list":{"id":"components/schemas/content_import_sources_list","kind":"json-schema","title":"Content Import Sources","data":{"title":"Content Import Sources","type":"object","x-tags":["AI Content"],"description":"This will return a list of the content import sources for the App.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of content import sources, including deleted ones that the list leaves out.","example":1},"data":{"type":"array","description":"An array of Content Import Source objects","items":{"$ref":"#/components/schemas/content_import_source"}}}}},"components/schemas/content_source":{"id":"components/schemas/content_source","kind":"json-schema","title":"Content Source","data":{"title":"Content Source","type":"object","x-tags":["AI Content Source"],"description":"The content source used by AI Agent in the conversation.","properties":{"content_type":{"type":"string","description":"The type of the content source.","example":"content_snippet","enum":["file","article","external_content","content_snippet","workflow_connector_action","internal_article"]},"url":{"type":"string","description":"The internal URL linking to the content source for teammates.","example":"/fin-ai-agent/content?content=content_snippet&id=3234924"},"title":{"type":"string","description":"The title of the content source.","example":"My internal content snippet"},"locale":{"type":"string","description":"The ISO 639 language code of the content source.","example":"en"}}}},"components/schemas/content_sources_list":{"id":"components/schemas/content_sources_list","kind":"json-schema","title":"Content Source List","data":{"title":"Content Source List","nullable":false,"properties":{"type":{"type":"string","enum":["content_source.list"],"example":"content_source.list"},"total_count":{"type":"integer","description":"The total number of content sources used by AI Agent in the conversation.","example":1},"content_sources":{"type":"array","description":"The content sources used by AI Agent in the conversation.","items":{"$ref":"#/components/schemas/content_source"}}}}},"components/schemas/content_snippet":{"id":"components/schemas/content_snippet","kind":"json-schema","title":"Content Snippet","data":{"title":"Content Snippet","type":"object","x-tags":["Content Snippets"],"description":"A content snippet is a reusable piece of content for your AI agent and Copilot.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_snippet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"content_snippet"},"id":{"type":"string","description":"The unique identifier for the content snippet.","example":"123"},"title":{"type":"string","description":"The title of the content snippet.","nullable":true,"example":"How to reset your password"},"locale":{"type":"string","description":"The locale of the content snippet.","example":"en"},"json_blocks":{"type":"array","description":"The content blocks that make up the body of the snippet. In responses, the blocks are returned as a JSON-encoded string rather than as an array.","items":{"type":"object"},"example":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}]},"body_markdown":{"type":"string","nullable":true,"description":"The body of the content snippet in markdown.","example":"Navigate to Settings \\> Security \\> Reset password.\n"},"chatbot_availability":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use ai_chatbot_availability instead."},"children":[]}]}]}],"example":2},"copilot_availability":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use ai_copilot_availability instead."},"children":[]}]}]}],"example":2},"ai_chatbot_availability":{"type":"boolean","description":"Whether the content snippet is available for AI Chatbot (Fin).","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the content snippet is available for AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the content snippet is available for AI Sales Agent.","example":true},"created_at":{"type":"integer","description":"The time the snippet was created as a UNIX timestamp.","example":1663597223},"updated_at":{"type":"integer","description":"The time the snippet was last updated as a UNIX timestamp.","example":1663597223},"audience_ids":{"type":"array","nullable":true,"description":"The list of audience IDs this content snippet is targeted to for Fin AI Agent. Empty array means no audience targeting is set.","items":{"type":"integer"},"example":[1,2]}}}},"components/schemas/content_snippet_list":{"id":"components/schemas/content_snippet_list","kind":"json-schema","title":"Content Snippet List","data":{"title":"Content Snippet List","type":"object","description":"A paginated list of content snippets.","nullable":false,"properties":{"type":{"type":"string","enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of content snippet objects.","items":{"$ref":"#/components/schemas/content_snippet"}},"total_count":{"type":"integer","description":"The total number of content snippets.","example":1},"page":{"type":"integer","description":"The current page number.","example":1},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total_pages":{"type":"integer","description":"The total number of pages.","example":1}}}},"components/schemas/content_snippet_create_request":{"id":"components/schemas/content_snippet_create_request","kind":"json-schema","title":"Create Content Snippet Request","data":{"title":"Create Content Snippet Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for creating a content snippet. You can provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the snippet content — they are mutually exclusive. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted or blank, the snippet is created with a single empty paragraph."},"children":[]}]}]}],"nullable":false,"required":["title"],"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title of the content snippet. The API accepts a missing, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or empty title."},"children":[]}]}]}],"maxLength":255,"example":"How to reset your password"},"json_blocks":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content blocks that make up the body of the snippet. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"},"example":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}]},"body_markdown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the snippet in markdown. An alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — you can provide content as markdown instead of structured blocks. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"# Hello\n\nSome content.\n"},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale of the content snippet. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"en","example":"en"},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to target this content snippet to for Fin AI Agent. Pass an empty array or omit the field for no audience targeting. Unknown audience IDs return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with no partial commit."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Chatbot (Fin). Defaults to true.","default":true,"example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Copilot. Defaults to true.","default":true,"example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Sales Agent. Defaults to true.","default":true,"example":true}}}},"components/schemas/content_snippet_update_request":{"id":"components/schemas/content_snippet_update_request","kind":"json-schema","title":"Update Content Snippet Request","data":{"title":"Update Content Snippet Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for updating a content snippet. All fields are optional — only provided fields will be updated. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutually exclusive."},"children":[]}]}]}],"nullable":false,"properties":{"title":{"type":"string","description":"The title of the content snippet.","maxLength":255,"example":"How to reset your password"},"json_blocks":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content blocks that make up the body of the snippet. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"},"example":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}]},"body_markdown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the snippet in markdown. An alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — you can provide content as markdown instead of structured blocks. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"## Updated heading\n\nNew content.\n"},"locale":{"type":"string","description":"The locale of the content snippet.","example":"en"},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to target this content snippet to for Fin AI Agent. Omitting the field leaves existing audience memberships unchanged (PATCH semantics). Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear all audience memberships. Unknown audience IDs return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with no partial commit."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Chatbot (Fin).","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Sales Agent.","example":true}}}},"components/schemas/dynamic_content":{"id":"components/schemas/dynamic_content","kind":"json-schema","title":"Dynamic Content","data":{"title":"Dynamic Content","type":"object","x-tags":["Dynamic Content"],"description":"Dynamic content is a reusable piece of content that you can insert into Help Center articles. It holds one variation per locale, and optionally per brand.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamic_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"dynamic_content"},"id":{"type":"string","description":"The unique identifier for the dynamic content.","example":"123"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the dynamic content. Returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Support phone number"},"key":{"type":"string","description":"The identifier that articles use to reference the dynamic content. Derived from the name when the dynamic content is created, and never changes.","example":"support-phone-number"},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the dynamic content is a short inline value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or one or more blocks of content ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["inline","block"],"example":"inline"},"default_locale":{"type":"string","description":"The locale whose variation is used when there's no variation for the requested locale.","example":"en"},"variations":{"type":"array","description":"The variations of the dynamic content.","items":{"$ref":"#/components/schemas/dynamic_content_variation"}},"created_at":{"type":"integer","format":"date-time","description":"The time the dynamic content was created as a Unix timestamp.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The time the dynamic content was last updated as a Unix timestamp.","example":1663597223}}}},"components/schemas/dynamic_content_variation":{"id":"components/schemas/dynamic_content_variation","kind":"json-schema","title":"Dynamic Content Variation","data":{"title":"Dynamic Content Variation","type":"object","x-tags":["Dynamic Content"],"description":"The value of a dynamic content for one locale, and optionally one brand.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamic_content_variation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"dynamic_content_variation"},"id":{"type":"string","description":"The unique identifier for the variation.","example":"456"},"locale":{"type":"string","description":"The locale of the variation.","example":"en"},"brand_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the brand the variation applies to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a variation that applies to all brands."},"children":[]}]}]}],"example":"42"},"text_content":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of an inline variation. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for block dynamic content."},"children":[]}]}]}],"example":"+1-555-0100"},"json_blocks":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content blocks of a block variation. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inline dynamic content."},"children":[]}]}]}],"items":{"type":"object"},"example":[{"type":"paragraph","text":"You can request a refund within 30 days of purchase."}]},"intentionally_empty":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the variation is intentionally empty. An intentionally empty variation shows nothing instead of falling back to the default content, and has an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"created_at":{"type":"integer","format":"date-time","description":"The time the variation was created as a Unix timestamp.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The time the variation was last updated as a Unix timestamp.","example":1663597223}}}},"components/schemas/dynamic_content_list":{"id":"components/schemas/dynamic_content_list","kind":"json-schema","title":"Dynamic Content List","data":{"title":"Dynamic Content List","type":"object","description":"A paginated list of dynamic content.","nullable":false,"properties":{"type":{"type":"string","enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of dynamic content objects.","items":{"$ref":"#/components/schemas/dynamic_content"}},"total_count":{"type":"integer","description":"The total number of dynamic content.","example":1},"page":{"type":"integer","description":"The current page number.","example":1},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total_pages":{"type":"integer","description":"The total number of pages.","example":1}}}},"components/schemas/dynamic_content_variation_request":{"id":"components/schemas/dynamic_content_variation_request","kind":"json-schema","title":"Dynamic Content Variation Request","data":{"title":"Dynamic Content Variation Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A variation of a dynamic content. Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inline dynamic content, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for block dynamic content."},"children":[]}]}]}],"nullable":false,"required":["locale"],"properties":{"locale":{"type":"string","description":"The locale of the variation. Each locale can appear once per brand.","example":"en"},"brand_id":{"type":"string","nullable":true,"description":"The unique identifier for the brand the variation applies to. Omit for a variation that applies to all brands.","example":"42"},"text_content":{"type":"string","description":"The value of an inline variation.","example":"+1-555-0100"},"body":{"type":"string","description":"The content of a block variation in HTML.","example":"<p>You can request a refund within 30 days of purchase.</p>"},"intentionally_empty":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make the variation show nothing instead of falling back to the default content. Any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent with it is ignored."},"children":[]}]}]}],"default":false,"example":false}}}},"components/schemas/dynamic_content_create_request":{"id":"components/schemas/dynamic_content_create_request","kind":"json-schema","title":"Create Dynamic Content Request","data":{"title":"Create Dynamic Content Request","type":"object","description":"The request payload for creating dynamic content.","nullable":false,"required":["name","content_type","default_locale","variations"],"properties":{"name":{"type":"string","description":"The name of the dynamic content. Must be unique in the workspace.","maxLength":255,"example":"Support phone number"},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the dynamic content is a short inline value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or one or more blocks of content ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Can't be changed later."},"children":[]}]}]}],"enum":["inline","block"],"example":"inline"},"default_locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale whose variation is used when there's no variation for the requested locale. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include a variation for this locale that applies to all brands."},"children":[]}]}]}],"example":"en"},"variations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The variations of the dynamic content, one per locale and optionally per brand. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brand_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a variation to override the all-brands value for that brand. At least one is required."},"children":[]}]}]}],"minItems":1,"items":{"$ref":"#/components/schemas/dynamic_content_variation_request"}}}}},"components/schemas/dynamic_content_update_request":{"id":"components/schemas/dynamic_content_update_request","kind":"json-schema","title":"Update Dynamic Content Request","data":{"title":"Update Dynamic Content Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for updating dynamic content. All fields are optional — only provided fields are updated."},"children":[]}]}]}],"nullable":false,"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the dynamic content. Must be unique in the workspace. Renaming doesn't change the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"example":"Support phone number"},"default_locale":{"type":"string","description":"The locale whose variation is used when there's no variation for the requested locale. The dynamic content must have a variation for this locale that applies to all brands.","example":"en"},"variations":{"type":"array","description":"The full set of variations. Existing variations that aren't included are deleted.","minItems":1,"items":{"$ref":"#/components/schemas/dynamic_content_variation_request"}}}}},"components/schemas/content_search_article_content_item":{"id":"components/schemas/content_search_article_content_item","kind":"json-schema","title":"Content Search Article Content Item","data":{"title":"Content Search Article Content Item","type":"object","description":"A single locale variant of a help center article returned from Knowledge Hub search.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["article_content"],"example":"article_content"},"id":{"type":"string","description":"The unique identifier of the article content.","example":"678"},"title":{"type":"string","description":"The localized title of the article.","example":"Billing FAQ"},"locale":{"type":"string","description":"The locale of this article content.","example":"en"}}}},"components/schemas/content_search_article_item":{"id":"components/schemas/content_search_article_item","kind":"json-schema","title":"Content Search Article Item","data":{"title":"Content Search Article Item","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A help center article result from Knowledge Hub search, with one nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry per locale."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"article"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["article"],"example":"article"},"id":{"type":"string","description":"The unique identifier of the article.","example":"345"},"title":{"type":"string","description":"The article's canonical title.","example":"Billing FAQ"},"contents":{"type":"array","description":"One entry per locale of the article.","items":{"$ref":"#/components/schemas/content_search_article_content_item"}}}}},"components/schemas/content_search_default_item":{"id":"components/schemas/content_search_default_item","kind":"json-schema","title":"Content Search Default Item","data":{"title":"Content Search Default Item","type":"object","description":"The flat result shape returned from Knowledge Hub search for content snippets, external pages, uploaded files, and internal articles.","required":["type"],"properties":{"type":{"type":"string","description":"The kind of content item.","enum":["content_snippet","external_content","file_source_content","internal_article"],"example":"content_snippet"},"id":{"type":"string","description":"The unique identifier of the content item.","example":"123"},"title":{"type":"string","description":"The display title of the content item.","example":"Billing FAQ"}}}},"components/schemas/content_search_response":{"id":"components/schemas/content_search_response","kind":"json-schema","title":"Content Search Response","data":{"title":"Content Search Response","type":"object","description":"A paginated list of Knowledge Hub content results matching a search query.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"total_count":{"type":"integer","description":"Total number of results matching the query.","example":5},"pages":{"type":"object","description":"Pagination metadata, including links to neighbouring pages.","properties":{"type":{"type":"string","enum":["pages"],"example":"pages"},"page":{"type":"integer","description":"The current page number.","example":1},"per_page":{"type":"integer","description":"Number of results per page.","example":10},"total_pages":{"type":"integer","description":"Total number of pages of results.","example":1},"next":{"type":"string","format":"uri","description":"A link to the next page of results. Omitted when on the last page.","example":"https://api.intercom.io/content/search?query=billing&per_page=10&page=2"},"prev":{"type":"string","format":"uri","description":"A link to the previous page of results. Omitted when on the first page.","example":"https://api.intercom.io/content/search?query=billing&per_page=10&page=1"}}},"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of matched content items. Each item's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines its shape."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/content_search_result"}}}}},"components/schemas/content_search_result":{"id":"components/schemas/content_search_result","kind":"json-schema","title":"Content Search Result","data":{"title":"Content Search Result","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single search result. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field discriminates between the flat shape used for snippets, external pages, files, and internal articles, and the nested shape used for help center articles."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/content_search_default_item"},{"$ref":"#/components/schemas/content_search_article_item"}],"discriminator":{"propertyName":"type","mapping":{"content_snippet":"#/components/schemas/content_search_default_item","external_content":"#/components/schemas/content_search_default_item","file_source_content":"#/components/schemas/content_search_default_item","internal_article":"#/components/schemas/content_search_default_item","article":"#/components/schemas/content_search_article_item"}}}},"components/schemas/conversation_list_item":{"id":"components/schemas/conversation_list_item","kind":"json-schema","title":"Conversation List Item","data":{"title":"Conversation List Item","type":"object","x-tags":["Conversations"],"description":"The data returned about your conversations when you list or search them.","properties":{"type":{"type":"string","description":"Always conversation.","example":"conversation"},"id":{"type":"string","description":"The id representing the conversation.","example":"1295"},"title":{"type":"string","nullable":true,"description":"The title given to the conversation.","example":"Conversation Title"},"created_at":{"type":"integer","format":"date-time","description":"The time the conversation was created.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the conversation was updated.","example":1663597260},"waiting_since":{"type":"integer","format":"date-time","nullable":true,"description":"The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.","example":1663597260},"snoozed_until":{"type":"integer","format":"date-time","nullable":true,"description":"If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.","example":1663597260},"open":{"type":"boolean","description":"Indicates whether a conversation is open (true) or closed (false).","example":true},"state":{"type":"string","enum":["open","closed","snoozed"],"description":"Can be set to \"open\", \"closed\" or \"snoozed\".","example":"open"},"read":{"type":"boolean","description":"Indicates whether a conversation has been read.","example":true},"priority":{"type":"string","enum":["none","low","medium","high","urgent"],"description":"The priority level of the conversation. Returns one of none, low, medium, high, or urgent.","example":"high"},"admin_assignee_id":{"type":"integer","description":"The id of the admin assigned to the conversation. If it's not assigned to an admin it will return 0.","example":0},"team_assignee_id":{"type":"integer","description":"The id of the team assigned to the conversation. If it's not assigned to a team it will return 0.","example":5017691},"company":{"$ref":"#/components/schemas/company","nullable":true,"description":"The company associated with the conversation."},"tags":{"$ref":"#/components/schemas/tags"},"conversation_rating":{"$ref":"#/components/schemas/conversation_rating"},"source":{"$ref":"#/components/schemas/conversation_source"},"contacts":{"$ref":"#/components/schemas/conversation_contacts"},"teammates":{"$ref":"#/components/schemas/conversation_teammates"},"custom_attributes":{"$ref":"#/components/schemas/custom_attributes"},"first_contact_reply":{"$ref":"#/components/schemas/conversation_first_contact_reply"},"sla_applied":{"$ref":"#/components/schemas/sla_applied"},"statistics":{"$ref":"#/components/schemas/conversation_statistics"},"linked_objects":{"$ref":"#/components/schemas/linked_object_list"},"ai_agent_participated":{"type":"boolean","description":"Indicates whether the AI Agent participated in the conversation.","example":true},"ai_agent":{"$ref":"#/components/schemas/ai_agent","nullable":true},"sales_agent_participated":{"type":"boolean","description":"Indicates whether the Sales Agent participated in the conversation.","example":false},"sales_agent":{"$ref":"#/components/schemas/sales_agent","nullable":true},"channel":{"allOf":[{"$ref":"#/components/schemas/conversation_channel"}],"type":"object","nullable":true,"description":"The channel through which the conversation was initiated and its current channel."},"topics":{"type":"object","description":"The topics of the conversation. An empty object when the workspace doesn't use topics.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topic.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"topic.list"},"topics":{"type":"array","description":"The topics of the conversation.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"topic"},"id":{"type":"integer","description":"The id of the topic.","example":4521},"name":{"type":"string","description":"The name of the topic.","example":"Billing"}}}},"total_count":{"type":"integer","description":"The number of topics.","example":1}}},"ticket":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ticket details when the conversation is a ticket. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for any other conversation."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ticket"},"id":{"type":"integer","description":"The id of the ticket's conversation.","example":1295},"url":{"type":"string","description":"The link to the ticket in the inbox.","example":"https://app.intercom.com/a/apps/abcd1234/conversations/1295"},"custom_attributes":{"type":"object","description":"The ticket's attributes, keyed by attribute name.","additionalProperties":{"type":"object","properties":{"value":{"description":"The value of the attribute.","anyOf":[{"type":"string","nullable":true},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"integer"}},{"$ref":"#/components/schemas/file_attribute"}]},"type":{"type":"string","description":"The data type of the attribute.","example":"string"}}}},"state":{"type":"string","description":"The current state of the ticket.","example":"submitted"},"ticket_type":{"type":"string","description":"The name of the ticket type.","example":"Bug report"},"ticket_type_description":{"type":"string","description":"The description of the ticket type.","example":"Something is broken"},"ticket_type_emoji":{"type":"string","nullable":true,"description":"The emoji of the ticket type.","example":"🐛"},"ticket_custom_state_admin_label":{"type":"string","nullable":true,"description":"The label of the ticket's state as teammates see it.","example":"Submitted"},"ticket_custom_state_user_label":{"type":"string","nullable":true,"description":"The label of the ticket's state as the customer sees it.","example":"Received"}}},"external_references":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References linking this conversation to records in an external helpdesk or CRM system. Populated for Fin Standalone workspaces synced from an external platform; an empty array otherwise. Sorted alphabetically by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and capped at 20 entries."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_external_reference"},"example":[{"type":"zendesk_ticket","id":"3633338"},{"type":"zendesk_sunshine_conversation","id":"abc-def-uuid"}]},"monitor_evaluations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest QA monitor evaluation for each monitor that has evaluated this conversation, whatever its result. Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_monitors=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed as a query parameter."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_monitor_evaluation"}},"scorecards":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QA scorecard results for this conversation. Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_scorecards=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed as a query parameter."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_scorecard"}}}}},"components/schemas/conversation":{"id":"components/schemas/conversation","kind":"json-schema","title":"Conversation","data":{"title":"Conversation","type":"object","x-tags":["Conversations"],"description":"Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.","properties":{"type":{"type":"string","description":"Always conversation.","example":"conversation"},"id":{"type":"string","description":"The id representing the conversation.","example":"1295"},"title":{"type":"string","nullable":true,"description":"The title given to the conversation.","example":"Conversation Title"},"created_at":{"type":"integer","format":"date-time","description":"The time the conversation was created.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the conversation was updated.","example":1663597260},"waiting_since":{"type":"integer","format":"date-time","nullable":true,"description":"The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.","example":1663597260},"snoozed_until":{"type":"integer","format":"date-time","nullable":true,"description":"If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.","example":1663597260},"open":{"type":"boolean","description":"Indicates whether a conversation is open (true) or closed (false).","example":true},"state":{"type":"string","enum":["open","closed","snoozed"],"description":"Can be set to \"open\", \"closed\" or \"snoozed\".","example":"open"},"read":{"type":"boolean","description":"Indicates whether a conversation has been read.","example":true},"priority":{"type":"string","enum":["none","low","medium","high","urgent"],"description":"The priority level of the conversation. Returns one of none, low, medium, high, or urgent.","example":"high"},"admin_assignee_id":{"type":"integer","description":"The id of the admin assigned to the conversation. If it's not assigned to an admin it will return 0.","example":0},"team_assignee_id":{"type":"integer","description":"The id of the team assigned to the conversation. If it's not assigned to a team it will return 0.","example":5017691},"company":{"$ref":"#/components/schemas/company","nullable":true,"description":"The company associated with the conversation."},"tags":{"$ref":"#/components/schemas/tags"},"conversation_rating":{"$ref":"#/components/schemas/conversation_rating"},"source":{"$ref":"#/components/schemas/conversation_source"},"contacts":{"$ref":"#/components/schemas/conversation_contacts"},"teammates":{"$ref":"#/components/schemas/conversation_teammates"},"custom_attributes":{"$ref":"#/components/schemas/custom_attributes"},"first_contact_reply":{"$ref":"#/components/schemas/conversation_first_contact_reply"},"sla_applied":{"$ref":"#/components/schemas/sla_applied"},"statistics":{"$ref":"#/components/schemas/conversation_statistics"},"conversation_parts":{"$ref":"#/components/schemas/conversation_parts"},"linked_objects":{"$ref":"#/components/schemas/linked_object_list"},"ai_agent_participated":{"type":"boolean","description":"Indicates whether the AI Agent participated in the conversation.","example":true},"ai_agent":{"$ref":"#/components/schemas/ai_agent","nullable":true},"sales_agent_participated":{"type":"boolean","description":"Indicates whether the Sales Agent participated in the conversation.","example":false},"sales_agent":{"$ref":"#/components/schemas/sales_agent","nullable":true},"channel":{"allOf":[{"$ref":"#/components/schemas/conversation_channel"}],"type":"object","nullable":true,"description":"The channel through which the conversation was initiated and its current channel."},"external_references":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References linking this conversation to records in an external helpdesk or CRM system. Populated for Fin Standalone workspaces synced from an external platform; an empty array otherwise. Sorted alphabetically by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and capped at 20 entries."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_external_reference"},"example":[{"type":"zendesk_ticket","id":"3633338"},{"type":"zendesk_sunshine_conversation","id":"abc-def-uuid"}]},"monitor_evaluations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest QA monitor evaluation for each monitor that has evaluated this conversation, whatever its result. Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_monitors=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed as a query parameter."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_monitor_evaluation"}},"scorecards":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QA scorecard results for this conversation. Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_scorecards=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed as a query parameter."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/conversation_scorecard"}}}}},"components/schemas/conversation_attachment_files":{"id":"components/schemas/conversation_attachment_files","kind":"json-schema","title":"Conversation attachment files","data":{"title":"Conversation attachment files","type":"object","description":"Properties of the attachment files in a conversation part","properties":{"content_type":{"type":"string","description":"The content type of the file","example":"application/json"},"data":{"type":"string","description":"The base64 encoded file data.","example":"ewogICJ0ZXN0IjogMQp9"},"name":{"type":"string","description":"The name of the file.","example":"test.json"}}}},"components/schemas/conversation_channel":{"id":"components/schemas/conversation_channel","kind":"json-schema","title":"Conversation Channel","data":{"title":"Conversation Channel","type":"object","description":"The channel through which a conversation was originally initiated and its current channel.","properties":{"initial":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The channel through which the conversation was originally initiated. Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messenger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zendesk_sunshine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zendesk_ticket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twitter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if channel data is unavailable."},"children":[]}]}]}],"example":"messenger"},"current":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current channel of the conversation. May differ from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the conversation was migrated between channels. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if channel data is unavailable."},"children":[]}]}]}],"example":"messenger"}}}},"components/schemas/conversation_external_reference":{"id":"components/schemas/conversation_external_reference","kind":"json-schema","title":"Conversation External Reference","data":{"title":"Conversation External Reference","type":"object","description":"A reference linking a conversation to a record in an external helpdesk or CRM system, surfaced for Fin Standalone workspaces.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of external system the reference points to. Possible values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zendesk_ticket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zendesk_sunshine_conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salesforce_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salesforce_in_app_message_conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freshdesk_ticket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freshchat_conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hubspot_conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_helpdesk_conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"zendesk_ticket"},"id":{"type":"string","description":"The identifier of the record in the external system. Always serialized as a string, since some external IDs exceed 32-bit integer range.","example":"3633338"}}}},"components/schemas/conversation_monitor_evaluation":{"id":"components/schemas/conversation_monitor_evaluation","kind":"json-schema","title":"Conversation Monitor Evaluation","data":{"title":"Conversation Monitor Evaluation","type":"object","x-tags":["Conversations"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A QA monitor evaluation of this conversation. Returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitor_evaluations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on conversation responses when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_monitors=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]}]}]}],"properties":{"monitor_id":{"type":"string","description":"The unique identifier of the monitor that produced this evaluation.","example":"12345"},"monitor_name":{"type":"string","nullable":true,"description":"The name of the monitor at the time of evaluation. Null if the monitor has since been deleted.","example":"Customer complaint handling"},"monitor_type":{"type":"string","nullable":true,"description":"The type of the monitor. Null if the monitor has since been deleted.","example":"prompt"},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The evaluation outcome reported by the monitor: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"included"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the conversation matches the monitor's criteria), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_async_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"included"},"explanation":{"type":"string","nullable":true,"description":"The reasoning provided by the monitor for its result. May be null if no reasoning was generated.","example":"The customer mentioned wanting a refund without resolution."},"evaluated_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time the monitor evaluated this conversation. Null in the rare case the underlying record's timestamp is not yet set.","example":1719493065}}}},"components/schemas/conversation_scorecard":{"id":"components/schemas/conversation_scorecard","kind":"json-schema","title":"Conversation Scorecard","data":{"title":"Conversation Scorecard","type":"object","x-tags":["Conversations"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A QA scorecard result for this conversation. Returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scorecards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array on conversation responses when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_scorecards=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]}]}]}],"properties":{"scorecard_id":{"type":"string","description":"The unique identifier of the scorecard definition.","example":"67890"},"name":{"type":"string","description":"The name of the scorecard.","example":"Standard QA Review"},"scorecard_type":{"type":"string","description":"The type of scorecard.","example":"human"},"passed":{"type":"boolean","nullable":true,"description":"Whether the conversation passed the scorecard. Null when the scorecard has not been scored.","example":true},"score":{"type":"number","nullable":true,"description":"The numeric score for the scorecard. Null when the scorecard has not been scored.","example":0.85},"ai_score":{"type":"number","nullable":true,"description":"The numeric score produced by AI evaluation, if applicable. Null when not AI-scored.","example":0.9},"evaluated_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time the scorecard was last evaluated. Null in the rare case the underlying record's timestamp is not yet set.","example":1719493065},"reviewed_teammate":{"$ref":"#/components/schemas/conversation_scorecard_reviewed_teammate"},"reviewer":{"$ref":"#/components/schemas/conversation_scorecard_reviewer"},"review_status":{"type":"string","nullable":true,"enum":["unreviewed","submitted","passed_review","needs_fix","wont_fix","fix_complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the review of this scorecard, as shown in the QA reviews list in Intercom. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unreviewed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the review is waiting for a reviewer's verdict; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the review has been submitted; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passed_review"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"needs_fix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wont_fix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fix_complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a teammate set a specific outcome. Null when no review exists for this scorecard."},"children":[]}]}]}],"example":"submitted"},"submitted_by":{"$ref":"#/components/schemas/conversation_scorecard_submitted_by"},"revised_by":{"$ref":"#/components/schemas/conversation_scorecard_revised_by"},"notes":{"type":"array","description":"The notes teammates left on the QA review linked to this scorecard entry. Empty when the scorecard has no linked review.","example":[{"id":"9001","created_at":1734537900,"updated_at":1734537900,"author":{"type":"admin","admin_id":"884120017"},"body":"Great empathy in the second reply."}],"items":{"$ref":"#/components/schemas/conversation_scorecard_note"}},"evaluators":{"type":"array","description":"Per-evaluator results within this scorecard.","items":{"$ref":"#/components/schemas/conversation_scorecard_evaluator"}}}}},"components/schemas/conversation_scorecard_reviewer":{"id":"components/schemas/conversation_scorecard_reviewer","kind":"json-schema","title":"Reviewer","data":{"title":"Reviewer","type":"object","nullable":true,"x-tags":["Conversations"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who the review of this scorecard is assigned to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is assigned to Fin; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is assigned to a teammate. Null when no review exists for this scorecard or the review is unassigned."},"children":[]}]}]}],"properties":{"type":{"type":"string","enum":["ai","admin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of reviewer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the review is assigned to Fin; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it is assigned to a teammate."},"children":[]}]}]}],"example":"admin"},"admin_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the admin the review is assigned to. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"884120017"}}}},"components/schemas/conversation_scorecard_submitted_by":{"id":"components/schemas/conversation_scorecard_submitted_by","kind":"json-schema","title":"Submitted By","data":{"title":"Submitted By","type":"object","nullable":true,"x-tags":["Conversations"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who last submitted the review of this scorecard, which can differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is assigned to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Fin submitted it; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a teammate did. Null while the review is unreviewed or when no review exists for this scorecard."},"children":[]}]}]}],"properties":{"type":{"type":"string","enum":["ai","admin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of submitter. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if Fin submitted the review; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a teammate did."},"children":[]}]}]}],"example":"admin"},"admin_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the admin who submitted the review. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"884120017"}}}},"components/schemas/conversation_scorecard_revised_by":{"id":"components/schemas/conversation_scorecard_revised_by","kind":"json-schema","title":"Revised By","data":{"title":"Revised By","type":"object","nullable":true,"x-tags":["Conversations"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who last changed the review of this scorecard after it was submitted. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Fin made the change; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a teammate did. Null while the review is unreviewed, when it has not been changed since it was submitted, or when no review exists for this scorecard."},"children":[]}]}]}],"properties":{"type":{"type":"string","enum":["ai","admin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of reviser. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if Fin changed the review; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a teammate did."},"children":[]}]}]}],"example":"admin"},"admin_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the admin who last changed the review. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"884120017"}}}},"components/schemas/conversation_scorecard_note":{"id":"components/schemas/conversation_scorecard_note","kind":"json-schema","title":"Scorecard Note","data":{"title":"Scorecard Note","type":"object","x-tags":["Conversations"],"description":"A note a teammate left on the QA review of this scorecard.","properties":{"id":{"type":"string","description":"The id of the note.","example":"9001"},"created_at":{"type":"integer","format":"date-time","description":"The time the note was created.","example":1734537900},"updated_at":{"type":"integer","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time the note was last edited. Equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the note has never been edited."},"children":[]}]}]}],"example":1734537900},"author":{"$ref":"#/components/schemas/conversation_scorecard_note_author"},"body":{"type":"string","description":"The text of the note exactly as the teammate entered it. Plain text; it is not rendered as HTML.","example":"Great empathy in the second reply."}}}},"components/schemas/conversation_scorecard_note_author":{"id":"components/schemas/conversation_scorecard_note_author","kind":"json-schema","title":"Note Author","data":{"title":"Note Author","type":"object","nullable":true,"x-tags":["Conversations"],"description":"Who wrote the note. Null when the teammate who wrote it has since been deleted.","properties":{"type":{"type":"string","enum":["ai","admin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of author. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a teammate wrote the note; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Fin did."},"children":[]}]}]}],"example":"admin"},"admin_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the admin who wrote the note. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"884120017"}}}},"components/schemas/conversation_scorecard_reviewed_teammate":{"id":"components/schemas/conversation_scorecard_reviewed_teammate","kind":"json-schema","title":"Reviewed Teammate","data":{"title":"Reviewed Teammate","type":"object","x-tags":["Conversations"],"description":"The teammate (or AI agent) whose handling of the conversation was reviewed by this scorecard.","properties":{"type":{"type":"string","enum":["ai","admin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of reviewee. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the conversation was handled by Fin or scored without a specific teammate; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a specific teammate was reviewed."},"children":[]}]}]}],"example":"admin"},"admin_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the admin who was reviewed. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"991267715"}}}},"components/schemas/conversation_scorecard_evaluator":{"id":"components/schemas/conversation_scorecard_evaluator","kind":"json-schema","title":"Conversation Scorecard Evaluator","data":{"title":"Conversation Scorecard Evaluator","type":"object","x-tags":["Conversations"],"description":"A single evaluator within a scorecard, including its result for this conversation.","properties":{"evaluator_id":{"type":"string","description":"The unique identifier of the evaluator (criterion) within the scorecard.","example":"54321"},"name":{"type":"string","nullable":true,"description":"The name of the evaluator (criterion). Null if the evaluator's name could not be resolved.","example":"Tone of voice"},"result":{"allOf":[{"$ref":"#/components/schemas/conversation_scorecard_evaluator_result"}],"nullable":true,"description":"The evaluator's result for this conversation. Null if the evaluator was not scored."}}}},"components/schemas/conversation_scorecard_evaluator_result":{"id":"components/schemas/conversation_scorecard_evaluator_result","kind":"json-schema","title":"Conversation Scorecard Evaluator Result","data":{"title":"Conversation Scorecard Evaluator Result","type":"object","x-tags":["Conversations"],"description":"The outcome of a single evaluator within a scorecard.","properties":{"value":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The evaluator's selected value (typically a label such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a category identifier)."},"children":[]}]}]}],"example":"pass"},"value_label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label of the rating option matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Needs improvement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Omitted when the label could not be resolved."},"children":[]}]}]}],"example":"Pass"},"source":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origin of the result (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"ai"},"reasoning":{"type":"string","nullable":true,"description":"A free-text explanation of the result.","example":"The agent acknowledged the issue and resolved it within the same response."},"reasons":{"type":"array","description":"The structured reasons chosen for this result. Omitted when none were chosen.","items":{"$ref":"#/components/schemas/conversation_scorecard_evaluator_reason"},"example":[{"name":"Clear and concise"},{"name":"Empathetic tone"}]},"other_text":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text entered by the reviewer to supplement or stand in for the structured "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — typically captured when the reviewer selects an \"Other\" option or adds a custom note. Null when not provided."},"children":[]}]}]}],"example":"Agent acknowledged the issue but missed the follow-up question about billing."}}}},"components/schemas/conversation_scorecard_evaluator_reason":{"id":"components/schemas/conversation_scorecard_evaluator_reason","kind":"json-schema","title":"Evaluator Reason","data":{"title":"Evaluator Reason","type":"object","x-tags":["Conversations"],"description":"A single structured reason assigned to an evaluator's result.","properties":{"name":{"type":"string","nullable":true,"description":"The name of the reason. Null if the reason's name could not be resolved.","example":"Clear and concise"}}}},"components/schemas/conversation_contacts":{"id":"components/schemas/conversation_contacts","kind":"json-schema","title":"Contacts","data":{"title":"Contacts","type":"object","description":"The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.","properties":{"type":{"type":"string","description":"","enum":["contact.list"],"example":"contact.list"},"contacts":{"type":"array","description":"The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.","items":{"$ref":"#/components/schemas/contact_reference"}}}}},"components/schemas/conversation_deleted":{"id":"components/schemas/conversation_deleted","kind":"json-schema","title":"Conversation Deleted","data":{"title":"Conversation Deleted","type":"object","description":"deleted conversation object","properties":{"id":{"type":"string","description":"The unique identifier for the conversation.","example":"5ba682d23d7cf92bef87bfd4"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the deleted item is a ticket."},"children":[]}]}]}],"enum":["conversation","ticket"],"example":"conversation"},"deleted":{"type":"boolean","description":"Whether the conversation is deleted or not.","example":true}}}},"components/schemas/deleted_conversation_item":{"id":"components/schemas/deleted_conversation_item","kind":"json-schema","title":"Conversation","data":{"title":"Conversation","type":"object","x-tags":["Conversation"],"description":"A deleted conversation record containing its ID, metrics retained status and deletion timestamp.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"conversation"},"id":{"type":"string","description":"The ID of the deleted conversation.","example":"512"},"metrics_retained":{"type":"boolean","description":"Whether reporting metrics are retained for this conversation ID","example":true},"deleted_at":{"type":"integer","format":"date-time","description":"The time when the conversation was deleted.","example":1734537745}}}},"components/schemas/create_conversation_stream_token_request":{"id":"components/schemas/create_conversation_stream_token_request","kind":"json-schema","title":"Create conversation stream token request","data":{"title":"Create conversation stream token request","type":"object","required":["external_id"],"properties":{"external_id":{"type":"string","description":"The external ID of the contact to issue a token for.","example":"contact-1234"}}}},"components/schemas/conversation_stream_token":{"id":"components/schemas/conversation_stream_token","kind":"json-schema","title":"Conversation stream token","data":{"title":"Conversation stream token","type":"object","x-tags":["Conversations"],"description":"A token that lets a contact's client subscribe to a realtime stream of their conversation events.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_stream_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["conversation_stream_token"],"example":"conversation_stream_token"},"expires_at":{"type":"integer","format":"date-time","description":"The time the token expires, as a UNIX timestamp.","example":1731241200},"stream":{"type":"object","description":"What the client needs to connect to the stream.","properties":{"provider":{"type":"string","description":"The realtime provider that delivers the stream.","example":"ably"},"url":{"type":"string","description":"The host to connect to.","example":"main.realtime.ably.net"},"channel":{"type":"string","description":"The channel to subscribe to.","example":"conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0"},"token":{"type":"string","description":"The token to connect with.","example":"<stream token>"}}},"links":{"type":"object","description":"The requests you can make with this token.","properties":{"self":{"type":"object","description":"The request that issues a new token for the contact.","properties":{"href":{"type":"string","description":"The URL to request.","example":"https://api.intercom.io/conversations/stream/token"},"method":{"type":"string","description":"The HTTP method to use.","example":"POST"}}},"revoke":{"type":"object","description":"The request that revokes every active token for the contact.","properties":{"href":{"type":"string","description":"The URL to request.","example":"https://api.intercom.io/conversations/stream/token?external_id=contact-1234"},"method":{"type":"string","description":"The HTTP method to use.","example":"DELETE"}}}}}}}},"components/schemas/deleted_conversation_list":{"id":"components/schemas/deleted_conversation_list","kind":"json-schema","title":"Conversations","data":{"title":"Conversations","type":"object","description":"A paginated list of deleted conversation IDs.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversations.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"conversations.list"},"conversations":{"type":"array","description":"The list of deleted conversation IDs.","items":{"$ref":"#/components/schemas/deleted_conversation_item"}},"total_count":{"type":"integer","description":"Total number of items available.","example":10},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"components/schemas/conversation_first_contact_reply":{"id":"components/schemas/conversation_first_contact_reply","kind":"json-schema","title":"First contact reply","data":{"title":"First contact reply","type":"object","nullable":true,"description":"An object containing information on the first users message. For a contact initiated message this will represent the users original message.","properties":{"created_at":{"type":"integer","format":"date-time","description":"","example":1663597223},"type":{"type":"string","description":"","example":"conversation"},"url":{"type":"string","nullable":true,"description":"","example":"https://developers.intercom.com/"}}}},"components/schemas/conversation_list":{"id":"components/schemas/conversation_list","kind":"json-schema","title":"Conversation List","data":{"title":"Conversation List","type":"object","description":"Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.","properties":{"type":{"type":"string","description":"Always conversation.list","enum":["conversation.list"],"example":"conversation.list"},"conversations":{"type":"array","description":"The list of conversation objects","items":{"$ref":"#/components/schemas/conversation_list_item"}},"total_count":{"type":"integer","description":"A count of the total number of objects.","example":12345},"pages":{"$ref":"#/components/schemas/cursor_pages"}}}},"components/schemas/conversation_part":{"id":"components/schemas/conversation_part","kind":"json-schema","title":"Conversation Part","data":{"title":"Conversation Part","type":"object","description":"A Conversation Part represents a message in the conversation.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always conversation_part"},"children":[]}]}]}],"example":"conversation_part"},"id":{"type":"string","description":"The id representing the conversation part.","example":"3"},"part_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of conversation part. A part type this version does not recognise is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; versions before 2.18 return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those parts. Every value other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also accepted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_part_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_part_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters when retrieving a conversation."},"children":[]}]}]}],"example":"comment"},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text."},"children":[]}]}]}],"example":"<p>Okay!</p>"},"created_at":{"type":"integer","format":"date-time","description":"The time the conversation part was created.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the conversation part was updated.","example":1663597260},"notified_at":{"type":"integer","format":"date-time","description":"The time the user was notified with the conversation part.","example":1663597260},"user_ip":{"type":"string","nullable":true,"description":"The IP address of the end user who authored this conversation part, when available. Null otherwise, including for parts not authored by an end user.","example":"203.0.113.42"},"assigned_to":{"$ref":"#/components/schemas/reference","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assignee this conversation_part assigned the conversation to, as a reference whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the part unassigned the conversation, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nobody_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Null when the part did not change the assignment, or when the assignee has since been deleted."},"children":[]}]}]}]},"admin_assignee_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the teammate that this conversation_part assigned the conversation to, or 0 if the part removed the teammate. Null or absent when the part did not change the teammate, including an unassignment that did not name which assignee it cleared. A bot is reported here, because assignment treats anything that is not a team as a teammate."},"children":[]}]}]}],"example":991267715},"team_assignee_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the team that this conversation_part assigned the conversation to, or 0 if the part removed the team. Null or absent when the part did not change the team, including an unassignment that did not name which assignee it cleared. A part can assign a team and a teammate at the same time, for example when the team uses Round Robin distribution and the teammate is resolved inline. In that case assigned_to reports only the teammate, and these two fields report each assignee separately."},"children":[]}]}]}],"example":5017691},"author":{"$ref":"#/components/schemas/conversation_part_author"},"attachments":{"title":"Conversation part attachments","type":"array","description":"A list of attachments for the part.","items":{"$ref":"#/components/schemas/part_attachment"}},"external_id":{"type":"string","nullable":true,"description":"The external id of the conversation part","example":"abcd1234"},"redacted":{"type":"boolean","description":"Whether or not the conversation part has been redacted.","example":false},"receipts":{"type":"object","nullable":true,"description":"What happened to this part for each recipient it was sent to. Null when delivery receipts have not been recorded for this part.","properties":{"overall_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the part across all recipients. The worst recipient state wins, except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partially_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which means some recipients have it and others do not."},"children":[]}]}]}],"enum":["failed_to_send","sending","sent","seen","partially_sent"],"example":"sent"},"recipients":{"type":"array","description":"One entry per recipient the part was sent to, in send order.","items":{"type":"object","properties":{"participant_id":{"type":"string","description":"The id of the recipient, a contact id or an admin id.","example":"6762f0dd1bb69f9f2193bb83"},"participant_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the recipient is a contact ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a teammate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["user","admin"],"example":"user"},"state":{"type":"string","description":"The delivery state for this recipient.","enum":["sending","sent","seen","failed_to_send"],"example":"sent"},"channel":{"type":"string","description":"The channel the part was sent on.","example":"email"},"state_updated_at":{"type":"integer","format":"date-time","description":"The time the state last changed, as a UTC Unix timestamp.","example":1663597223},"error_code":{"type":"string","nullable":true,"description":"The reason Intercom could not send to this recipient, when it could not. Null otherwise.","enum":["email_address_ignored","user_suppressed","user_marked_as_spam","user_mailbox_full_suppressed","user_bounced","user_not_contactable","banned_domain","reply_to_sender_only","suppress_cc_emails","unverified_cc_recipient",null],"example":"user_bounced"},"address":{"type":"string","nullable":true,"description":"The email address the part was sent to, for contact recipients. Null for teammates or when it is not known.","example":"joe@example.com"}}}}}},"email_message_metadata":{"$ref":"#/components/schemas/email_message_metadata","nullable":true},"metadata":{"$ref":"#/components/schemas/conversation_part_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."},"translations":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of the reply text keyed by locale code. Backs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation.admin.replied.translated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook topic. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"original"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the locale code the reply was written in, when it is known; every other key holds the reply translated into that locale."},"children":[]}]}]}],"properties":{"original":{"type":"string","description":"The locale code identifying the language the reply was originally written in.","example":"en"}},"additionalProperties":{"type":"string"},"example":{"original":"en","en":"<p>Hello</p>","fr":"<p>Bonjour</p>"}}}}},"components/schemas/conversation_part_author":{"id":"components/schemas/conversation_part_author","kind":"json-schema","title":"Conversation part author","data":{"title":"Conversation part author","type":"object","description":"The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.","properties":{"type":{"type":"string","description":"The type of the author","example":"admin"},"id":{"type":"string","description":"The id of the author","example":"274"},"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the author. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the author is a contact that has since been archived or deleted."},"children":[]}]}]}],"example":"Operator"},"email":{"type":"string","format":"email","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email of the author. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the author is a contact that has since been archived or deleted."},"children":[]}]}]}],"example":"operator+abcd1234@intercom.io"},"from_ai_agent":{"type":"boolean","description":"If this conversation part was sent by the AI Agent","example":true},"is_ai_answer":{"type":"boolean","description":"If this conversation part body was generated by the AI Agent","example":false}}}},"components/schemas/conversation_parts":{"id":"components/schemas/conversation_parts","kind":"json-schema","title":"Conversation Parts","data":{"title":"Conversation Parts","type":"object","description":"A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.","properties":{"type":{"type":"string","description":"","enum":["conversation_part.list"],"example":"conversation_part.list"},"conversation_parts":{"title":"Conversation Parts","type":"array","description":"A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.","items":{"$ref":"#/components/schemas/conversation_part"}},"total_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A count of the conversation parts in this response, after any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_part_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_part_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter has been applied. When paginating, this is the number of parts on the current page. This is not the conversation's total part count."},"children":[]}]}]}],"example":1},"pages":{"allOf":[{"$ref":"#/components/schemas/pages_link"}],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination details for the conversation parts. Only returned when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is sent. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null on the last page."},"children":[]}]}]}]}}}},"components/schemas/conversation_part_metadata":{"id":"components/schemas/conversation_part_metadata","kind":"json-schema","title":"Conversation Part Metadata","data":{"title":"Conversation Part Metadata","description":"Metadata for a conversation part","type":"object","properties":{"quick_reply_options":{"type":"array","description":"The quick reply options sent by the Admin or bot, presented in this conversation part.","items":{"allOf":[{"$ref":"#/components/schemas/quick_reply_option"}],"properties":{"translations":{"type":"object","nullable":true,"description":"The translations for the quick reply option.","example":{"en":"Hello","fr":"Bonjour"}}}}},"quick_reply_option_uuid":{"type":"string","format":"uuid","description":"The unique identifier for the quick reply option that was clicked by the end user.","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"components/schemas/conversation_rating":{"id":"components/schemas/conversation_rating","kind":"json-schema","title":"Conversation Rating","data":{"title":"Conversation Rating","type":"object","nullable":true,"description":"The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.","properties":{"rating":{"type":"integer","description":"The rating, between 1 and 5, for the conversation.","example":5},"remark":{"type":"string","description":"An optional field to add a remark to correspond to the number rating","example":""},"created_at":{"type":"integer","format":"date-time","description":"The time the rating was requested in the conversation being rated.","example":1671028894},"updated_at":{"type":"integer","format":"date-time","description":"The time the rating was last updated.","example":1671028894},"contact":{"$ref":"#/components/schemas/contact_reference"},"teammate":{"title":"Conversation Rating Teammate","type":"object","nullable":true,"description":"The teammate, bot or workflow the rating is attributed to.","properties":{"type":{"type":"string","enum":["admin","team","bot","workflow"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the rated actor. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workflow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a workflow requested the rating and no teammate took part."},"children":[]}]}]}],"example":"admin"},"id":{"type":"string","description":"The unique identifier for the rated actor.","example":"123"}}}}}},"components/schemas/conversation_response_time":{"id":"components/schemas/conversation_response_time","kind":"json-schema","title":"Conversation response time","data":{"title":"Conversation response time","type":"object","description":"Details of first response time of assigned team in seconds.","properties":{"team_id":{"type":"integer","description":"Id of the assigned team.","example":100},"team_name":{"type":"string","description":"Name of the assigned Team, null if team does not exist, Unassigned if no team is assigned.","example":"Team One"},"response_time":{"type":"integer","description":"First response time of assigned team in seconds.","example":2310}}}},"components/schemas/rate_conversation_request":{"id":"components/schemas/rate_conversation_request","kind":"json-schema","title":"Rate conversation request","data":{"title":"Rate conversation request","type":"object","required":["intercom_user_id","rating"],"properties":{"intercom_user_id":{"type":"string","description":"The unique identifier for the contact the rating request was sent to.","example":"6541f0a2c3d4e5f607182930"},"rating":{"type":"integer","minimum":1,"maximum":5,"description":"The rating, from 1 to 5.","example":4},"remark":{"type":"string","description":"Free text from the contact to go with the rating.","example":"Fast and friendly"}}}},"components/schemas/rated_conversation":{"id":"components/schemas/rated_conversation","kind":"json-schema","title":"Rated conversation","data":{"title":"Rated conversation","type":"object","x-tags":["Conversations"],"description":"The CSAT rating recorded on a conversation.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_rating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["conversation_rating"],"example":"conversation_rating"},"conversation_id":{"type":"string","description":"The unique identifier for the conversation.","example":"215471234567890"},"rating":{"type":"integer","description":"The rating, from 1 to 5.","example":4},"remark":{"type":"string","nullable":true,"description":"The free text left with the rating.","example":"Fast and friendly"},"created_at":{"type":"integer","format":"date-time","description":"The time the rating request was created, as a UNIX timestamp.","example":1793664000},"updated_at":{"type":"integer","format":"date-time","description":"The time the rating or remark last changed, as a UNIX timestamp.","example":1793664120},"customer":{"type":"object","description":"The contact who answered.","properties":{"type":{"type":"string","description":"The type of contact.","enum":["user","lead","visitor"],"example":"user"},"id":{"type":"string","description":"The unique identifier for the contact.","example":"6541f0a2c3d4e5f607182930"}}},"teammate":{"type":"object","description":"Who was rated.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a teammate, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Fin, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workflow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a workflow."},"children":[]}]}]}],"enum":["admin","bot","workflow"],"example":"admin"},"id":{"type":"string","description":"The unique identifier for the teammate, Fin or workflow. For a deleted workflow, this is the identifier recorded with the rating.","example":"12345"}}}}}},"components/schemas/conversation_source":{"id":"components/schemas/conversation_source","kind":"json-schema","title":"Conversation source","data":{"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.","properties":{"type":{"type":"string","description":"The origin of this conversation.","example":"email"},"id":{"type":"string","nullable":true,"description":"The id of the source message.","example":"3"},"delivered_as":{"type":"string","description":"How the conversation was initiated.","example":"operator_initiated"},"user_ip":{"type":"string","nullable":true,"description":"The IP address of the end user who opened this conversation, when available. Null otherwise, including when the conversation was not opened by an end user.","example":"203.0.113.42"},"recipients":{"type":"array","nullable":true,"description":"The recipients of the source message. Only present for email conversations.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient type. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bcc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"to"},"email":{"type":"string","format":"email","description":"The recipient email address.","example":"user@example.com"},"drop_reason":{"type":"string","nullable":true,"description":"The reason this recipient was dropped, if applicable.","example":null}}}},"reply_to":{"type":"array","nullable":true,"description":"The Reply-To header addresses of the source message, where a reply will be routed. Can differ from the sender's From address. Only present for email conversations.","items":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The Reply-To email address.","example":"replies@example.com"},"name":{"type":"string","nullable":true,"description":"The display name associated with the Reply-To address.","example":"Support Team"}}}},"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. In webhook payloads for API version 2.15+, this field returns plain text."},"children":[]}]}]}],"example":""},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text."},"children":[]}]}]}],"example":"<p>Hey there!</p>"},"author":{"$ref":"#/components/schemas/conversation_source_author"},"attachments":{"type":"array","description":"A list of attachments for the part.","items":{"$ref":"#/components/schemas/part_attachment"}},"url":{"type":"string","nullable":true,"description":"The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.","example":null},"redacted":{"type":"boolean","description":"Whether or not the source message has been redacted. Only applicable for contact initiated messages.","example":false},"email_message_metadata":{"$ref":"#/components/schemas/source_email_message_metadata"}}}},"components/schemas/conversation_source_author":{"id":"components/schemas/conversation_source_author","kind":"json-schema","title":"Conversation source author","data":{"title":"Conversation source author","type":"object","description":"The author who started the conversation. Can be a Contact, Admin, or Bot.","properties":{"type":{"type":"string","description":"The type of the author.","example":"admin"},"id":{"type":"string","nullable":true,"description":"The id of the author.","example":"274"},"name":{"type":"string","nullable":true,"description":"The name of the author.","example":"Jane Doe"},"email":{"type":"string","format":"email","nullable":true,"description":"The email of the author.","example":"jane.doe@example.com"}}}},"components/schemas/source_email_message_metadata":{"id":"components/schemas/source_email_message_metadata","kind":"json-schema","title":"Email Message Metadata","data":{"title":"Email Message Metadata","type":"object","description":"Contains metadata if the message was sent as an email","properties":{"message_id":{"type":"string","nullable":true,"description":"The unique identifier for the email message as specified in the Message-ID header","example":"<CADKw7xrXzqSn8v3mP8K8Q8yZ6K8Q8yZ6@mail.gmail.com>"},"subject":{"type":"string","description":"The subject of the email","example":"Question about my order"},"email_address_headers":{"title":"Email Address Headers","type":"array","description":"A list of an email address headers.","items":{"$ref":"#/components/schemas/email_address_header"}},"history":{"type":"string","description":"The HTML content of any quoted or forwarded email history from the initial inbound message","example":"<div><span>On Jan 28, wrote:</span><blockquote>Previous thread</blockquote></div>"}}}},"components/schemas/conversation_statistics":{"id":"components/schemas/conversation_statistics","kind":"json-schema","title":"Conversation statistics","data":{"title":"Conversation statistics","type":"object","nullable":true,"description":"A Statistics object containing all information required for reporting, with timestamps and calculated metrics.","properties":{"type":{"type":"string","description":"","example":"conversation_statistics"},"time_to_assignment":{"type":"integer","description":"Duration until last assignment before first admin reply. In seconds.","example":2310},"time_to_admin_reply":{"type":"integer","description":"Duration until first admin reply. Subtracts out of business hours. In seconds.","example":2310},"time_to_first_close":{"type":"integer","description":"Duration until conversation was closed first time. Subtracts out of business hours. In seconds.","example":2310},"time_to_last_close":{"type":"integer","description":"Duration until conversation was closed last time. Subtracts out of business hours. In seconds.","example":2310},"median_time_to_reply":{"type":"integer","description":"Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.","example":2310},"first_contact_reply_at":{"type":"integer","format":"date-time","description":"Time of first text conversation part from a contact.","example":1663597233},"first_assignment_at":{"type":"integer","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of first assignment after first_contact_reply_at."},"children":[]}]}]}],"example":1663597233},"first_admin_reply_at":{"type":"integer","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of first admin reply after first_contact_reply_at."},"children":[]}]}]}],"example":1663597233},"first_close_at":{"type":"integer","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of first close after first_contact_reply_at."},"children":[]}]}]}],"example":1663597233},"last_assignment_at":{"type":"integer","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of last assignment after first_contact_reply_at."},"children":[]}]}]}],"example":1663597233},"last_assignment_admin_reply_at":{"type":"integer","format":"date-time","description":"Time of first admin reply since most recent assignment.","example":1663597233},"last_contact_reply_at":{"type":"integer","format":"date-time","description":"Time of the last conversation part from a contact.","example":1663597233},"last_admin_reply_at":{"type":"integer","format":"date-time","description":"Time of the last conversation part from an admin.","example":1663597233},"last_close_at":{"type":"integer","format":"date-time","description":"Time of the last conversation close.","example":1663597233},"last_closed_by_id":{"type":"string","description":"The last admin who closed the conversation. Returns a reference to an Admin object.","example":"c3po"},"count_reopens":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of reopens after first_contact_reply_at."},"children":[]}]}]}],"example":1},"count_assignments":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of assignments after first_contact_reply_at."},"children":[]}]}]}],"example":1},"count_conversation_parts":{"type":"integer","description":"Total number of conversation parts.","example":1},"assigned_team_first_response_time":{"type":"array","description":"An array of conversation response time objects","items":{"$ref":"#/components/schemas/conversation_response_time"}},"assigned_team_first_response_time_in_office_hours":{"type":"array","description":"An array of conversation response time objects within office hours","items":{"$ref":"#/components/schemas/conversation_response_time"}},"handling_time":{"type":"integer","description":"Time from conversation assignment to conversation close in seconds.","example":2310},"adjusted_handling_time":{"type":"integer","nullable":true,"description":"Adjusted handling time for conversation in seconds. This is the active handling time excluding idle periods when teammates are not actively working on the conversation.","example":1800}}}},"components/schemas/conversation_teammates":{"id":"components/schemas/conversation_teammates","kind":"json-schema","title":"Conversation teammates","data":{"title":"Conversation teammates","type":"object","nullable":true,"description":"The list of teammates who participated in the conversation (wrote at least one conversation part).","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin.list"},"admins":{"type":"array","description":"The list of teammates who participated in the conversation (wrote at least one conversation part).","items":{"$ref":"#/components/schemas/reference"}}}}},"components/schemas/convert_conversation_to_ticket_request":{"id":"components/schemas/convert_conversation_to_ticket_request","kind":"json-schema","title":"Convert Ticket Request Payload","data":{"description":"You can convert a Conversation to a Ticket","type":"object","title":"Convert Ticket Request Payload","properties":{"ticket_type_id":{"type":"string","description":"The ID of the type of ticket you want to convert the conversation to","example":"1234"},"ticket_state_id":{"type":"string","description":"The ID of the ticket state associated with the ticket type."},"attributes":{"$ref":"#/components/schemas/ticket_request_custom_attributes"}},"required":["ticket_type_id"]}},"components/schemas/convert_visitor_request":{"id":"components/schemas/convert_visitor_request","kind":"json-schema","title":"Convert Visitor Request Payload","data":{"description":"You can merge a Visitor to a Contact of role type lead or user.","type":"object","title":"Convert Visitor Request Payload","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the role of the Contact model. Accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"user"},"user":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifiers retained after converting or merging. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; not read when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier for the contact which is given to Intercom, which will be represented as external_id."},"children":[]}]}]}],"example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"email":{"type":"string","description":"The contact's email, retained by default if one is present.","example":"winstonsmith@truth.org"}},"anyOf":[{"required":["id"]},{"required":["user_id"]},{"required":["email"]}]},"visitor":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifiers to convert a single Visitor. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required; an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on its own does not identify a visitor."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"user_id":{"type":"string","description":"A unique identifier for the contact which is given to Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"email":{"type":"string","description":"The visitor's email.","example":"winstonsmith@truth.org"}},"anyOf":[{"required":["id"]},{"required":["user_id"]}]}},"required":["type","visitor"]}},"components/schemas/create_audience_request":{"id":"components/schemas/create_audience_request","kind":"json-schema","title":"Create Audience Request","data":{"title":"Create Audience Request","type":"object","description":"The request payload for creating an audience.","required":["name"],"properties":{"name":{"type":"string","description":"The name of the audience.","example":"VIP Customers"},"predicates":{"type":"array","description":"The predicates that define which contacts belong to the audience.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"company.name","type":"string","comparison":"contains","value":"Acme"}]},"role_predicates":{"type":"array","description":"Role-based predicates that further filter audience membership by contact role. Defaults to all three contact roles when omitted.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}]}}}},"components/schemas/create_article_request":{"id":"components/schemas/create_article_request","kind":"json-schema","title":"Create Article Request Payload","data":{"description":"You can create an Article","type":"object","title":"Create Article Request Payload","nullable":true,"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title of the article. For multilingual articles, this will be the title of the default language's content. Required unless a title is provided in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the workspace's default Help Center locale."},"children":[]}]}]}],"example":"Thanks for everything"},"description":{"type":"string","description":"The description of the article. For multilingual articles, this will be the description of the default language's content.","example":"Description of the Article"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in HTML. For multilingual articles, this will be the body of the default language's content. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"<p>This is the body in html</p>"},"body_markdown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in markdown. For multilingual articles, this will be the body of the default language's content. An alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — you can provide content as markdown instead of HTML. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"# Hello\n\nA paragraph with **bold** text.\n"},"author_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. Required unless an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"author_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the workspace's default Help Center locale."},"children":[]}]}]}],"example":1295},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the article will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or will be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to draft. For multilingual articles, this will be the state of the default language's content."},"children":[]}]}]}],"enum":["published","draft"],"example":"draft"},"parent_id":{"type":"integer","description":"The id of the article's parent collection or section. An article without this field stands alone.","example":18},"parent_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ids of the parent collections to place this article in. Send an empty array to leave the article without a collection. When provided, this takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"integer"},"example":[18,19]},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale of the article's default content, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the locale of the help center that the parent collection belongs to when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent, and otherwise to the default Help Center locale. Must be a locale supported by the workspace's Help Center."},"children":[]}]}]}],"example":"en"},"translated_content":{"description":"Content for other locales, keyed by locale code. Content for the article's default locale can also be given here instead of at the top level. If it is given in both places, the values must match.","$ref":"#/components/schemas/article_translated_content"},"folder_id":{"type":"integer","nullable":true,"description":"The ID of the folder to place this article in, or null to leave it without a folder.","example":6},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to assign to this article for Fin AI Agent targeting. Sending a top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" broadcasts the same set to every locale. For per-locale targeting, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content.<locale>.audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Sending both top-level and per-locale in the same request causes top-level to win. Unknown audience IDs return a 404 error. No partial commit occurs."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the article should be available for AI Chatbot (Fin). For multilingual articles, this sets the default language's availability.","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the article should be available for AI Copilot. For multilingual articles, this sets the default language's availability.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the article should be available for AI Sales Agent. For multilingual articles, this sets the default language's availability.","example":true},"scheduled_publish_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 timestamp at which to schedule a future publish of the article. When set together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"published\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the article is scheduled instead of published immediately. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels a pending publish schedule. Timestamps in the past or equal to the current time are rejected with 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the value must be strictly in the future. Combining with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"draft\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sending in the same request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_unpublish_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400 — only one pending schedule per article. Empty string returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-12-31T09:00:00Z"},"scheduled_unpublish_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 timestamp at which to schedule a future unpublish of the article. The same request must also publish the article ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"published\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), otherwise it returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be strictly in the future; timestamps in the past or equal to the current time are rejected with 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels a pending unpublish schedule. Sending in the same request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_publish_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400 — only one pending schedule per article. Empty string returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-12-31T17:00:00Z"}}}},"components/schemas/create_internal_article_request":{"id":"components/schemas/create_internal_article_request","kind":"json-schema","title":"Create Internal Article Request Payload","data":{"description":"You can create an Internal Article","type":"object","title":"Create Internal Article Request Payload","nullable":true,"properties":{"title":{"type":"string","description":"The title of the article.","example":"Thanks for everything"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in HTML. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"<p>This is the body in html</p>"},"body_markdown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in markdown. An alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — you can provide content as markdown instead of HTML. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"# Internal Guide\n\nSome instructions.\n"},"json_blocks":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article as a list of content blocks. Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale of the article. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"en"},"author_id":{"type":"integer","description":"The id of the author of the article.","example":1295},"owner_id":{"type":"integer","description":"The id of the owner of the article.","example":1295},"folder_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the folder to place this article in. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to leave it without a folder."},"children":[]}]}]}],"example":6},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to target this internal article to for Fin AI Agent. Pass an empty array or omit the field for no audience targeting. Unknown audience IDs return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with no partial commit."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the internal article should be available for AI Chatbot (Fin). Defaults to false.","default":false,"example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the internal article should be available for AI Copilot. Defaults to false.","default":false,"example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the internal article should be available for AI Sales Agent. Defaults to false.","default":false,"example":true}},"required":["title","owner_id","author_id"]}},"components/schemas/create_collection_request":{"id":"components/schemas/create_collection_request","kind":"json-schema","title":"Create Collection Request Payload","data":{"description":"You can create a collection","type":"object","title":"Create Collection Request Payload","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the collection. For multilingual collections, this will be the name of the default language's content. Required unless a name is provided in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the workspace's default Help Center locale."},"children":[]}]}]}],"example":"collection 51"},"description":{"type":"string","description":"The description of the collection. For multilingual collections, this will be the description of the default language's content.","example":"English description"},"icon":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The icon of the collection, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"book-bookmark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"book-bookmark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"book-bookmark"},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"},"parent_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the parent collection. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it will be created as the first level collection."},"children":[]}]}]}],"example":"6871118"},"help_center_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the help center where the collection will be created. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it will be created in the default help center."},"children":[]}]}]}],"example":"123"}}}},"components/schemas/create_contact_request":{"id":"components/schemas/create_contact_request","kind":"json-schema","title":"Create Contact Request Payload","data":{"description":"Payload to create a contact","type":"object","title":"Create Contact Request Payload","properties":{"role":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role of the contact. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creates a lead; any other value creates a user."},"children":[]}]}]}],"example":"user"},"external_id":{"type":"string","description":"A unique identifier for the contact which is given to Intercom","example":"625e90fc55ab113b6d92175f"},"email_verified":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the contact has proved they own this email address, for example through a confirmation link or one-time code you sent. Send it together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing a contact's email resets it to not verified. Intercom reuses leads with a verified email when an inbound email, conversation or ticket matches the address."},"children":[]}]}]}],"example":true},"email":{"type":"string","description":"The contacts email","example":"jdoe@example.com"},"phone":{"type":"string","nullable":true,"description":"The contacts phone","example":"+353871234567"},"name":{"type":"string","nullable":true,"description":"The contacts name","example":"John Doe"},"avatar":{"type":"string","nullable":true,"description":"An image URL containing the avatar of a contact","example":"https://www.example.com/avatar_image.jpg"},"signed_up_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time specified for when a contact signed up.","example":1571672154},"last_seen_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).","example":1571672154},"owner_id":{"type":"string","nullable":true,"description":"The id of an admin that has been assigned account ownership of the contact","example":"321"},"unsubscribed_from_emails":{"type":"boolean","nullable":true,"description":"Whether the contact is unsubscribed from emails","example":true},"sms_consent":{"type":"boolean","description":"Whether the contact has consented to receive SMS messages.","example":false},"unsubscribed_from_sms":{"type":"boolean","description":"Whether the contact is unsubscribed from SMS messages.","example":false},"language_override":{"type":"string","nullable":true,"description":"A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.","example":"en"},"custom_attributes":{"type":"object","nullable":true,"description":"The custom attributes which are set for the contact","example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":1}}},"anyOf":[{"required":["email"],"title":"Create contact with email"},{"required":["external_id"],"title":"Create contact with external_id"},{"required":["role"],"title":"Create contact with role"}]}},"components/schemas/create_content_import_source_request":{"id":"components/schemas/create_content_import_source_request","kind":"json-schema","title":"Create Content Import Source Payload","data":{"title":"Create Content Import Source Payload","type":"object","description":"You can add an Content Import Source to your Fin Content Library.","nullable":false,"properties":{"sync_behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you intend to create or update External Pages via the API, this should be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["api"],"example":"api"},"status":{"type":"string","description":"The status of the content import source.","enum":["active","deactivated"],"default":"active","example":"active"},"url":{"type":"string","description":"The URL of the content import source. It must be an http or https URL whose host is a valid public domain name.","example":"https://help.example.com"},"audience_ids":{"nullable":true,"description":"The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers.","example":[5678],"oneOf":[{"type":"integer"},{"type":"array","items":{"type":"integer"}}]}},"required":["sync_behavior","url"]}},"components/schemas/create_conversation_request":{"id":"components/schemas/create_conversation_request","kind":"json-schema","title":"Create Conversation Request Payload","data":{"description":"Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.","type":"object","title":"Create Conversation Request Payload","properties":{"from":{"type":"object","properties":{"type":{"type":"string","enum":["lead","user"],"description":"The role associated to the contact - user or lead.","example":"user"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the contact which is given by Intercom. Provide one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you send more than one, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used first, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":24,"maxLength":24,"example":"536e564f316c83104c000020"},"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external identifier you gave the user. Matches users only; for a lead, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"25"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's email. Matches a user or a lead, depending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" isn't sent. If several leads share the email and it's the only identifier sent, the request fails with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multiple_users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"example":"joe@example.com"}},"required":["type"]},"body":{"type":"string","description":"The content of the message. HTML is not supported.","example":"Hello"},"subject":{"type":"string","description":"The title of the email. Only applicable if the message type is email.","example":"Thanks for everything"},"attachment_urls":{"type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10},"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},"brand_id":{"type":"string","description":"The unique identifier of the brand to associate with this conversation.","example":"123"}},"required":["from","body"]}},"components/schemas/create_data_attribute_request":{"id":"components/schemas/create_data_attribute_request","kind":"json-schema","title":"Create Data Attribute Request","data":{"description":"","type":"object","title":"Create Data Attribute Request","properties":{"name":{"type":"string","description":"The name of the data attribute.","example":"My Data Attribute"},"model":{"type":"string","description":"The model that the data attribute belongs to.","enum":["contact","company"],"example":"contact"},"description":{"type":"string","description":"The readable description you see in the UI for the attribute.","example":"My Data Attribute Description"},"messenger_writable":{"type":"boolean","description":"Can this attribute be updated by the Messenger","example":false}},"required":["name","model","data_type"],"oneOf":[{"properties":{"data_type":{"enum":["options"]},"options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of objects representing the options of the list, with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the key and the option as the value. At least two options are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"value":{"type":"string"}}},"example":[{"value":"1-10"},{"value":"11-50"}]}},"required":["options"],"title":"list attribute"},{"properties":{"data_type":{"enum":["string","integer","float","boolean","date"]}},"title":"other type"}]}},"components/schemas/create_data_event_request":{"id":"components/schemas/create_data_event_request","kind":"json-schema","title":"Create Data Event Request","data":{"description":"","type":"object","title":"Create Data Event Request","properties":{"event_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated-plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"invited-friend"},"created_at":{"type":"integer","format":"date-time","description":"The time the event occurred as a UTC Unix timestamp","example":1671028894},"user_id":{"type":"string","description":"Your identifier for the user.","example":"314159"},"id":{"type":"string","description":"The unique identifier for the contact (lead or user) which is given by Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"email":{"type":"string","description":"An email address for your user. An email should only be used where your application uses email to uniquely identify users.","example":"frodo.baggins@example.com"},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional metadata about the event. Values can be a string, a number, a boolean, or an object holding a rich link ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a monetary amount ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"example":{"invite_code":"ADDAFRIEND"}}},"anyOf":[{"title":"id required","required":["event_name","created_at","id"]},{"title":"user_id required","required":["event_name","created_at","user_id"]},{"title":"email required","required":["event_name","created_at","email"]}]}},"components/schemas/create_data_event_summaries_request":{"id":"components/schemas/create_data_event_summaries_request","kind":"json-schema","title":"Create Data Event Summaries Request","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense \"verb-noun\" combination, to improve readability, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated-plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","title":"Create Data Event Summaries Request","required":["event_summaries"],"anyOf":[{"title":"id required","required":["id"]},{"title":"user_id required","required":["user_id"]},{"title":"email required","required":["email"]}],"properties":{"user_id":{"type":"string","description":"Your identifier for the user.","example":"314159"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Intercom defined id of the user. Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"63a0979a5eeebeaf28dd56ba"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's email address. Only used when neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied."},"children":[]}]}]}],"example":"frodo.baggins@example.com"},"event_summaries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated-plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","required":["event_name","count","first","last"],"properties":{"event_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated-plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"invited-friend"},"count":{"type":"integer","description":"The number of times the event occurred.","example":1},"first":{"type":"integer","format":"date-time","description":"The first time the event was sent","example":1671028894},"last":{"type":"integer","format":"date-time","description":"The last time the event was sent","example":1671028894}}}}}}},"components/schemas/create_data_exports_request":{"id":"components/schemas/create_data_exports_request","kind":"json-schema","title":"Create Data Export Request","data":{"description":"Request for creating a data export","type":"object","title":"Create Data Export Request","properties":{"created_at_after":{"type":"integer","description":"The start date that you request data for. It must be formatted as a unix timestamp.","example":1527811200},"created_at_before":{"type":"integer","description":"The end date that you request data for. It must be formatted as a unix timestamp.","example":1527811200}},"required":["created_at_after","created_at_before"]}},"components/schemas/create_external_page_request":{"id":"components/schemas/create_external_page_request","kind":"json-schema","title":"Create External Page Payload","data":{"title":"Create External Page Payload","type":"object","description":"You can add an External Page to your Fin Content Library.","nullable":false,"properties":{"title":{"type":"string","description":"The title of the external page.","example":"Getting started with..."},"html":{"type":"string","description":"The body of the external page in HTML.","example":"<p>Hello world!</p>"},"url":{"type":"string","description":"The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.","example":"https://help.example.com/en/articles/1234-getting-started"},"ai_agent_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.","default":false,"example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.","default":false,"example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Sales Agent. Will not default when updating an existing external page.","default":false,"example":true},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code of the external page, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be a language supported by the workspace."},"children":[]}]}]}],"example":"en"},"source_id":{"type":"integer","description":"The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.","example":1234},"external_id":{"type":"string","description":"The identifier for the external page which was given by the source. Must be unique for the source.","example":"5678"},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to target this external page to for Fin AI Agent. Omitting the field keeps the default audience inherited from the source. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear all audience memberships, including the inherited ones. If an external page already exists with the specified source_id and external_id, omitting the field leaves its audience memberships unchanged. Unknown audience IDs return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]}},"required":["title","html","locale","source_id","external_id"]}},"components/schemas/create_message_request":{"id":"components/schemas/create_message_request","kind":"json-schema","title":"Create Message Request Payload","data":{"description":"You can create a message","type":"object","title":"Create Message Request Payload","nullable":true,"properties":{"message_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The kind of message being created. Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also accepted for in-app messages, and responses always show in-app messages as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["in_app","inapp","email","whatsapp"],"example":"in_app"},"subject":{"type":"string","description":"The title of the email.","example":"Thanks for everything"},"body":{"type":"string","description":"The content of the message. HTML and plaintext are supported.","example":"Hello there"},"template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The style of the outgoing message. Possible values "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"plain"},"from":{"type":"object","description":"The sender of the message. If not provided, the default sender will be used.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["admin"],"example":"admin"},"id":{"type":"integer","description":"The identifier for the admin which is given by Intercom.","example":394051}},"required":["type","id"]},"to":{"oneOf":[{"$ref":"#/components/schemas/recipient"},{"type":"array","description":"The recipients of the message.","items":{"$ref":"#/components/schemas/recipient"},"example":[{"type":"user","id":"536e564f316c83104c000020"},{"type":"lead","id":"536e564f316c83104c000021"}]},{"type":"object","title":"WhatsApp recipient","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" message, identified by phone number. Required form for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" messages. A contact is created for the number if there isn't one."},"children":[]}]}]}],"properties":{"phone":{"type":"string","description":"The recipient's phone number, in international format.","example":"+5547999998888"},"name":{"type":"string","description":"The name to give the contact if one is created.","example":"John Doe"}},"required":["phone"]}]},"cc":{"oneOf":[{"$ref":"#/components/schemas/recipient"},{"type":"array","description":"The CC recipients of the message.","items":{"$ref":"#/components/schemas/recipient"},"example":[{"type":"user","id":"536e564f316c83104c000023"}]}]},"bcc":{"oneOf":[{"$ref":"#/components/schemas/recipient"},{"type":"array","description":"The BCC recipients of the message.","items":{"$ref":"#/components/schemas/recipient"},"example":[{"type":"user","id":"536e564f316c83104c000022"}]}]},"created_at":{"type":"integer","description":"The time the message was created. If not provided, the current time will be used.","example":1590000000},"create_conversation_without_contact_reply":{"type":"boolean","description":"Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided.","default":false,"example":true},"components":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The components of the WhatsApp template, with the values for its variables. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" messages."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":true},"example":[{"type":"BODY","parameters":[{"type":"text","text":"Username 123"}]}]},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The locale of the WhatsApp template to send, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you leave it out, the contact's messenger locale is used, then the workspace locale. A template that isn't available in the locale returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":"en"},"brand_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the brand to send the message from. Not used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" messages. A brand that doesn't exist returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":"1234"}},"anyOf":[{"title":"message_type: `email`.","required":["message_type","subject","body","template","from","to"]},{"title":"message_type: `inapp`.","required":["message_type","body","from","to"]},{"title":"message_type: `whatsapp`.","required":["message_type","template","components","from","to"]}]}},"components/schemas/recipient":{"id":"components/schemas/recipient","kind":"json-schema","title":"Recipient","data":{"type":"object","title":"Recipient","description":"A recipient of a message","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role associated to the contact - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["user","lead"],"example":"user"},"id":{"type":"string","description":"The identifier for the contact which is given by Intercom.","example":"536e564f316c83104c000020"}},"required":["type","id"]}},"components/schemas/create_or_update_company_request":{"id":"components/schemas/create_or_update_company_request","kind":"json-schema","title":"Create Or Update Company Request Payload","data":{"type":"object","title":"Create Or Update Company Request Payload","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create or update a Company. Send either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a request with neither returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"nullable":true,"properties":{"name":{"type":"string","description":"The name of the Company. Leading and trailing whitespace is removed.","example":"Intercom"},"company_id":{"type":"string","description":"The company id you have defined for the company. Can't be updated","example":"625e90fc55ab113b6d92175f"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An alternative name for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"625e90fc55ab113b6d92175f"},"plan":{"type":"string","description":"The name of the plan you have associated with the company.","example":"Enterprise"},"size":{"type":"integer","description":"The number of employees in this company.","example":100},"website":{"type":"string","description":"The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.","example":"https://www.example.com"},"industry":{"type":"string","description":"The industry that this company operates in.","example":"Manufacturing"},"custom_attributes":{"type":"object","description":"Values for custom attributes that already exist in your workspace. Each value can be a string, integer, number, boolean or null. Arrays and objects aren't accepted.","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"remote_created_at":{"type":"integer","description":"The time the company was created by you.","example":1394531169},"update_last_request_at":{"type":"boolean","description":"Set to true to update the company's last seen time to now.","example":true},"monthly_spend":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How much revenue the company generates for your business. Floats are truncated to whole integers, so 155.98 is stored as 155. A value above 2147483647 (2**31-1) is stored as 0. 2147483647 itself, or a value of -2147483648 or below, returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":1000}}}},"components/schemas/update_company_request":{"id":"components/schemas/update_company_request","kind":"json-schema","title":"Update Company Request Payload","data":{"type":"object","title":"Update Company Request Payload","description":"You can update a Company","nullable":true,"properties":{"name":{"type":"string","description":"The name of the Company. Leading and trailing whitespace is removed.","example":"Intercom"},"update_last_request_at":{"type":"boolean","description":"Set to true to update the company's last seen time to now.","example":true},"plan":{"type":"string","description":"The name of the plan you have associated with the company.","example":"Enterprise"},"size":{"type":"integer","description":"The number of employees in this company.","example":100},"website":{"type":"string","description":"The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.","example":"https://www.example.com"},"industry":{"type":"string","description":"The industry that this company operates in.","example":"Manufacturing"},"custom_attributes":{"type":"object","description":"Values for custom attributes that already exist in your workspace. Each value can be a string, integer, number, boolean or null. Arrays and objects aren't accepted.","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"remote_created_at":{"type":"integer","description":"The time the company was created by you.","example":1394531169},"monthly_spend":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How much revenue the company generates for your business. Floats are truncated to whole integers, so 155.98 is stored as 155. A value above 2147483647 (2**31-1) is stored as 0. 2147483647 itself, or a value of -2147483648 or below, returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":1000}}}},"components/schemas/create_or_update_custom_object_instance_request":{"id":"components/schemas/create_or_update_custom_object_instance_request","kind":"json-schema","title":"Create Or Update Custom Object Instance Request Payload","data":{"description":"Payload to create or update a Custom Object instance","type":"object","title":"Create Or Update Custom Object Instance Request Payload","properties":{"external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier for the Custom Object instance in the external system it originated from. The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reserved and is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitting this field creates a new instance on every request instead of updating an existing one."},"children":[]}]}]}]},"external_created_at":{"type":"integer","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the Custom Object instance was created in the external system it originated from. A value that cannot be read as a time is stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than rejected."},"children":[]}]}]}],"example":1571672154},"external_updated_at":{"type":"integer","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the Custom Object instance was last updated in the external system it originated from. A value that cannot be read as a time is stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than rejected."},"children":[]}]}]}],"example":1571672154},"custom_attributes":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom attributes which are set for the Custom Object instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each value must match the type of the attribute it is set on: a string, integer, number or boolean, a Unix timestamp or date string for a datetime attribute, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear the attribute. A list attribute takes the label or id of one of its options; a value that matches no option clears the attribute rather than being rejected. A reference attribute takes the Intercom id of the record it points at, or an array of ids for a reference to several records; an id that matches no record is skipped."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]},"example":{"order_number":"ORDER-12345","total_amount":99.99}}}}},"components/schemas/create_or_update_tag_request":{"id":"components/schemas/create_or_update_tag_request","kind":"json-schema","title":"Create or Update Tag Request Payload","data":{"description":"You can create or update an existing tag, and optionally apply it to a list of contact or company ids.","type":"object","title":"Create or Update Tag Request Payload","properties":{"name":{"type":"string","maxLength":191,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive and can be at most 191 characters long. Creating a tag with a longer name returns a 400. When updating by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a longer name or one that another tag already has returns 200 with the new name, but the tag keeps its old name."},"children":[]}]}]}],"example":"Independent"},"id":{"type":"string","description":"The id of tag to updates.","example":"656452352"},"ids_to_add":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Intercom ids of the contacts or companies to apply the tag to. A contact id that does not exist returns a 404; a company id that does not exist is skipped. A 404 still leaves the tag created or renamed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrays in the response are always empty when this field is used."},"children":[]}]}]}],"items":{"type":"string"},"example":["536e564f316c83104c000020"]},"taggable_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the ids in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids_to_add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are contacts or companies. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["user","company"],"example":"user"}},"required":["name"]}},"components/schemas/create_phone_switch_request":{"id":"components/schemas/create_phone_switch_request","kind":"json-schema","title":"Create Phone Switch Request Payload","data":{"description":"You can create an phone switch","type":"object","title":"Create Phone Switch Request Payload","nullable":true,"properties":{"phone":{"type":"string","description":"Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.","example":"+1 1234567890"},"custom_attributes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom attributes to add to the user or lead's custom data attributes. Values are strings. Numbers and booleans are converted to strings. An empty string, or any array or object value, returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with the key "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is ignored."},"children":[]}]}]}],"additionalProperties":{"oneOf":[{"type":"string","nullable":true},{"type":"number"},{"type":"boolean"}]},"example":{"issue_type":"Billing","priority":"High"}},"body":{"type":"string","description":"The text of the contact's first message. When you send it, a conversation is created straight away with this text as its first message.","example":"I need help with my invoice"},"send_notification":{"type":"boolean","default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to send the SMS with the link to the Messenger. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no SMS is sent."},"children":[]}]}]}],"example":true},"user_input_phone":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number as the contact typed it, in national format. When sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", used in place of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to read the number. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still required."},"children":[]}]}]}],"example":"087 234 5678"},"country":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-letter country code used to read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_input_phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Intercom also looks up the carrier to detect landlines."},"children":[]}]}]}],"example":"IE"}},"required":["phone"]}},"components/schemas/create_ticket_reply_with_comment_request":{"id":"components/schemas/create_ticket_reply_with_comment_request","kind":"json-schema","title":"Create Ticket Reply Request Payload","data":{"title":"Create Ticket Reply Request Payload","oneOf":[{"$ref":"#/components/schemas/contact_reply_ticket_request"},{"$ref":"#/components/schemas/admin_reply_ticket_request"}]}},"components/schemas/create_ticket_request":{"id":"components/schemas/create_ticket_request","kind":"json-schema","title":"Create Ticket Request Payload","data":{"description":"You can create a Ticket","type":"object","title":"Create Ticket Request Payload","properties":{"ticket_type_id":{"type":"string","description":"The ID of the type of ticket you want to create","example":"1234"},"contacts":{"type":"array","description":"The list of contacts (users or leads) affected by this ticket. Currently only one is allowed. Required for Customer and Back-office ticket types, and optional for Tracker ticket types.","items":{"type":"object","oneOf":[{"title":"ID","properties":{"id":{"type":"string","description":"The identifier for the contact as given by Intercom."}},"required":["id"]},{"title":"External ID","properties":{"external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external_id you have defined for the contact who is being added as a participant."},"children":[]}]}]}]}},"required":["external_id"]},{"title":"Email","properties":{"email":{"type":"string","description":"The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created."}},"required":["email"]}]},"example":[{"id":"1234"}]},"conversation_to_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation | back-office ticket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer tickets | non-shared back-office ticket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation | tracker ticket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer ticket | tracker ticket"},"children":[]}]}]}]}],"example":"1234"},"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","example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"},"created_at":{"type":"integer","description":"The time the ticket was created. If not provided, the current time will be used.","example":1590000000},"ticket_attributes":{"$ref":"#/components/schemas/ticket_request_custom_attributes"},"assignment":{"type":"object","properties":{"admin_assignee_id":{"type":"string","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"}}},"channel":{"type":"string","enum":["email"],"description":"The channel for the ticket. Only supported for customer ticket types. Defaults to messenger if not provided.","example":"email"}},"required":["ticket_type_id"]}},"components/schemas/create_ticket_type_attribute_request":{"id":"components/schemas/create_ticket_type_attribute_request","kind":"json-schema","title":"Create Ticket Type Attribute Request Payload","data":{"description":"You can create a Ticket Type Attribute","type":"object","title":"Create Ticket Type Attribute Request Payload","properties":{"name":{"type":"string","description":"The name of the ticket type attribute","example":"Bug Priority"},"description":{"type":"string","description":"The description of the attribute presented to the teammate or contact","example":"Priority level of the bug"},"data_type":{"type":"string","description":"The data type of the attribute","enum":["string","list","integer","decimal","boolean","datetime","files"],"example":"string"},"required_to_create":{"type":"boolean","description":"Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.","default":false,"example":false},"required_to_create_for_contacts":{"type":"boolean","description":"Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.","default":false,"example":false},"visible_on_create":{"type":"boolean","description":"Whether the attribute is visible to teammates when creating a ticket in Inbox.","default":true,"example":true},"visible_to_contacts":{"type":"boolean","description":"Whether the attribute is visible to contacts when creating a ticket in Messenger.","default":true,"example":true},"multiline":{"type":"boolean","description":"Whether the attribute allows multiple lines of text (only applicable to string attributes)","example":false},"list_items":{"type":"string","description":"A comma delimited list of items for the attribute value (only applicable to list attributes)","example":"Low Priority,Medium Priority,High Priority"},"allow_multiple_values":{"type":"boolean","description":"Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)","example":false}},"required":["name","data_type"]}},"components/schemas/create_ticket_type_request":{"id":"components/schemas/create_ticket_type_request","kind":"json-schema","title":"Create Ticket Type Request Payload","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for creating a ticket type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can copy the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"icon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property for your ticket type from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://twemoji-cheatsheet.vercel.app/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twemoji Cheatsheet"},"children":[]}]}]}]}],"type":"object","title":"Create Ticket Type Request Payload","nullable":true,"properties":{"name":{"type":"string","description":"The name of the ticket type.","example":"Bug"},"description":{"type":"string","description":"The description of the ticket type.","example":"Used for tracking bugs"},"category":{"type":"string","description":"Category of the Ticket Type.","enum":["Customer","Back-office","Tracker"],"example":"Customer"},"icon":{"type":"string","description":"The icon of the ticket type.","example":"🐞","default":"🎟️"},"is_internal":{"type":"boolean","description":"Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.","example":false,"default":false}},"required":["name","category"]}},"components/schemas/cursor_pages":{"id":"components/schemas/cursor_pages","kind":"json-schema","title":"Cursor based pages","data":{"title":"Cursor based pages","type":"object","description":"Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the type of object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"pages","enum":["pages"]},"page":{"type":"integer","description":"The current page","example":1},"next":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the next page by sending this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starting_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cursor. Omitted on the last page."},"children":[]}]}]}],"properties":{"page":{"type":"integer","description":"The number of the next page","example":2},"starting_after":{"type":"string","description":"The cursor to send in the next request to get the next page of results.","example":"your-cursor-from-response"}}},"per_page":{"type":"integer","description":"Number of results per page","example":2},"total_pages":{"type":"integer","description":"Total number of pages","example":13}}}},"components/schemas/call":{"id":"components/schemas/call","kind":"json-schema","title":"Call","data":{"title":"Call","type":"object","x-tags":["Calls"],"description":"Represents a phone call in Intercom","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"call"},"id":{"type":"string","description":"The id of the call.","example":"123"},"conversation_id":{"type":"string","nullable":true,"description":"The id of the conversation associated with the call, if any.","example":"456"},"admin_id":{"type":"string","nullable":true,"description":"The id of the admin associated with the call, if any.","example":"789"},"contact_id":{"type":"string","nullable":true,"description":"The id of the contact associated with the call, if any.","example":"6762f0dd1bb69f9f2193bb83"},"state":{"type":"string","description":"The current state of the call.","example":"ended"},"initiated_at":{"$ref":"#/components/schemas/datetime"},"answered_at":{"$ref":"#/components/schemas/datetime"},"ended_at":{"$ref":"#/components/schemas/datetime"},"created_at":{"$ref":"#/components/schemas/datetime"},"updated_at":{"$ref":"#/components/schemas/datetime"},"recording_url":{"type":"string","format":"uri","nullable":true,"description":"API URL to download or redirect to the call recording if available.","example":"https://api.intercom.io/calls/123/recording"},"transcription_url":{"type":"string","format":"uri","nullable":true,"description":"API URL to download or redirect to the call transcript if available.","example":"https://api.intercom.io/calls/123/transcript"},"call_type":{"type":"string","description":"The type of call.","example":"phone"},"direction":{"type":"string","description":"The direction of the call.","example":"outbound"},"ended_reason":{"type":"string","nullable":true,"description":"The reason for the call end, if applicable.","example":"missed"},"phone":{"type":"string","nullable":true,"description":"The phone number involved in the call, in E.164 format.","example":"+15551234567"},"fin_recording_url":{"type":"string","format":"uri","nullable":true,"description":"API URL to the AI Agent (Fin) call recording if available."},"fin_transcription_url":{"type":"string","format":"uri","nullable":true,"description":"API URL to the AI Agent (Fin) call transcript if available."},"duration":{"type":"integer","nullable":true,"description":"Total call duration in seconds from the caller's perspective. For inbound calls, measured from initiated to ended. For outbound calls, measured from answered to ended. Null until the call ends, and for outbound calls that were never answered.","example":900},"talk_time":{"type":"integer","nullable":true,"description":"Total time in seconds the agent and customer were connected.","example":300},"queue_time":{"type":"integer","nullable":true,"description":"Total time in seconds the caller waited in queue before connecting, when assigned to a team.","example":45},"hold_time":{"type":"integer","nullable":true,"description":"Total time in seconds the caller was placed on hold during the call.","example":60}}}},"components/schemas/call_list":{"id":"components/schemas/call_list","kind":"json-schema","title":"Calls","data":{"title":"Calls","type":"object","description":"A paginated list of calls.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"A list of calls.","items":{"$ref":"#/components/schemas/call"}},"total_count":{"type":"integer","description":"Total number of items available.","example":0},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"components/schemas/call_transcript_turn":{"id":"components/schemas/call_transcript_turn","kind":"json-schema","title":"Call Transcript Turn","data":{"title":"Call Transcript Turn","type":"object","x-tags":["Calls"],"description":"A single turn in a call transcript.","properties":{"start_time":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"The start time of the turn, as a seconds offset from the start of the call. A string on calls transcribed by Amazon Transcribe, a number on Fin Voice calls.","example":"0.0"},"end_time":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"The end time of the turn, as a seconds offset from the start of the call. A string on calls transcribed by Amazon Transcribe, a number on Fin Voice calls.","example":"3.00"},"speaker_label":{"type":"string","description":"The diarization label for the speaker.","example":"Teammate 1"},"speaker":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The diarization label for the speaker. Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Teammate 1"},"content":{"type":"string","description":"The transcribed text spoken during this turn.","example":"Hello, thanks for calling. How can I help today?"},"speaker_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the speaker - either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a teammate or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a contact. Absent on Fin Voice call transcripts and on calls transcribed before speaker attribution shipped, where only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies the speaker."},"children":[]}]}]}],"example":"admin"},"speaker_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the teammate or contact who is the speaker. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the teammate who spoke has since been deleted, in which case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deleted teammate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"789"},"speaker_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resolved display name of the speaker. A contact who has been merged into another resolves to the name on the surviving record. Omitted when the speaker cannot be resolved or has no name, for example a contact whose record was scrambled by a GDPR deletion request. Clients should fall back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"speaker_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this is absent."},"children":[]}]}]}],"example":"Jane Doe"},"article_sources":{"type":"array","description":"Sources Fin cited during this turn. Only present on Fin Voice call transcripts.","example":[{"title":"Password Reset Guide","entity_type":120,"entity_id":"8185560"}],"items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the cited source.","example":"Password Reset Guide"},"entity_type":{"type":"integer","description":"The type of the cited entity.","example":120},"entity_id":{"type":"string","description":"The id of the cited entity.","example":"8185560"}}}},"triggered_guidance":{"type":"array","description":"Guidance rules that Fin matched during this turn. Only present on Fin Voice call transcripts.","example":[{"match_type":"clarification","rule_id":"3","rule_text":"If the customer asks about pricing, ask which plan they're interested in before answering"}],"items":{"type":"object","properties":{"match_type":{"type":"string","description":"How the rule was matched.","example":"clarification"},"rule_id":{"type":"string","description":"The id of the matched guidance rule.","example":"3"},"rule_text":{"type":"string","description":"The text of the matched guidance rule.","example":"If the customer asks about pricing, ask which plan they're interested in before answering"}}}}}}},"components/schemas/custom_attributes":{"id":"components/schemas/custom_attributes","kind":"json-schema","title":"Custom Attributes","data":{"title":"Custom Attributes","type":"object","description":"An object containing the custom attributes on a conversation as key-value pairs. For relationship attributes the value is a list of custom object instance models. System-defined attributes such as \"AI Topic and Subtopic\", \"CX Score rating\", \"CX Score explanation\" and \"CX Score reasons\" may also be included.","properties":{"AI Topic and Subtopic":{"type":"array","readOnly":true,"description":"Read-only AI Insights classification of the conversation. Present only with the AI add-on; omitted when the conversation has no classification.","example":[{"topic_name":"Billing","subtopic_name":"Payment Issues","id":42}],"items":{"$ref":"#/components/schemas/ai_topic_subtopic"}},"CX Score reasons":{"type":"array","readOnly":true,"description":"Read-only reasons behind the conversation's CX Score. Intercom generates this attribute, so it cannot be set. Omitted when the conversation has no CX Score reasons.","example":[{"name":"Resolution speed","value":"Fast"}],"items":{"$ref":"#/components/schemas/cx_score_reason"}}},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"$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,"CX Score rating":4,"CX Score explanation":"The conversation was resolved quickly and the customer expressed satisfaction with the outcome.","AI Topic and Subtopic":[{"topic_name":"Billing","subtopic_name":"Payment Issues","id":42}],"CX Score reasons":[{"name":"Resolution speed","value":"Fast"}]}}},"components/schemas/custom_attributes_request":{"id":"components/schemas/custom_attributes_request","kind":"json-schema","title":"Custom Attributes (write)","data":{"title":"Custom Attributes (write)","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object instance models. Only attributes a caller may set should be sent here — attributes Intercom generates are returned in responses only."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"$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}}},"components/schemas/cx_score_reason":{"id":"components/schemas/cx_score_reason","kind":"json-schema","title":"CX Score reason","data":{"title":"CX Score reason","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single reason behind a conversation's CX Score. Surfaced inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the \"CX Score reasons\" key as an array of these objects."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"The name of the reason.","example":"Resolution speed"},"value":{"type":"string","description":"The value recorded for the reason.","example":"Fast"}}}},"components/schemas/custom_object_instance":{"id":"components/schemas/custom_object_instance","kind":"json-schema","title":"Custom Object Instance","data":{"title":"Custom Object Instance","type":"object","x-tags":["Custom Object Instances"],"nullable":true,"description":"A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.","properties":{"id":{"type":"string","description":"The Intercom defined id representing the custom object instance.","example":16032025},"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 of the custom object instance.","example":"Order"},"custom_attributes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom attributes you have set on the custom object instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each value is returned with the type of the attribute it is set on: a string, integer, number or boolean, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the attribute is unset. A list attribute returns the label of the selected option. A reference attribute returns an object holding the referenced records, under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contacts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a contact reference, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a conversation reference, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a reference to another custom object type."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"example":{"order_number":"ORDER-12345","total_amount":99.99}}}}},"components/schemas/custom_object_instance_deleted":{"id":"components/schemas/custom_object_instance_deleted","kind":"json-schema","title":"Custom Object Instance Deleted","data":{"title":"Custom Object Instance Deleted","type":"object","description":"deleted custom object instance object","properties":{"object":{"type":"string","description":"The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.","example":"Order"},"id":{"type":"string","description":"The Intercom defined id representing the Custom Object instance.","example":"123"},"deleted":{"type":"boolean","description":"Whether the Custom Object instance is deleted or not.","example":true}}}},"components/schemas/custom_object_instance_list":{"id":"components/schemas/custom_object_instance_list","kind":"json-schema","title":"Custom Object Instances","data":{"title":"Custom Object Instances","type":"object","description":"The list of associated custom object instances for a given reference attribute on the parent object.","properties":{"type":{"type":"string","example":"order.list"},"instances":{"type":"array","description":"The list of associated custom object instances for a given reference attribute on the parent object.","items":{"$ref":"#/components/schemas/custom_object_instance"}}}}},"components/schemas/custom_object_instance_not_found":{"id":"components/schemas/custom_object_instance_not_found","kind":"json-schema","title":"Custom Object Instance Not Found","data":{"title":"Custom Object Instance Not Found","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned with HTTP 200 (not 404) when the custom object type exists but no instance matches the requested id or external_id."},"children":[]}]}]}],"required":["found"],"properties":{"found":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present on this response."},"children":[]}]}]}],"example":false},"id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested id, echoed back. Null when looked up by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"external_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested external_id, echoed back. Null when looked up by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"type":"string","description":"The identifier of the custom object type that was queried.","example":"Order"},"custom_attributes":{"type":"object","description":"Always an empty object."},"external_created_at":{"type":"integer","nullable":true},"external_updated_at":{"type":"integer","nullable":true},"created_at":{"type":"integer","nullable":true},"updated_at":{"type":"integer","nullable":true}}}},"components/schemas/custom_object_instances_paginated_list":{"id":"components/schemas/custom_object_instances_paginated_list","kind":"json-schema","title":"Custom Object Instances","data":{"title":"Custom Object Instances","type":"object","x-tags":["Custom Object Instances"],"description":"A paginated list of custom object instances.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of custom object instances.","example":2},"data":{"type":"array","description":"An array of Custom Object Instance objects.","items":{"$ref":"#/components/schemas/custom_object_instance"}}}}},"components/schemas/customer_request":{"id":"components/schemas/customer_request","kind":"json-schema","title":"customer_request","data":{"type":"object","nullable":true,"oneOf":[{"title":"Intercom User ID","properties":{"intercom_user_id":{"type":"string","description":"The identifier for the contact as given by Intercom.","example":"6329bd9ffe4e2e91dac76188"}},"required":["intercom_user_id"]},{"title":"User ID","properties":{"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external_id you have defined for the contact who is being added as a participant."},"children":[]}]}]}],"example":"2e91dac761886329bd9ffe4e"}},"required":["user_id"]},{"title":"Email","properties":{"email":{"type":"string","description":"The email you have defined for the contact who is being added as a participant.","example":"sam.sung@example.com"}},"required":["email"]}]}},"components/schemas/data_attribute":{"id":"components/schemas/data_attribute","kind":"json-schema","title":"Data Attribute","data":{"title":"Data Attribute","type":"object","x-tags":["Data Attributes"],"description":"Data Attributes are metadata used to describe your contact and company models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["data_attribute"],"example":"data_attribute"},"id":{"type":"integer","description":"The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.","example":12878},"model":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for user/lead attributes and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for company attributes."},"children":[]}]}]}],"enum":["contact","company"],"example":"contact"},"name":{"type":"string","description":"Name of the attribute.","example":"paid_subscriber"},"full_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to access nested user object values."},"children":[]}]}]}],"example":"custom_attributes.paid_subscriber"},"label":{"type":"string","description":"Readable name of the attribute (i.e. name you see in the UI)","example":"Paid Subscriber"},"description":{"type":"string","description":"Readable description of the attribute.","example":"Whether the user is a paid subscriber."},"data_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type of the attribute. A list attribute created with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data type is returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with its choices in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relationship"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a reference to a custom object."},"children":[]}]}]}],"enum":["string","integer","float","boolean","date","datetime","relationship"],"example":"boolean"},"options":{"type":"array","description":"List of predefined options for attribute value.","items":{"type":"string"},"example":["true","false"]},"api_writable":{"type":"boolean","description":"Can this attribute be updated through API","example":true},"messenger_writable":{"type":"boolean","description":"Can this attribute be updated by the Messenger","example":false},"ui_writable":{"type":"boolean","description":"Can this attribute be updated in the UI","example":true},"custom":{"type":"boolean","description":"Set to true if this is a CDA","example":true},"archived":{"type":"boolean","description":"Is this attribute archived. (Only applicable to CDAs)","example":false},"created_at":{"type":"integer","format":"date-time","description":"The time the attribute was created as a UTC Unix timestamp","example":1671028894},"updated_at":{"type":"integer","format":"date-time","description":"The time the attribute was last updated as a UTC Unix timestamp","example":1671028894},"admin_id":{"type":"string","description":"Teammate who created the attribute. Only applicable to CDAs","example":"5712945"}}}},"components/schemas/data_attribute_list":{"id":"components/schemas/data_attribute_list","kind":"json-schema","title":"Data Attribute List","data":{"title":"Data Attribute List","type":"object","description":"A list of all data attributes belonging to a workspace for contacts or companies.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of data attributes","items":{"$ref":"#/components/schemas/data_attribute"}}}}},"components/schemas/conversation_attribute_base":{"id":"components/schemas/conversation_attribute_base","kind":"json-schema","title":"Conversation Attribute Base","data":{"title":"Conversation Attribute Base","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["conversation_attribute"],"example":"conversation_attribute"},"id":{"type":"integer","description":"The unique identifier for the conversation attribute.","example":8},"name":{"type":"string","description":"Name of the attribute.","example":"api_test_attr"},"description":{"type":"string","description":"Readable description of the attribute.","example":"Created via API test"},"data_type":{"type":"string","description":"The data type of the attribute. Allowed types: string, integer, list, decimal, boolean, datetime, relationship, files.","enum":["string","integer","list","decimal","boolean","datetime","relationship","files"],"example":"string"},"required":{"type":"boolean","description":"Whether this attribute is required.","example":false},"visible_to_team_ids":{"type":"array","description":"Team IDs that can see this attribute. Empty array means all teams.","items":{"type":"string"},"example":[]},"archived":{"type":"boolean","description":"Whether this attribute is archived.","example":false},"created_at":{"type":"integer","format":"date-time","description":"The time the attribute was created as a UTC Unix timestamp.","example":1778239701},"updated_at":{"type":"integer","format":"date-time","description":"The time the attribute was last updated as a UTC Unix timestamp.","example":1778239701},"admin_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the admin who created the attribute, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there isn't one."},"children":[]}]}]}],"example":"16"}}}},"components/schemas/conversation_attribute_string_type":{"id":"components/schemas/conversation_attribute_string_type","kind":"json-schema","title":"Conversation Attribute (String)","data":{"title":"Conversation Attribute (String)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["string"]},"multiline":{"type":"boolean","description":"Whether this string attribute is multiline.","example":false}}}]}},"components/schemas/conversation_attribute_integer_type":{"id":"components/schemas/conversation_attribute_integer_type","kind":"json-schema","title":"Conversation Attribute (Integer)","data":{"title":"Conversation Attribute (Integer)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["integer"]}}}]}},"components/schemas/conversation_attribute_list_type":{"id":"components/schemas/conversation_attribute_list_type","kind":"json-schema","title":"Conversation Attribute (List)","data":{"title":"Conversation Attribute (List)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["list"]},"options":{"type":"array","description":"Predefined options for this attribute. Each option has a unique UUID used to identify it in the options management endpoints.","items":{"$ref":"#/components/schemas/conversation_attribute_option"}}}}]}},"components/schemas/conversation_attribute_decimal_type":{"id":"components/schemas/conversation_attribute_decimal_type","kind":"json-schema","title":"Conversation Attribute (Decimal)","data":{"title":"Conversation Attribute (Decimal)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["decimal"]}}}]}},"components/schemas/conversation_attribute_boolean_type":{"id":"components/schemas/conversation_attribute_boolean_type","kind":"json-schema","title":"Conversation Attribute (Boolean)","data":{"title":"Conversation Attribute (Boolean)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["boolean"]}}}]}},"components/schemas/conversation_attribute_datetime_type":{"id":"components/schemas/conversation_attribute_datetime_type","kind":"json-schema","title":"Conversation Attribute (Datetime)","data":{"title":"Conversation Attribute (Datetime)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["datetime"]}}}]}},"components/schemas/conversation_attribute_relationship_type":{"id":"components/schemas/conversation_attribute_relationship_type","kind":"json-schema","title":"Conversation Attribute (Relationship)","data":{"title":"Conversation Attribute (Relationship)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["relationship"]},"reference":{"type":"object","description":"Reference configuration for related objects.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"many"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["one","many"],"example":"many"},"object_type_id":{"type":"string","description":"The ID of the related custom object type.","example":"Test_Object"}}}}}]}},"components/schemas/conversation_attribute_files_type":{"id":"components/schemas/conversation_attribute_files_type","kind":"json-schema","title":"Conversation Attribute (Files)","data":{"title":"Conversation Attribute (Files)","allOf":[{"$ref":"#/components/schemas/conversation_attribute_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["files"]}}}]}},"components/schemas/conversation_attribute":{"id":"components/schemas/conversation_attribute","kind":"json-schema","title":"Conversation Attribute","data":{"title":"Conversation Attribute","x-tags":["Conversations Attributes"],"description":"Conversation Attributes represent custom metadata fields for conversations. They support type-specific properties: strings (multiline), lists (options), and relationships (reference).","discriminator":{"propertyName":"data_type","mapping":{"string":"#/components/schemas/conversation_attribute_string_type","integer":"#/components/schemas/conversation_attribute_integer_type","list":"#/components/schemas/conversation_attribute_list_type","decimal":"#/components/schemas/conversation_attribute_decimal_type","boolean":"#/components/schemas/conversation_attribute_boolean_type","datetime":"#/components/schemas/conversation_attribute_datetime_type","relationship":"#/components/schemas/conversation_attribute_relationship_type","files":"#/components/schemas/conversation_attribute_files_type"}},"oneOf":[{"$ref":"#/components/schemas/conversation_attribute_string_type"},{"$ref":"#/components/schemas/conversation_attribute_integer_type"},{"$ref":"#/components/schemas/conversation_attribute_list_type"},{"$ref":"#/components/schemas/conversation_attribute_decimal_type"},{"$ref":"#/components/schemas/conversation_attribute_boolean_type"},{"$ref":"#/components/schemas/conversation_attribute_datetime_type"},{"$ref":"#/components/schemas/conversation_attribute_relationship_type"},{"$ref":"#/components/schemas/conversation_attribute_files_type"}]}},"components/schemas/conversation_attribute_list":{"id":"components/schemas/conversation_attribute_list","kind":"json-schema","title":"Conversation Attribute List","data":{"title":"Conversation Attribute List","type":"object","description":"A list of all conversation attributes belonging to a workspace.","properties":{"type":{"type":"string","description":"The type of the object.","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of conversation attributes.","items":{"$ref":"#/components/schemas/conversation_attribute"}}}}},"components/schemas/conversation_attribute_option":{"id":"components/schemas/conversation_attribute_option","kind":"json-schema","title":"Conversation Attribute Option","data":{"title":"Conversation Attribute Option","type":"object","description":"A single option on a list-type conversation attribute.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique UUID identifier for this option. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"option_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the options management endpoints."},"children":[]}]}]}],"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"label":{"type":"string","description":"The display label for the option.","example":"High"},"archived":{"type":"boolean","description":"Whether this option is archived (soft-deleted).","example":false}}}},"components/schemas/create_conversation_attribute_option_request":{"id":"components/schemas/create_conversation_attribute_option_request","kind":"json-schema","title":"Create Conversation Attribute Option Request","data":{"title":"Create Conversation Attribute Option Request","type":"object","description":"Payload for adding a new option to a list-type conversation attribute.","required":["label"],"properties":{"label":{"type":"string","description":"The label for the new option.","example":"High"}}}},"components/schemas/update_conversation_attribute_option_request":{"id":"components/schemas/update_conversation_attribute_option_request","kind":"json-schema","title":"Update Conversation Attribute Option Request","data":{"title":"Update Conversation Attribute Option Request","type":"object","description":"Payload for renaming a list option on a conversation attribute.","required":["label"],"properties":{"label":{"type":"string","description":"The updated label for the option.","example":"Renamed"}}}},"components/schemas/create_conversation_attribute_request_base":{"id":"components/schemas/create_conversation_attribute_request_base","kind":"json-schema","title":"Create Conversation Attribute Request Base","data":{"title":"Create Conversation Attribute Request Base","type":"object","required":["name","data_type"],"properties":{"name":{"type":"string","description":"Name of the attribute.","example":"api_test_attr"},"description":{"type":"string","description":"Readable description of the attribute.","example":"Created via API test"},"data_type":{"type":"string","description":"The data type of the attribute. Allowed types: string, integer, list, decimal, boolean, datetime, relationship, files.","enum":["string","integer","list","decimal","boolean","datetime","relationship","files"],"example":"string"},"required":{"type":"boolean","description":"Whether this attribute is required.","example":false},"visible_to_team_ids":{"type":"array","description":"Team IDs that can see this attribute. Empty array means all teams.","items":{"type":"string"},"example":[]}}}},"components/schemas/create_conversation_attribute_string_request":{"id":"components/schemas/create_conversation_attribute_string_request","kind":"json-schema","title":"Create Conversation Attribute Request (String)","data":{"title":"Create Conversation Attribute Request (String)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["string"]},"multiline":{"type":"boolean","description":"Whether this string attribute is multiline.","example":false}}}]}},"components/schemas/create_conversation_attribute_integer_request":{"id":"components/schemas/create_conversation_attribute_integer_request","kind":"json-schema","title":"Create Conversation Attribute Request (Integer)","data":{"title":"Create Conversation Attribute Request (Integer)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["integer"]}}}]}},"components/schemas/create_conversation_attribute_list_request":{"id":"components/schemas/create_conversation_attribute_list_request","kind":"json-schema","title":"Create Conversation Attribute Request (List)","data":{"title":"Create Conversation Attribute Request (List)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","required":["options"],"properties":{"data_type":{"type":"string","enum":["list"]},"options":{"type":"array","minItems":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial options for this list attribute. Each option must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A list attribute needs at least 2 options."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/create_conversation_attribute_option_request"}}}}]}},"components/schemas/create_conversation_attribute_decimal_request":{"id":"components/schemas/create_conversation_attribute_decimal_request","kind":"json-schema","title":"Create Conversation Attribute Request (Decimal)","data":{"title":"Create Conversation Attribute Request (Decimal)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["decimal"]}}}]}},"components/schemas/create_conversation_attribute_boolean_request":{"id":"components/schemas/create_conversation_attribute_boolean_request","kind":"json-schema","title":"Create Conversation Attribute Request (Boolean)","data":{"title":"Create Conversation Attribute Request (Boolean)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["boolean"]}}}]}},"components/schemas/create_conversation_attribute_datetime_request":{"id":"components/schemas/create_conversation_attribute_datetime_request","kind":"json-schema","title":"Create Conversation Attribute Request (Datetime)","data":{"title":"Create Conversation Attribute Request (Datetime)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["datetime"]}}}]}},"components/schemas/create_conversation_attribute_relationship_request":{"id":"components/schemas/create_conversation_attribute_relationship_request","kind":"json-schema","title":"Create Conversation Attribute Request (Relationship)","data":{"title":"Create Conversation Attribute Request (Relationship)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","required":["reference"],"properties":{"data_type":{"type":"string","enum":["relationship"]},"reference":{"type":"object","description":"Reference configuration for related objects.","required":["type","object_type_id"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"many"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["one","many"]},"object_type_id":{"type":"string","description":"The ID of the related custom object type. It must match an existing custom object type."}}}}}]}},"components/schemas/create_conversation_attribute_files_request":{"id":"components/schemas/create_conversation_attribute_files_request","kind":"json-schema","title":"Create Conversation Attribute Request (Files)","data":{"title":"Create Conversation Attribute Request (Files)","allOf":[{"$ref":"#/components/schemas/create_conversation_attribute_request_base"},{"type":"object","properties":{"data_type":{"type":"string","enum":["files"]}}}]}},"components/schemas/create_conversation_attribute_request":{"id":"components/schemas/create_conversation_attribute_request","kind":"json-schema","title":"Create Conversation Attribute Request","data":{"title":"Create Conversation Attribute Request","description":"Payload for creating a new conversation attribute.","discriminator":{"propertyName":"data_type","mapping":{"string":"#/components/schemas/create_conversation_attribute_string_request","integer":"#/components/schemas/create_conversation_attribute_integer_request","list":"#/components/schemas/create_conversation_attribute_list_request","decimal":"#/components/schemas/create_conversation_attribute_decimal_request","boolean":"#/components/schemas/create_conversation_attribute_boolean_request","datetime":"#/components/schemas/create_conversation_attribute_datetime_request","relationship":"#/components/schemas/create_conversation_attribute_relationship_request","files":"#/components/schemas/create_conversation_attribute_files_request"}},"oneOf":[{"$ref":"#/components/schemas/create_conversation_attribute_string_request"},{"$ref":"#/components/schemas/create_conversation_attribute_integer_request"},{"$ref":"#/components/schemas/create_conversation_attribute_list_request"},{"$ref":"#/components/schemas/create_conversation_attribute_decimal_request"},{"$ref":"#/components/schemas/create_conversation_attribute_boolean_request"},{"$ref":"#/components/schemas/create_conversation_attribute_datetime_request"},{"$ref":"#/components/schemas/create_conversation_attribute_relationship_request"},{"$ref":"#/components/schemas/create_conversation_attribute_files_request"}]}},"components/schemas/update_conversation_attribute_request":{"id":"components/schemas/update_conversation_attribute_request","kind":"json-schema","title":"Update Conversation Attribute Request","data":{"title":"Update Conversation Attribute Request","type":"object","description":"Payload for updating a conversation attribute.","properties":{"name":{"type":"string","description":"Name of the attribute.","example":"api_test_renamed"},"description":{"type":"string","description":"Readable description of the attribute.","example":"Updated via API"},"multiline":{"type":"boolean","description":"(String data type only) Whether this string attribute is multiline.","example":false},"required":{"type":"boolean","description":"Whether this attribute is required.","example":false},"visible_to_team_ids":{"type":"array","description":"Team IDs that can see this attribute. Empty array means all teams.","items":{"type":"string"},"example":[]},"reference":{"type":"object","description":"(Relationship data type only) Reference configuration for related objects.","required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardinality of the relationship: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"many"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["one","many"]},"object_type_id":{"type":"string","description":"The ID of the related custom object type."}}}}}},"components/schemas/create_data_connector_request":{"id":"components/schemas/create_data_connector_request","kind":"json-schema","title":"Create Data Connector Request","data":{"title":"Create Data Connector Request","type":"object","description":"You can create a data connector by providing the required parameters.","properties":{"name":{"type":"string","description":"The name of the data connector.","example":"Get Order Status"},"description":{"type":"string","description":"A description of what this data connector does.","example":"Looks up order status from an external service"},"internal_description":{"type":"string","description":"The internal description of the data connector. If omitted, it is an empty string."},"http_method":{"type":"string","description":"The HTTP method used when calling the external API.","enum":["get","post","put","delete","patch"],"example":"get"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the external API endpoint. Supports template variables like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{order_id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://api.example.com/orders/{{order_id}}/status"},"body":{"type":"string","description":"The request body template. Supports template variables."},"direct_fin_usage":{"type":"boolean","description":"Whether the connector is used directly by Fin (true) or only in workflows (false). Defaults to false.","example":false},"audiences":{"type":"array","description":"The user types this connector is available for.","items":{"type":"string","enum":["leads","users","visitors"]},"example":["leads","visitors"]},"headers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP headers to include in the request. Don't put credentials such as API keys here: header values are recorded unmasked in the connector's execution logs, except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is always masked. Attach an authentication token with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead; its value is masked in execution logs."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The header name.","example":"Content-Type"},"value":{"type":"string","description":"The header value. Supports template variables.","example":"application/json"}},"required":["name","value"]}},"data_inputs":{"type":"array","description":"Input parameters accepted by the connector.","items":{"type":"object","properties":{"name":{"type":"string","description":"The parameter name.","example":"order_id"},"type":{"type":"string","description":"The parameter type.","enum":["string","integer","decimal","boolean"],"example":"string"},"description":{"type":"string","description":"A description of the parameter.","example":"The order ID to look up"},"required":{"type":"boolean","description":"Whether the parameter is required.","example":true},"default_value":{"type":"string","description":"The default value for the parameter. Defaults to an empty string if omitted."}},"required":["name","description","type","required"]}},"customer_authentication":{"type":"boolean","description":"Whether the connector requires customer authentication before executing. Defaults to false.","example":false},"bypass_authentication":{"type":"boolean","description":"Whether authentication is bypassed entirely (public endpoint). Defaults to false.","example":false},"enforce_auth":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether authentication is enforced. On workspaces where this is supported, it takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bypass_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent together, and setting it to false disables OTP."},"children":[]}]}]}]},"validate_missing_attributes":{"type":"boolean","description":"Whether to validate that all required data inputs have values before executing.","example":false},"mock_response":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sample JSON response from the external API. Auto-generates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"configuration_response_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mock_response_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"order":{"id":12345,"status":"shipped"}}},"token_ids":{"type":"array","description":"IDs of authentication tokens to attach to this data connector.","items":{"type":"string"},"example":["1234","5678"]}},"required":["name"]}},"components/schemas/update_data_connector_request":{"id":"components/schemas/update_data_connector_request","kind":"json-schema","title":"Update Data Connector Request","data":{"title":"Update Data Connector Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing data connector. All fields are optional — only provided fields will be updated. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change the connector's state."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"The name of the data connector.","example":"Updated Connector Name"},"description":{"type":"string","description":"A description of what this data connector does.","example":"Updated description"},"internal_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal description of the data connector. If omitted, it keeps its current value, unless the connector has no internal description yet, in which case it is set to the connector's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"state":{"type":"string","description":"The desired state of the connector.","enum":["draft","live"]},"http_method":{"type":"string","description":"The HTTP method used by the data connector.","enum":["get","post","put","delete","patch"],"example":"post"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the external API endpoint. Supports template variables like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{order_id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://api.example.com/orders/{{order_id}}/status"},"body":{"type":"string","description":"The request body template. Supports template variables."},"direct_fin_usage":{"type":"boolean","description":"Whether this connector is used directly by Fin.","example":false},"audiences":{"type":"array","description":"The audience types this connector targets.","items":{"type":"string","enum":["leads","users","visitors"]},"example":["leads","users"]},"headers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP headers to include in the request. Don't put credentials such as API keys here: header values are recorded unmasked in the connector's execution logs, except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is always masked. Attach an authentication token with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead; its value is masked in execution logs."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The header name.","example":"Content-Type"},"value":{"type":"string","description":"The header value. Supports template variables.","example":"application/json"}},"required":["name","value"]}},"data_inputs":{"type":"array","description":"The input parameters accepted by this data connector. Replaces all existing inputs.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the input parameter.","example":"order_id"},"type":{"type":"string","description":"The data type of the input.","enum":["string","integer","decimal","boolean"],"example":"string"},"description":{"type":"string","description":"A description of the input parameter. Required for each input.","example":"The order ID to look up"},"required":{"type":"boolean","description":"Whether this input is required.","example":true},"default_value":{"type":"string","description":"The default value for this input, if any."}},"required":["name","description","type","required"]}},"customer_authentication":{"type":"boolean","description":"Whether OTP authentication is enabled for this connector.","example":false},"bypass_authentication":{"type":"boolean","description":"Whether authentication is bypassed for this connector.","example":false},"enforce_auth":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether authentication is enforced. On workspaces where this is supported, it takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bypass_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sent together, and setting it to false disables OTP."},"children":[]}]}]}]},"validate_missing_attributes":{"type":"boolean","description":"Whether to validate missing attributes before execution.","example":true},"mock_response":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sample JSON response from the external API. Auto-generates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"configuration_response_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mock_response_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"order":{"id":12345,"status":"shipped"}}},"token_ids":{"type":"array","description":"IDs of authentication tokens to attach to this data connector. An empty array removes all tokens.","items":{"type":"string"},"example":["1234","5678"]}}}},"components/schemas/data_connector":{"id":"components/schemas/data_connector","kind":"json-schema","title":"Data Connector","data":{"title":"Data Connector","type":"object","x-tags":["Data Connectors"],"description":"A data connector allows you to make HTTP requests to external APIs from Intercom workflows and AI agents.\n","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_connector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["data_connector"],"example":"data_connector"},"id":{"type":"string","description":"The unique identifier for the data connector.","example":"12345"},"name":{"type":"string","description":"The name of the data connector.","example":"Order Status Service"},"description":{"type":"string","nullable":true,"description":"A description of what this data connector does.","example":"Fetches order status from external fulfillment API"},"internal_description":{"type":"string","description":"The internal description of the data connector."},"state":{"type":"string","description":"The current state of the data connector.","enum":["draft","live"],"example":"live"},"http_method":{"type":"string","description":"The HTTP method used by the data connector.","enum":["get","post","put","delete","patch"],"example":"post"},"enforce_auth":{"type":"boolean","description":"Whether authentication is enforced for this connector.","example":true},"direct_fin_usage":{"type":"boolean","description":"Whether this data connector is assigned to Fin for direct usage.","example":false},"created_by_admin_id":{"type":"string","description":"The ID of the admin who created this data connector.","example":"12345"},"updated_by_admin_id":{"type":"string","description":"The ID of the admin who last updated this data connector.","example":"12345"},"created_at":{"type":"string","format":"date-time","description":"The time the data connector was created.","example":"2025-11-15T09:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the data connector was last updated.","example":"2026-01-20T14:22:15Z"},"execution_results_url":{"type":"string","description":"The URL path to fetch execution results for this connector.","example":"/data_connectors/12345/execution_results"}}}},"components/schemas/data_connector_detail":{"id":"components/schemas/data_connector_detail","kind":"json-schema","title":"Data Connector (Detail)","data":{"title":"Data Connector (Detail)","type":"object","x-tags":["Data Connectors"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full detail view of a data connector, returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /data_connectors/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /data_connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /data_connectors/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes configuration, data inputs, response fields, and object mappings."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_connector"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["data_connector"],"example":"data_connector"},"id":{"type":"string","description":"The unique identifier for the data connector.","example":"12345"},"name":{"type":"string","description":"The name of the data connector.","example":"Order Status Service"},"description":{"type":"string","nullable":true,"description":"A description of what this data connector does.","example":"Fetches order status from external fulfillment API"},"internal_description":{"type":"string","description":"The internal description of the data connector."},"state":{"type":"string","description":"The current state of the data connector.","enum":["draft","live"],"example":"live"},"url":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the external API endpoint. Supports template variables like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{order_id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://api.example.com/orders/{{order_id}}/status"},"body":{"type":"string","description":"The request body template. Supports template variables.","example":"{\"text\": \"{{message}}\"}"},"headers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP headers for the request. Header values are always redacted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"****\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in responses."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The header name.","example":"Authorization"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"****\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in responses."},"children":[]}]}]}],"example":"****"}}},"example":[{"name":"Authorization","value":"****"}]},"http_method":{"type":"string","description":"The HTTP method used by the data connector.","enum":["get","post","put","delete","patch"],"example":"post"},"direct_fin_usage":{"type":"boolean","description":"Whether this connector is used directly by Fin.","example":false},"audiences":{"type":"array","description":"The audience types this connector targets.","items":{"type":"string","enum":["users","leads","visitors"]},"example":["users","leads"]},"execution_type":{"type":"string","description":"How the connector executes.","enum":["server_side","client_side"],"example":"server_side"},"configuration_response_type":{"type":"string","description":"The expected response format from the connector.","enum":["test_response_type","mock_response_type"],"example":"test_response_type"},"data_transformation_type":{"type":"string","description":"The type of data transformation applied to the response.","enum":["full_access","redacted_access","code_block_transformation"]},"transform_code_block":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code block used to transform the connector's response. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_transformation_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code_block_transformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a code block exists; otherwise omitted."},"children":[]}]}]}],"example":{"code":"def transform(response):\n    return {\"status\": response[\"order_status\"]}\n\nreturn transform(inputs['data'])\n","language":"python"},"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source code of the transform code block. The API response body is available as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inputs['data']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The code must "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the transformed value."},"children":[]}]}]}],"example":"def transform(response):\n    return {\"status\": response[\"order_status\"]}\n\nreturn transform(inputs['data'])\n"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The programming language of the transform code block. Currently always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"python"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"python"}}},"client_function_name":{"type":"string","nullable":true,"description":"The name of the client-side function, if applicable."},"client_function_timeout_ms":{"type":"integer","nullable":true,"description":"Timeout in milliseconds for the client function, if applicable."},"data_inputs":{"type":"array","description":"The input parameters accepted by this data connector.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the input parameter.","example":"conversation_id"},"type":{"type":"string","description":"The data type of the input.","enum":["string","integer","decimal","boolean"],"example":"string"},"description":{"type":"string","nullable":true,"description":"A description of the input parameter."},"required":{"type":"boolean","description":"Whether this input is required.","example":true},"default_value":{"type":"string","description":"The default value for this input, if any."}}}},"response_fields":{"type":"array","description":"The fields returned in the connector response.","items":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path of the response field.","example":"status"},"type":{"type":"string","description":"The data type of the response field.","enum":["unknown","string","integer","decimal","datetime","boolean"],"example":"string"},"example_value":{"nullable":true,"description":"An example value for this field.","example":"ok"},"redacted":{"type":"boolean","description":"Whether this field is redacted in logs.","example":false}}}},"object_mappings":{"type":"array","description":"Mappings from connector response objects to Intercom objects.","items":{"type":"object","properties":{"response_object_path":{"type":"string"},"intercom_object_type":{"type":"string","enum":["conversation","user"]},"attribute_mappings":{"type":"array","items":{"type":"object","properties":{"response_attribute_path":{"type":"string"},"intercom_attribute_identifier":{"type":"string"},"mapping_type":{"type":"string","enum":["primitive_mapping","context_mapping"]}}}},"reference_mappings":{"type":"array","items":{"type":"object","properties":{"intercom_object_type":{"type":"string","enum":["conversation","user"]},"intercom_attribute_identifier":{"type":"string"}}}}}}},"token_ids":{"type":"array","description":"IDs of authentication tokens associated with this connector.","items":{"type":"string"},"example":[]},"customer_authentication":{"type":"boolean","description":"Whether OTP authentication is enabled for this connector.","example":false},"bypass_authentication":{"type":"boolean","description":"Whether authentication is bypassed for this connector.","example":false},"enforce_auth":{"type":"boolean","description":"Whether authentication is enforced for this connector.","example":true},"validate_missing_attributes":{"type":"boolean","nullable":true,"description":"Whether to validate missing attributes before execution."},"created_by_admin_id":{"type":"string","nullable":true,"description":"The ID of the admin who created this connector.","example":"456"},"updated_by_admin_id":{"type":"string","nullable":true,"description":"The ID of the admin who last updated this connector.","example":"456"},"created_at":{"type":"string","format":"date-time","description":"The time the data connector was created.","example":"2025-11-15T09:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the data connector was last updated.","example":"2026-01-20T14:22:15Z"},"execution_results_url":{"type":"string","description":"The URL path to fetch execution results for this connector.","example":"/data_connectors/12345/execution_results"}}}},"components/schemas/data_connector_execution_result":{"id":"components/schemas/data_connector_execution_result","kind":"json-schema","title":"Data Connector Execution Result","data":{"title":"Data Connector Execution Result","type":"object","x-tags":["Data Connectors"],"description":"An execution result from a data connector HTTP request.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_connector.execution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["data_connector.execution"],"example":"data_connector.execution"},"id":{"type":"string","description":"The unique identifier for the execution result.","example":"99001"},"data_connector_id":{"type":"string","description":"The unique identifier of the data connector that produced this result.","example":"12345"},"success":{"type":"boolean","description":"Whether the execution was successful.","example":true},"http_status":{"type":"integer","nullable":true,"description":"The HTTP status code returned by the external API.","example":200},"http_method":{"type":"string","description":"The HTTP method used for the request.","enum":["get","post","put","delete","patch"],"example":"post"},"error_type":{"type":"string","nullable":true,"description":"The type of error that occurred, if any.","enum":["request_configuration_error","faraday_error","3rd_party_error","response_mapping_error","token_refresh_error","fin_action_response_formatting_error","fin_action_identity_verification_error","email_verification_error","non_fin_standalone_action_identity_verification_error","request_validation_error","client_side_action_error","code_block_transformation_error","otp_preview_not_supported_error"],"example":"3rd_party_error"},"error_message":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable error message. Any http or https URLs in it are redacted the same way as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the rest of the message is returned as is."},"children":[]}]}]}],"example":"Connection refused"},"execution_time_ms":{"type":"integer","nullable":true,"description":"The execution time in milliseconds.","example":245},"source_type":{"type":"string","nullable":true,"description":"The type of source that triggered this execution.","enum":["custom_bot","inbound_custom_bot","button_custom_bot","answer","workflow","saved_reply","triggerable_custom_bot","inbox","fin","synthetic_test"],"example":"workflow"},"source_id":{"type":"string","nullable":true,"description":"The identifier of the source that triggered this execution.","example":"5001"},"conversation_id":{"type":"string","nullable":true,"description":"The conversation associated with this execution, if any.","example":"8001"},"created_at":{"type":"string","format":"date-time","description":"The time the execution occurred.","example":"2026-02-10T18:15:32Z"},"request_url":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request URL. Query parameters, userinfo, and fragments are redacted. For some hosts that put credentials in the path, the path is removed too. A suffix such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" [query params redacted]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" [credentials redacted]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is appended when anything is redacted, and a URL that cannot be parsed becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[invalid URL redacted]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://api.example.com/webhook"},"request_body":{"type":"string","nullable":true,"description":"The request body sent to the external API.","example":"{\"message\": \"hello\"}"},"response_body":{"type":"string","nullable":true,"description":"The response body from the external API.","example":"{\"status\": \"ok\"}"},"raw_response_body":{"type":"string","nullable":true,"description":"The raw (unmapped) response body.","example":"{\"status\": \"ok\"}"}}}},"components/schemas/data_connector_execution_result_list":{"id":"components/schemas/data_connector_execution_result_list","kind":"json-schema","title":"Data Connector Execution Result List","data":{"title":"Data Connector Execution Result List","type":"object","description":"A paginated list of data connector execution results.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of execution result objects.","items":{"$ref":"#/components/schemas/data_connector_execution_result"}},"pages":{"type":"object","description":"Pagination information.","properties":{"type":{"type":"string","example":"pages","enum":["pages"]},"per_page":{"type":"integer","description":"The number of results per page.","example":10},"next":{"type":"object","nullable":true,"description":"Cursor for the next page of results.","properties":{"starting_after":{"type":"string","description":"The cursor value to use for the next page.","example":"WzE3NzA3NDU1MTUuMCw5OTAwMCxudWxsXQ=="}}}}}}}},"components/schemas/data_connector_list":{"id":"components/schemas/data_connector_list","kind":"json-schema","title":"Data Connector List","data":{"title":"Data Connector List","type":"object","description":"A paginated list of data connectors.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of data connector objects.","items":{"$ref":"#/components/schemas/data_connector"}},"pages":{"type":"object","description":"Pagination information.","properties":{"type":{"type":"string","example":"pages","enum":["pages"]},"per_page":{"type":"integer","description":"The number of results per page.","example":20},"next":{"type":"object","nullable":true,"description":"Cursor for the next page of results.","properties":{"starting_after":{"type":"string","description":"The cursor value to use for the next page.","example":"WzE3Njg5MTg5MzUuMCwxMjM0NSxudWxsXQ=="}}}}}}}},"components/schemas/data_connector_version_list":{"id":"components/schemas/data_connector_version_list","kind":"json-schema","title":"Data Connector Version List","data":{"title":"Data Connector Version List","type":"object","description":"A paginated list of data connector versions, newest first.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of data connector version objects.","items":{"$ref":"#/components/schemas/data_connector_version"}},"pages":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination information. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted on the last page."},"children":[]}]}]}],"properties":{"type":{"type":"string","example":"pages","enum":["pages"]},"per_page":{"type":"integer","description":"The number of results per page.","example":20},"next":{"type":"object","description":"Cursor for the next page of results.","properties":{"starting_after":{"type":"string","description":"The cursor value to use for the next page.","example":"WzQ0MDksNDQwOSxudWxsXQ=="}}}}}}}},"components/schemas/data_connector_version":{"id":"components/schemas/data_connector_version","kind":"json-schema","title":"Data Connector Version","data":{"title":"Data Connector Version","type":"object","x-tags":["Data Connectors"],"description":"A point-in-time snapshot of a data connector's configuration, with the version's status and an optional note.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_connector_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["data_connector_version"],"example":"data_connector_version"},"status":{"type":"string","description":"The status of this version today.","enum":["live","paused","draft","previously_live"],"example":"live"},"note":{"type":"string","nullable":true,"description":"A note describing this version, if one has been set.","example":"Switched to the v2 orders endpoint"},"author":{"type":"object","nullable":true,"description":"The teammate who created this version.","properties":{"id":{"type":"integer","description":"The unique identifier of the teammate.","example":456},"name":{"type":"string","description":"The name of the teammate.","example":"Alice Admin"}}},"created_at":{"type":"string","format":"date-time","description":"The time this version was created.","example":"2026-09-14T10:02:11Z"},"entity_version_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of this version. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when retrieving or updating a version."},"children":[]}]}]}],"example":9821},"definition":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data connector's configuration at this version. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the snapshot is no longer available. Mirrors the response of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnector"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a data connector"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_by_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_by_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_results_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transform_code_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"The name of the data connector.","example":"Order Status Service"},"description":{"type":"string","nullable":true,"description":"A description of what this data connector does."},"internal_description":{"type":"string","nullable":true,"description":"The internal description of the data connector."},"state":{"type":"string","description":"The state of the data connector at this version.","example":"live"},"url":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the external API endpoint. Supports template variables like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{order_id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"body":{"type":"string","nullable":true,"description":"The request body template. Supports template variables."},"headers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP headers for the request. Header values are always redacted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"****\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"Authorization"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"****\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in responses."},"children":[]}]}]}],"example":"****"}}}},"http_method":{"type":"string","description":"The HTTP method used by the data connector.","example":"get"},"direct_fin_usage":{"type":"boolean","description":"Whether this connector is used directly by Fin."},"audiences":{"type":"array","description":"The audience types this connector targets.","items":{"type":"string"}},"execution_type":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the connector executes, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"server_side"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_side"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"configuration_response_type":{"type":"string","nullable":true,"description":"The expected response format from the connector."},"data_transformation_type":{"type":"string","nullable":true,"description":"The type of data transformation applied to the response."},"client_function_name":{"type":"string","nullable":true,"description":"The name of the client-side function, if applicable."},"client_function_timeout_ms":{"type":"integer","nullable":true,"description":"Timeout in milliseconds for the client function, if applicable."},"data_inputs":{"type":"array","description":"The input parameters accepted by this data connector.","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"description":{"type":"string","nullable":true},"required":{"type":"boolean"},"default_value":{}}}},"response_fields":{"type":"array","description":"The fields returned in the connector response.","items":{"type":"object","properties":{"path":{"type":"string"},"type":{"type":"string"},"example_value":{},"redacted":{"type":"boolean"}}}},"object_mappings":{"type":"array","description":"Mappings from connector response objects to Intercom objects.","items":{"type":"object","properties":{"response_object_path":{"type":"string"},"intercom_object_type":{"type":"string"},"attribute_mappings":{"type":"array","items":{"type":"object","properties":{"response_attribute_path":{"type":"string"},"intercom_attribute_identifier":{"type":"string"},"mapping_type":{"type":"string"}}}},"reference_mappings":{"type":"array","items":{"type":"object","properties":{"intercom_object_type":{"type":"string"},"intercom_attribute_identifier":{"type":"string"}}}}}}},"token_ids":{"type":"array","description":"IDs of authentication tokens associated with this connector.","items":{"type":"string"}},"customer_authentication":{"type":"boolean","description":"Whether OTP authentication is enabled for this connector."},"bypass_authentication":{"type":"boolean","description":"Whether authentication is bypassed for this connector."},"enforce_auth":{"type":"boolean","nullable":true,"description":"Whether authentication is enforced for this connector."},"validate_missing_attributes":{"type":"boolean","nullable":true,"description":"Whether to validate missing attributes before execution."}}}}}},"components/schemas/update_data_connector_version_request":{"id":"components/schemas/update_data_connector_version_request","kind":"json-schema","title":"Update Data Connector Version Request","data":{"title":"Update Data Connector Version Request","type":"object","description":"Payload for updating a data connector version.","required":["note"],"properties":{"note":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new note for the version. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an empty string, or a whitespace-only string clears the note."},"children":[]}]}]}],"example":"Switched to the v2 orders endpoint"}}}},"components/schemas/deleted_data_connector_object":{"id":"components/schemas/deleted_data_connector_object","kind":"json-schema","title":"Deleted Data Connector Object","data":{"title":"Deleted Data Connector Object","type":"object","description":"Response returned when a data connector is deleted.","properties":{"id":{"type":"string","description":"The unique identifier for the data connector.","example":"125"},"object":{"type":"string","description":"The type of object which was deleted.","enum":["data_connector"],"example":"data_connector"},"deleted":{"type":"boolean","description":"Whether the data connector was deleted successfully.","example":true}}}},"components/schemas/data_event":{"id":"components/schemas/data_event","kind":"json-schema","title":"Data Event","data":{"title":"Data Event","type":"object","x-tags":["Data Events"],"description":"Data events are used to notify Intercom of changes to your data.","properties":{"type":{"type":"string","description":"The type of the object","enum":["event"],"example":"event"},"event_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated-plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"invited-friend"},"created_at":{"type":"integer","format":"date-time","description":"The time the event occurred as a UTC Unix timestamp","example":1671028894},"user_id":{"type":"string","description":"Your identifier for the user.","example":"314159"},"id":{"type":"string","description":"Your identifier for a lead or a user.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"intercom_user_id":{"type":"string","description":"The Intercom identifier for the user.","example":"63a0979a5eeebeaf28dd56ba"},"email":{"type":"string","description":"An email address for your user. An email should only be used where your application uses email to uniquely identify users.","example":"frodo.baggins@example.com"},"metadata":{"type":"object","description":"Optional metadata about the event. Values keep the type they were sent with.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"example":{"invite_code":"ADDAFRIEND"}}},"required":["event_name","created_at"]}},"components/schemas/data_event_list":{"id":"components/schemas/data_event_list","kind":"json-schema","title":"Data Event List","data":{"title":"Data Event List","type":"object","description":"This will return a list of data events for the App.","properties":{"type":{"type":"string","description":"The type of the object","enum":["event.list"],"example":"event.list"},"events":{"type":"array","description":"A list of data events","items":{"$ref":"#/components/schemas/data_event"}},"pages":{"type":"object","description":"Pagination","properties":{"next":{"type":"string","example":"https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user\""},"since":{"type":"string","example":"https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065"}}}}}},"components/schemas/data_event_summary":{"id":"components/schemas/data_event_summary","kind":"json-schema","title":"Data Event Summary","data":{"title":"Data Event Summary","type":"object","description":"This will return a summary of data events for the App.","properties":{"type":{"type":"string","description":"The type of the object","enum":["event.summary"],"example":"event.summary"},"email":{"type":"string","description":"The email address of the user","example":"Sam.Sung@example.com"},"intercom_user_id":{"type":"string","description":"The Intercom user ID of the user","example":"63a0979a5eeebeaf28dd56ba"},"user_id":{"type":"string","description":"The user ID of the user","example":"62b997f288e14803c5006932"},"events":{"type":"array","description":"A summary of data events","items":{"$ref":"#/components/schemas/data_event_summary_item"}}}}},"components/schemas/data_event_summary_item":{"id":"components/schemas/data_event_summary_item","kind":"json-schema","title":"Data Event Summary Item","data":{"title":"Data Event Summary Item","type":"object","description":"This will return a summary of a data event for the App.","nullable":true,"properties":{"name":{"type":"string","description":"The name of the event","example":"placed-order"},"first":{"type":"string","description":"The first time the event was sent","example":"2014-01-16T23:12:21.000+00:00"},"last":{"type":"string","description":"The last time the event was sent","example":"2014-01-16T23:12:21.000+00:00 "},"count":{"type":"integer","description":"The number of times the event was sent","example":1},"description":{"type":"string","description":"The description of the event","example":"A user placed an order"}}}},"components/schemas/data_export":{"id":"components/schemas/data_export","kind":"json-schema","title":"Data Export","data":{"title":"Data Export","type":"object","x-tags":["Data Export"],"description":"The data export API is used to export message delivery and engagement statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more) sent in a given timeframe. The exported data includes who received each message, when they received it, and how they engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).","properties":{"job_identifier":{"type":"string","description":"The identifier for your job.","example":"orzzsbd7hk67xyu"},"status":{"type":"string","enum":["pending","in_progress","failed","completed","no_data","canceled"],"description":"The current state of your job.","example":"pending"},"download_expires_at":{"type":"string","description":"The time after which you will not be able to access the data, as a Unix timestamp. It is one week from the time the job was created. Empty until the job completes.","example":"1674917488"},"download_url":{"type":"string","description":"The location where you can download your data. Empty until the job completes.","example":"https://api.intercom.io/download/content/data/orzzsbd7hk67xyu"}}}},"components/schemas/data_export_csv":{"id":"components/schemas/data_export_csv","kind":"json-schema","title":"Data Export CSV","data":{"title":"Data Export CSV","type":"object","description":"A CSV output file","properties":{"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user_id of the user who was sent the message."},"children":[]}]}]}]},"user_external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external_user_id of the user who was sent the message"},"children":[]}]}]}]},"company_id":{"type":"string","description":"The company ID of the user in relation to the message that was sent. Will return -1 if no company is present."},"email":{"type":"string","description":"The users email who was sent the message."},"name":{"type":"string","description":"The full name of the user receiving the message"},"ruleset_id":{"type":"string","description":"The id of the message."},"content_id":{"type":"string","description":"The specific content that was received. In an A/B test each version has its own Content ID."},"content_type":{"type":"string","description":"Email, Chat, Post etc."},"content_title":{"type":"string","description":"The title of the content you see in your Intercom workspace."},"ruleset_version_id":{"type":"string","description":"As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received."},"receipt_id":{"type":"string","description":"ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message."},"received_at":{"type":"integer","description":"Timestamp for when the receipt was recorded."},"series_id":{"type":"string","description":"The id of the series that this content is part of. Will return -1 if not part of a series."},"series_title":{"type":"string","description":"The title of the series that this content is part of."},"node_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id."},"children":[]}]}]}]},"first_reply":{"type":"integer","description":"The first time a user replied to this message if the content was able to receive replies. Only events within the export job's requested date range are counted."},"first_completion":{"type":"integer","description":"The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted."},"first_series_completion":{"type":"integer","description":"The first time the series this message was a part of was completed by the user. Only events within the export job's requested date range are counted."},"first_series_disengagement":{"type":"integer","description":"The first time the series this message was a part of was disengaged by the user. Only events within the export job's requested date range are counted."},"first_series_exit":{"type":"integer","description":"The first time the series this message was a part of was exited by the user. Only events within the export job's requested date range are counted."},"first_goal_success":{"type":"integer","description":"The first time the user met this messages associated goal if one exists. Only events within the export job's requested date range are counted."},"first_open":{"type":"integer","description":"The first time the user opened this message. Only events within the export job's requested date range are counted."},"first_click":{"type":"integer","description":"The first time the series the user clicked on a link within this message. Only events within the export job's requested date range are counted."},"first_dismisall":{"type":"integer","description":"The first time the series the user dismissed this message. Only events within the export job's requested date range are counted."},"first_unsubscribe":{"type":"integer","description":"The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted."},"first_hard_bounce":{"type":"integer","description":"The first time this message hard bounced for this user. Only events within the export job's requested date range are counted."}}}},"components/schemas/deleted_article_object":{"id":"components/schemas/deleted_article_object","kind":"json-schema","title":"Deleted Article Object","data":{"title":"Deleted Article Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the article which you provided in the URL.","example":"6890762"},"object":{"type":"string","description":"The type of object which was deleted. - article","enum":["article"],"example":"article"},"deleted":{"type":"boolean","description":"Whether the article was deleted successfully or not.","example":true}}}},"components/schemas/deleted_internal_article_object":{"id":"components/schemas/deleted_internal_article_object","kind":"json-schema","title":"Deleted Internal Article Object","data":{"title":"Deleted Internal Article Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the internal article which you provided in the URL.","example":"6890762"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object which was deleted. - internal_article"},"children":[]}]}]}],"enum":["internal_article"],"example":"internal_article"},"deleted":{"type":"boolean","description":"Whether the internal article was deleted successfully or not.","example":true}}}},"components/schemas/deleted_collection_object":{"id":"components/schemas/deleted_collection_object","kind":"json-schema","title":"Deleted Collection Object","data":{"title":"Deleted Collection Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the collection which you provided in the URL.","example":"6890762"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object which was deleted. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]}]}]}],"enum":["collection"],"example":"collection"},"deleted":{"type":"boolean","description":"Whether the collection was deleted successfully or not.","example":true}}}},"components/schemas/deleted_company_object":{"id":"components/schemas/deleted_company_object","kind":"json-schema","title":"Deleted Company Object","data":{"title":"Deleted Company Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the company which is given by Intercom.","example":"5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object which was deleted. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]}]}]}],"enum":["company"],"example":"company"},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The contacts are detached after the response is sent."},"children":[]}]}]}],"example":true}}}},"components/schemas/deleted_object":{"id":"components/schemas/deleted_object","kind":"json-schema","title":"Deleted Object","data":{"title":"Deleted Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the news item which you provided in the URL.","example":"6890762"},"object":{"type":"string","description":"The type of object which was deleted - news-item.","enum":["news-item"],"example":"news-item"},"deleted":{"type":"boolean","description":"Whether the news item was deleted successfully or not.","example":true}}}},"components/schemas/deleted_note_object":{"id":"components/schemas/deleted_note_object","kind":"json-schema","title":"Deleted Note Object","data":{"title":"Deleted Note Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the note which you provided in the URL.","example":"34"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object which was deleted. - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]}]}]}],"enum":["note"],"example":"note"},"deleted":{"type":"boolean","description":"Whether the note was deleted successfully or not.","example":true}}}},"components/schemas/detach_contact_from_conversation_request":{"id":"components/schemas/detach_contact_from_conversation_request","kind":"json-schema","title":"detach_contact_from_conversation_request","data":{"properties":{"admin_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the admin who is performing the action."},"children":[]}]}]}],"example":"5017690"}},"required":["admin_id"]}},"components/schemas/email_address_header":{"id":"components/schemas/email_address_header","kind":"json-schema","title":"Email Address Header","data":{"title":"Email Address Header","type":"object","description":"Contains data for an email address header for a conversation part that was sent as an email.","properties":{"type":{"type":"string","description":"The type of email address header","example":"from"},"email_address":{"type":"string","description":"The email address","example":"jdoe@example.com"},"name":{"type":"string","nullable":true,"description":"The name associated with the email address","example":"Joe Example"}}}},"components/schemas/email_message_metadata":{"id":"components/schemas/email_message_metadata","kind":"json-schema","title":"Email Message Metadata","data":{"title":"Email Message Metadata","type":"object","description":"Contains metadata if the message was sent as an email","properties":{"subject":{"type":"string","description":"The subject of the email","example":"Question about my order"},"email_address_headers":{"title":"Email Address Headers","type":"array","description":"A list of an email address headers.","items":{"$ref":"#/components/schemas/email_address_header"}},"message_id":{"type":"string","nullable":true,"description":"The unique identifier for the email message as specified in the Message-ID header","example":"<CADKw7xrXzqSn8v3mP8K8Q8yZ6K8Q8yZ6@mail.gmail.com>"}}}},"components/schemas/email_setting":{"id":"components/schemas/email_setting","kind":"json-schema","title":"Email Setting","data":{"type":"object","title":"Email Setting","description":"Represents a sender email address configuration","x-tags":["Emails"],"properties":{"type":{"type":"string","description":"The type of object","example":"email_setting"},"id":{"type":"string","description":"Unique email setting identifier","example":"10"},"email":{"type":"string","description":"Full sender email address","example":"support@company.com"},"verified":{"type":"boolean","description":"Whether the email address has been verified","example":true},"domain":{"type":"string","description":"Domain portion of the email address","example":"company.com"},"brand_id":{"type":"string","description":"Associated brand identifier","example":"10"},"forwarding_enabled":{"type":"boolean","description":"Whether email forwarding is active","example":true},"forwarded_email_last_received_at":{"type":"integer","format":"date-time","nullable":true,"description":"Unix timestamp of last forwarded email received (null if never)","example":1710498600},"created_at":{"type":"integer","format":"date-time","description":"Unix timestamp of creation","example":1692530400},"updated_at":{"type":"integer","format":"date-time","description":"Unix timestamp of last modification","example":1710498600}}}},"components/schemas/email_list":{"id":"components/schemas/email_list","kind":"json-schema","title":"Email List","data":{"type":"object","title":"Email List","description":"A list of email settings","x-tags":["Emails"],"properties":{"type":{"type":"string","description":"The type of object","example":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/email_setting"}}}}},"components/schemas/conversation_attribute_updated_by_workflow":{"id":"components/schemas/conversation_attribute_updated_by_workflow","kind":"json-schema","title":"Part type - conversation_attribute_updated_by_workflow","data":{"title":"Part type - conversation_attribute_updated_by_workflow","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_attribute_updated_by_workflow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"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"}}}}}},"components/schemas/conversation_attribute_updated_by_admin":{"id":"components/schemas/conversation_attribute_updated_by_admin","kind":"json-schema","title":"Part type - conversation_attribute_updated_by_admin","data":{"title":"Part type - conversation_attribute_updated_by_admin","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_attribute_updated_by_admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"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":"Current value of the CDA updated","example":"PROJ-007"},"previous":{"type":"string","nullable":true,"description":"Previous value of the CDA","example":"PROJ-006"}}}}}},"components/schemas/conversation_attribute_updated_by_user":{"id":"components/schemas/conversation_attribute_updated_by_user","kind":"json-schema","title":"Part type - conversation_attribute_updated_by_user","data":{"title":"Part type - conversation_attribute_updated_by_user","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains details about Custom Data Attributes (CDAs) that were modified by a user for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation_attribute_updated_by_user"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"attribute":{"type":"object","properties":{"name":{"type":"string","description":"Name of the CDA updated","example":"Priority"}}},"value":{"type":"object","properties":{"name":{"type":"string","description":"Current value of the CDA updated","example":"High"},"previous":{"type":"string","nullable":true,"description":"Previous value of the CDA (null for older events)","example":"Medium"}}}}}},"components/schemas/custom_action_started":{"id":"components/schemas/custom_action_started","kind":"json-schema","title":"Part type - custom_action_started","data":{"title":"Part type - custom_action_started","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains details about name of the action that was initiated for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_action_started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"action":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action","example":"Jira Create Issue"}}}}}},"components/schemas/custom_action_finished":{"id":"components/schemas/custom_action_finished","kind":"json-schema","title":"Part type - custom_action_finished","data":{"title":"Part type - custom_action_finished","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains details about final status of the completed action for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_action_finished"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"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"}}}}}},"components/schemas/operator_workflow_event":{"id":"components/schemas/operator_workflow_event","kind":"json-schema","title":"Part type - operator_workflow_event","data":{"title":"Part type - operator_workflow_event","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains details about name of the workflow for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator_workflow_event"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"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"}}}}}},"components/schemas/call_summary":{"id":"components/schemas/call_summary","kind":"json-schema","title":"Part type - call_summary","data":{"title":"Part type - call_summary","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the id of the call the summary describes, for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call_summary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A conversation can contain several calls, and therefore several call summaries, so this identifies which call each summary belongs to. The id matches the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by the Calls API and by the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call.started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call.ended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call.recording_available"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"call.transcription_available"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook topics."},"children":[]}]}]}],"properties":{"call_id":{"type":"string","description":"The id of the call the summary describes","example":"3822007689"}}}},"components/schemas/ai_agent_event_otp_email_verification_failed":{"id":"components/schemas/ai_agent_event_otp_email_verification_failed","kind":"json-schema","title":"Part type - ai_agent_event (otp_email_verification_failed)","data":{"title":"Part type - ai_agent_event (otp_email_verification_failed)","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the reason Fin could not verify a contact by one-time passcode email, for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent_event"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the event type is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otp_email_verification_failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Other "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ai_agent_event"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event types are not described here."},"children":[]}]}]}],"properties":{"event":{"type":"object","description":"The event the part records","example":{"type":"otp_email_verification_failed","value":"OTP email verification failed","data":{"otp_email_verification_failed":{"reason":"no_email"}}},"properties":{"type":{"type":"string","description":"The event type","example":"otp_email_verification_failed"},"value":{"type":"string","description":"A readable label for the event","example":"OTP email verification failed"},"data":{"type":"object","description":"Data recorded with the event. Empty when the failure was recorded without a reason.","example":{"otp_email_verification_failed":{"reason":"no_email"}},"properties":{"otp_email_verification_failed":{"type":"object","description":"Details of the failed verification","example":{"reason":"no_email"},"properties":{"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why the one-time passcode email could not verify the contact. Treat this as a free-form string and fall back to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a reason you do not recognise. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no_email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the contact has no email address on record."},"children":[]}]}]}],"example":"no_email"}}}}}}}}}},"components/schemas/event_details":{"id":"components/schemas/event_details","kind":"json-schema","title":"Event details of Workflow & actions","data":{"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/conversation_attribute_updated_by_user"},{"$ref":"#/components/schemas/custom_action_started"},{"$ref":"#/components/schemas/custom_action_finished"},{"$ref":"#/components/schemas/operator_workflow_event"},{"$ref":"#/components/schemas/call_summary"},{"$ref":"#/components/schemas/ai_agent_event_otp_email_verification_failed"},{"$ref":"#/components/schemas/standalone_platform_handoff"}]}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"Error","data":{"type":"object","title":"Error","description":"The API will return an Error List for a failed request, which will contain one or more Error objects.","properties":{"type":{"type":"string","description":"The type is error.list","example":"error.list"},"request_id":{"type":"string","nullable":true,"format":"uuid","description":"","example":"f93ecfa8-d08a-4325-8694-89aeb89c8f85"},"errors":{"type":"array","description":"An array of one or more error objects","items":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string indicating the kind of error, used to further qualify the HTTP response code. A few request validation errors send an HTTP status code as an integer here instead, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"unauthorized"},"message":{"type":"string","nullable":true,"description":"Optional. Human readable description of the error.","example":"Access Token Invalid"},"data":{"type":"object","nullable":true,"additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. Extra detail about the error, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_permissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a 403 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action_forbidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"example":{"required_permissions":["read_conversations"]}}},"required":["code"]}}},"required":["type","errors"]}},"components/schemas/external_page":{"id":"components/schemas/external_page","kind":"json-schema","title":"External Page","data":{"title":"External Page","type":"object","x-tags":["AI Content"],"description":"External pages that you have added to your Fin Content Library.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always external_page"},"children":[]}]}]}],"enum":["external_page"],"default":"external_page","example":"external_page"},"id":{"type":"string","description":"The unique identifier for the external page which is given by Intercom.","example":"1234"},"title":{"type":"string","description":"The title of the external page.","example":"Getting started with..."},"html":{"type":"string","description":"The body of the external page in HTML.","example":"<p>Hello world!</p>"},"url":{"type":"string","description":"The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.","example":"https://help.example.com/en/articles/1234-getting-started"},"ai_agent_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Agent.","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Sales Agent.","example":true},"fin_availability":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use ai_agent_availability and ai_copilot_availability instead."},"children":[]}]}]}],"example":true},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code of the external page, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"en"},"source_id":{"type":"integer","description":"The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.","example":1234},"external_id":{"type":"string","description":"The identifier for the external page which was given by the source. Must be unique for the source.","example":"5678"},"audience_ids":{"type":"array","description":"The list of audience IDs that this external page is targeted to for Fin AI Agent. Empty when the external page has no audience targeting.","items":{"type":"integer"},"example":[1,2]},"created_at":{"type":"integer","format":"date-time","description":"The time when the external page was created.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the external page was last updated.","example":1672928610},"last_ingested_at":{"type":"integer","format":"date-time","description":"The time when the external page was last ingested.","example":1672928610},"tags":{"description":"The tags applied to the external page.","allOf":[{"$ref":"#/components/schemas/tags"}]}},"required":["id","type","title","html","ai_agent_availability","ai_copilot_availability","locale","source_id","created_at","updated_at","last_ingested_at","external_id"]}},"components/schemas/external_pages_list":{"id":"components/schemas/external_pages_list","kind":"json-schema","title":"External Pages","data":{"title":"External Pages","type":"object","x-tags":["AI Content"],"description":"This will return a list of external pages for the App.","nullable":false,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of external pages.","example":1},"data":{"type":"array","description":"An array of External Page objects","items":{"$ref":"#/components/schemas/external_page"}}}}},"components/schemas/fin_agent_message":{"id":"components/schemas/fin_agent_message","kind":"json-schema","title":"Fin Agent Message","data":{"title":"Fin Agent Message","type":"object","description":"A message exchanged within a Fin Agent conversation.","x-tags":["Fin Agent"],"properties":{"author":{"type":"string","enum":["user","agent","fin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The author that created the message. In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_metadata.history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted."},"children":[]}]}]}],"example":"user"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the message. Accepts both plain text and HTML format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the message you send to Fin, this is the user's message. For an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_metadata.history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is the agent's message."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's response is returned in the format set by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (HTML by default)."},"children":[]}]}]}],"example":"How can I see my account details?"},"timestamp":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the message was created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to deduplicate messages sent within a 5 minute window."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ideally should include milliseconds for higher precision."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp_ms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; at least one is required. If you send both, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp_ms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sending neither fails with a 422 error ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message: timestamp_ms is required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_metadata.history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an item with neither causes the whole history to be ignored."},"children":[]}]}]}],"example":"2025-01-24T10:01:20.000Z"},"timestamp_ms":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the message was created, with millisecond precision."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted in place of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you send a message, and also present in webhook event responses (fin_replied). At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp_ms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"example":"2025-01-24T10:01:20.456Z"}},"required":["author","body"]}},"components/schemas/fin_agent_user":{"id":"components/schemas/fin_agent_user","kind":"json-schema","title":"Fin Agent User","data":{"title":"Fin Agent User","type":"object","description":"A user object representing the user in a Fin Agent conversation.","x-tags":["Fin Agent"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the user. This value will be used to uniquely identify the user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"during a conversation with Fin. Maps to the user_id field on the Intercom User object."},"children":[]}]}]}],"example":"123456"},"name":{"type":"string","description":"The name of the user.","example":"John Doe"},"email":{"type":"string","format":"email","description":"The email of the user.","example":"john.doe@example.com"},"attributes":{"type":"object","description":"A hash of attributes associated with the user.\nAttributes can be used by Fin to target content and responses.\nLimit to 10 attributes.\n","additionalProperties":true,"example":{"plan_type":"Pro","subscription_status":"active"}}},"required":["id"]}},"components/schemas/fin_agent_attachment":{"id":"components/schemas/fin_agent_attachment","kind":"json-schema","title":"Fin Agent Attachment","data":{"title":"Fin Agent Attachment","type":"object","description":"An attachment object representing a file or URL attachment included with a message.\nAttachments can be used to provide additional context to Fin.\nMaximum of 10 attachments per request.\n","x-tags":["Fin Agent"],"properties":{"type":{"type":"string","enum":["url","file"],"description":"The type of attachment.","example":"url"},"url":{"type":"string","format":"uri","description":"The URL of the attachment. Required when type is 'url'. Must be publicly accessible.","example":"https://example.com/document.pdf"},"name":{"type":"string","description":"The name of the file. Required when type is 'file'.","example":"screenshot.png"},"content_type":{"type":"string","description":"The MIME type of the file. Required when type is 'file'.","example":"image/png"},"data":{"type":"string","format":"byte","description":"Base64-encoded file data. Required when type is 'file'.","example":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk..."}},"required":["type"]}},"components/schemas/fin_agent_conversation_metadata":{"id":"components/schemas/fin_agent_conversation_metadata","kind":"json-schema","title":"Fin Agent Conversation Metadata","data":{"title":"Fin Agent Conversation Metadata","type":"object","description":"Metadata about the conversation, including history and attributes.","x-tags":["Fin Agent"],"properties":{"history":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of previous messages in the conversation before Fin is initialized."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This data provides context to Fin and helps generate a better answer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit to the last 10 messages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authors are accepted. If any item is invalid, for example it has no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp_ms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or has another author, the whole history is ignored."},"children":[]}]}]}],"maxItems":10,"items":{"$ref":"#/components/schemas/fin_agent_message"}},"attributes":{"type":"object","description":"A hash of attributes associated with the conversation.\nThese attributes can be used by Fin to provide more contextual responses.\nLimit to 20 attributes.\n","maxProperties":20,"additionalProperties":true,"example":{"priority_level":"high","department":"sales"}}}}},"components/schemas/fin_agent_attribute_errors":{"id":"components/schemas/fin_agent_attribute_errors","kind":"json-schema","title":"Fin Agent Attribute Errors","data":{"title":"Fin Agent Attribute Errors","type":"object","description":"Contains error details if any user or conversation attribute updates failed.","x-tags":["Fin Agent"],"properties":{"user":{"type":"object","description":"User-related attribute errors.","properties":{"attributes":{"type":"object","description":"Map of user attribute names to error messages.","additionalProperties":{"type":"string"},"example":{"invalid_attr":"User attribute 'invalid_attr' does not exist"}}}},"conversation":{"type":"object","description":"Conversation-related attribute errors.","properties":{"attributes":{"type":"object","description":"Map of conversation attribute names to error messages.","additionalProperties":{"type":"string"},"example":{"bad_attr":"Conversation attribute 'bad_attr' does not exist"}}}}}}},"components/schemas/fin_agent_status_updated_event":{"id":"components/schemas/fin_agent_status_updated_event","kind":"json-schema","title":"Fin Agent Status Updated Event","data":{"title":"Fin Agent Status Updated Event","type":"object","description":"Event fired when Fin's status changes during a conversation.\nDelivered via webhooks. Fin will report its status to the client via this event.\n","x-tags":["Fin Agent"],"properties":{"event_name":{"type":"string","enum":["fin_status_updated"],"description":"The name of the event.","example":"fin_status_updated"},"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"123456"},"user_id":{"type":"string","description":"The ID of the user.","example":"7891"},"status":{"type":"string","enum":["thinking","awaiting_user_reply","escalated","resolved","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's current status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thinking: Fin has started running a procedure. Not sent on every turn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"awaiting_user_reply: Fin has finished replying and is waiting for the user to respond"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"escalated: The conversation has been escalated to a human"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolved: The user's query has been resolved"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete: Fin has completed its workflow. When CSAT is enabled a csat_requested event may follow"},"children":[]}]}]}]}],"example":"escalated"},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. A human-readable explanation of why the conversation was escalated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only present when status is 'escalated'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you escalate deterministically with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/escalate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the reason is always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Escalation requested via API\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following reasons apply to Fin-decided escalations when Fin owns the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conversation ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/procedures/{procedure_id}/run"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a conversation that was started that way). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report any of them, because escalation rules still apply and the conversation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can still be routed to a team or finish without resolution. On an Ask,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Escalation requested by user\" normally only follows an escalation rule match."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Escalation requested by user\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Escalation rule: {rule_name}\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Escalation rule matched\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Routed to team\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Conversation finished without resolution\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Escalation requested by user\" is sent whenever Fin decides to hand over, not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only when the user asks for a human, for example on a procedure handoff or a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom answer handover. It also follows an escalation rule match, as a second"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event after the rule's reason. While a procedure is running, every"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"escalation Fin decides on reports it."},"children":[]}]}]}],"example":"Escalation requested via API"},"created_at_ms":{"type":"string","format":"date-time","description":"The timestamp the event was created at, with millisecond precision.","example":"2025-01-24T10:00:00.123Z"}},"required":["event_name","conversation_id","user_id","status","created_at_ms"]}},"components/schemas/fin_agent_replied_event":{"id":"components/schemas/fin_agent_replied_event","kind":"json-schema","title":"Fin Agent Replied Event","data":{"title":"Fin Agent Replied Event","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event fired when Fin replies to a user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivered via webhooks. The content of the response will be contained in the message object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermediate replies have status 'replying'; a separate fin_status_updated event with 'awaiting_user_reply' fires once Fin's reply is done."},"children":[]}]}]}],"x-tags":["Fin Agent"],"properties":{"event_name":{"type":"string","enum":["fin_replied"],"description":"The name of the event.","example":"fin_replied"},"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"123456"},"user_id":{"type":"string","description":"The ID of the user.","example":"7891"},"message":{"type":"object","description":"Fin's answer to the user's query.","properties":{"id":{"type":"string","description":"A unique identifier for this message.","example":"98765"},"author":{"type":"string","enum":["fin"],"description":"The author of the message (always 'fin' for this event).","example":"fin"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of Fin's response, in the format given by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (HTML by default)."},"children":[]}]}]}],"example":"<p>You can see your account details by clicking on the <em>Account</em> tab in the top right corner of the screen.</p>"},"format":{"type":"string","enum":["html","markdown"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when the request set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Fin converted the reply to Markdown, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it could not convert the reply and sent HTML instead. When absent, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is HTML."},"children":[]}]}]}]},"timestamp_ms":{"type":"string","format":"date-time","description":"The timestamp the message was created at, with millisecond precision.","example":"2025-01-24T09:01:00.456Z"},"sources":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content sources Fin used to generate this reply, in the same order as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[n] citation markers in the body. Present only when Fin cited content."},"children":[]}]}]}],"items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the source.","example":"Managing your account"},"type":{"type":"string","enum":["article","external"],"description":"Whether the source is an Intercom article or external content.","example":"article"},"url":{"type":"string","description":"The URL of the source.","example":"https://www.example.com/help/en/articles/1-managing-your-account"}},"required":["title","type","url"]},"example":[{"title":"Managing your account","type":"article","url":"https://www.example.com/help/en/articles/1-managing-your-account"}]}},"required":["author","body","timestamp_ms"]},"status":{"type":"string","enum":["replying","awaiting_user_reply","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's current status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replying: Intermediate reply part; more parts may follow"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"awaiting_user_reply: Legacy status; instead use the fin_status_updated event with 'awaiting_user_reply', which fires once Fin's reply is done"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete: Fin's reply is final and no user reply is expected. Sent for one-shot Ask replies only"},"children":[]}]}]}]}],"example":"replying"},"created_at_ms":{"type":"string","format":"date-time","description":"The timestamp the event was created at, with millisecond precision.","example":"2025-01-24T10:00:00.123Z"}},"required":["event_name","conversation_id","user_id","message","status","created_at_ms"]}},"components/schemas/fin_agent_csat_requested_event":{"id":"components/schemas/fin_agent_csat_requested_event","kind":"json-schema","title":"Fin Agent CSAT Requested Event","data":{"title":"Fin Agent CSAT Requested Event","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event fired when Fin asks the user to rate the conversation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivered via webhooks. Carries the rating options to present to the user; submit"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user's choice with POST /fin/csat. Unlike the reply events it has no message — a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rating survey is a set of options to choose from, not readable text."},"children":[]}]}]}],"x-tags":["Fin Agent"],"properties":{"event_name":{"type":"string","enum":["csat_requested"],"description":"The name of the event.","example":"csat_requested"},"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"123456"},"user_id":{"type":"string","description":"The ID of the user.","example":"7891"},"csat":{"type":"object","description":"The rating survey to present to the user.","example":{"options":[{"key":"good","emoji":"😃","label":"Great"},{"key":"amazing","emoji":"🤩","label":"Amazing"}]},"properties":{"options":{"type":"array","description":"The ordered rating options to show the user.","example":[{"key":"good","emoji":"😃","label":"Great"},{"key":"amazing","emoji":"🤩","label":"Amazing"}],"items":{"type":"object","properties":{"key":{"type":"string","enum":["terrible","bad","ok","good","amazing"],"description":"The stable key to send back as 'rating' on POST /fin/csat.","example":"amazing"},"emoji":{"type":"string","description":"The emoji representing this rating.","example":"🤩"},"label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable label for this rating, localised to the conversation's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detected language. Distinct from 'key' — display the label, but send back"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the key."},"children":[]}]}]}],"example":"Amazing"}},"required":["key","emoji","label"]}}},"required":["options"]},"created_at_ms":{"type":"string","format":"date-time","description":"The timestamp the event was created at, with millisecond precision.","example":"2025-01-24T10:00:00.123Z"}},"required":["event_name","conversation_id","user_id","csat","created_at_ms"]}},"components/schemas/file_attribute":{"id":"components/schemas/file_attribute","kind":"json-schema","title":"File","data":{"title":"File","type":"object","description":"The value describing a file upload set for a custom attribute","properties":{"type":{"type":"string","example":"upload"},"name":{"type":"string","description":"The name of the file","example":"Screenshot.png"},"url":{"type":"string","description":"The url of the file. This is a temporary URL and will expire after 30 minutes.","example":"https://intercom-attachments-1.com/.../Screenshot.png"},"content_type":{"type":"string","description":"The type of file","example":"image/png"},"filesize":{"type":"integer","description":"The size of the file in bytes","example":11308309},"width":{"type":"integer","description":"The width of the file in pixels, if applicable","example":3024},"height":{"type":"integer","description":"The height of the file in pixels, if applicable","example":1964}}}},"components/schemas/group_content":{"id":"components/schemas/group_content","kind":"json-schema","title":"Group Content","data":{"title":"Group Content","type":"object","description":"The Content of a Group.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ."},"children":[]}]}]}],"enum":[null,"group_content"],"example":"group_content","nullable":true},"name":{"type":"string","description":"The name of the collection or section.","example":"Collection name"},"description":{"type":"string","description":"The description of the collection. Only available for collections.","example":" Collection description"}}}},"components/schemas/group_translated_content":{"id":"components/schemas/group_translated_content","kind":"json-schema","title":"Group Translated Content","data":{"title":"Group Translated Content","type":"object","description":"The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - group_translated_content."},"children":[]}]}]}],"nullable":true,"enum":[null,"group_translated_content"],"example":"group_translated_content"},"ar":{"description":"The content of the group in Arabic","$ref":"#/components/schemas/group_content"},"bg":{"description":"The content of the group in Bulgarian","$ref":"#/components/schemas/group_content"},"bs":{"description":"The content of the group in Bosnian","$ref":"#/components/schemas/group_content"},"ca":{"description":"The content of the group in Catalan","$ref":"#/components/schemas/group_content"},"cs":{"description":"The content of the group in Czech","$ref":"#/components/schemas/group_content"},"da":{"description":"The content of the group in Danish","$ref":"#/components/schemas/group_content"},"de":{"description":"The content of the group in German","$ref":"#/components/schemas/group_content"},"el":{"description":"The content of the group in Greek","$ref":"#/components/schemas/group_content"},"en":{"description":"The content of the group in English","$ref":"#/components/schemas/group_content"},"es":{"description":"The content of the group in Spanish","$ref":"#/components/schemas/group_content"},"et":{"description":"The content of the group in Estonian","$ref":"#/components/schemas/group_content"},"fi":{"description":"The content of the group in Finnish","$ref":"#/components/schemas/group_content"},"fr":{"description":"The content of the group in French","$ref":"#/components/schemas/group_content"},"he":{"description":"The content of the group in Hebrew","$ref":"#/components/schemas/group_content"},"hr":{"description":"The content of the group in Croatian","$ref":"#/components/schemas/group_content"},"hu":{"description":"The content of the group in Hungarian","$ref":"#/components/schemas/group_content"},"id":{"description":"The content of the group in Indonesian","$ref":"#/components/schemas/group_content"},"it":{"description":"The content of the group in Italian","$ref":"#/components/schemas/group_content"},"ja":{"description":"The content of the group in Japanese","$ref":"#/components/schemas/group_content"},"ko":{"description":"The content of the group in Korean","$ref":"#/components/schemas/group_content"},"lt":{"description":"The content of the group in Lithuanian","$ref":"#/components/schemas/group_content"},"lv":{"description":"The content of the group in Latvian","$ref":"#/components/schemas/group_content"},"mn":{"description":"The content of the group in Mongolian","$ref":"#/components/schemas/group_content"},"nb":{"description":"The content of the group in Norwegian","$ref":"#/components/schemas/group_content"},"nl":{"description":"The content of the group in Dutch","$ref":"#/components/schemas/group_content"},"pl":{"description":"The content of the group in Polish","$ref":"#/components/schemas/group_content"},"pt":{"description":"The content of the group in Portuguese (Portugal)","$ref":"#/components/schemas/group_content"},"ro":{"description":"The content of the group in Romanian","$ref":"#/components/schemas/group_content"},"ru":{"description":"The content of the group in Russian","$ref":"#/components/schemas/group_content"},"sl":{"description":"The content of the group in Slovenian","$ref":"#/components/schemas/group_content"},"sr":{"description":"The content of the group in Serbian","$ref":"#/components/schemas/group_content"},"sv":{"description":"The content of the group in Swedish","$ref":"#/components/schemas/group_content"},"tr":{"description":"The content of the group in Turkish","$ref":"#/components/schemas/group_content"},"vi":{"description":"The content of the group in Vietnamese","$ref":"#/components/schemas/group_content"},"pt-BR":{"description":"The content of the group in Portuguese (Brazil)","$ref":"#/components/schemas/group_content"},"zh-CN":{"description":"The content of the group in Chinese (China)","$ref":"#/components/schemas/group_content"},"zh-TW":{"description":"The content of the group in Chinese (Taiwan)","$ref":"#/components/schemas/group_content"}}}},"components/schemas/handling_event":{"id":"components/schemas/handling_event","kind":"json-schema","title":"Handling Event","data":{"title":"Handling Event","type":"object","description":"A pause or resume event for a conversation","required":["teammate","type","timestamp"],"properties":{"teammate":{"$ref":"#/components/schemas/teammate_reference"},"type":{"type":"string","enum":["paused","resumed"],"description":"The type of handling event","example":"paused"},"timestamp":{"type":"string","format":"date-time","description":"ISO8601 timestamp when the event occurred","example":"2026-01-09T09:00:00Z"},"reason":{"type":"string","description":"Optional reason for the event (e.g., \"Paused\", \"Away\")","example":"Paused","nullable":true}}}},"components/schemas/handling_event_list":{"id":"components/schemas/handling_event_list","kind":"json-schema","title":"Handling Event List","data":{"title":"Handling Event List","type":"object","description":"A list of handling events for a conversation","properties":{"handling_events":{"type":"array","description":"Array of handling events","items":{"$ref":"#/components/schemas/handling_event"}}}}},"components/schemas/hitl_event":{"id":"components/schemas/hitl_event","kind":"json-schema","title":"HITL Event","data":{"title":"HITL Event","type":"object","description":"A single event in a Fin human-in-the-loop consultation on a conversation.","properties":{"hitl_cycle_id":{"type":"string","description":"Identifies the consultation this event belongs to. The same on every event of one consultation, so it is not unique per event.","example":"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80"},"event_type":{"type":"string","description":"What happened.","enum":["fin_consultation_started","fin_draft_proposed","fin_teammate_input_received","fin_draft_revised","fin_consultation_finished"],"example":"fin_consultation_started"},"conversation_part_id":{"type":"string","description":"The conversation part this event relates to, where one exists.","example":"4471002","nullable":true},"rule_id":{"type":"string","description":"The escalation rule that triggered the consultation, as recorded when it began. Null if no rule triggered it.","example":"88","nullable":true},"rule_name":{"type":"string","description":"The rule's name as recorded when the consultation began, which may differ from its current name.","example":"Refunds over $100","nullable":true},"created_at":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp for when the event occurred. Approximate on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_proposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1767225600},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields specific to this event. Which are present depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — see the endpoint description for the full mapping."},"children":[]}]}]}],"properties":{"channel":{"type":"string","description":"The channel the conversation was on when Fin consulted a teammate.","enum":["email","chat","voice","unknown"],"example":"email"},"rule_threshold_percent":{"type":"integer","description":"The confidence threshold the rule required, as a percentage.","example":60,"nullable":true},"confidence_percent":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How confident Fin was in its answer, as a percentage. Compare against "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_threshold_percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":42,"nullable":true},"sharp_ask":{"type":"string","description":"The question Fin put to the teammate.","example":"How long do refunds take?","nullable":true},"ask_rationale":{"type":"string","description":"Why Fin needed to ask.","example":"No article covers refund timelines.","nullable":true},"issue_summary":{"type":"string","description":"Fin's summary of what the customer needs.","example":"Customer chasing a refund.","nullable":true},"customer_question":{"type":"string","description":"The customer's message that prompted the consultation.","example":"Where is my refund?","nullable":true},"draft":{"type":"string","description":"The reply Fin proposed to the teammate.","example":"Refunds are processed within 30 days.","nullable":true},"round_index":{"type":"integer","description":"Which round of teammate feedback this event belongs to, starting at 1.","example":1},"teammate_input":{"type":"string","description":"The feedback the teammate gave Fin.","example":"Tell them 5 business days.","nullable":true},"reviewer_admin_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The teammate involved in this event — who gave the feedback, or who approved the draft or took over."},"children":[]}]}]}],"example":"4001","nullable":true},"regeneration_outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How Fin responded to the feedback. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"answer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it produced a revised draft, and is the only value accompanied by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_draft_revised"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_answer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it had nothing to send, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that regeneration failed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consult_teammate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that it asked the teammate again, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the consultation ended before Fin responded."},"children":[]}]}]}],"example":"answer","nullable":true},"revised_draft":{"type":"string","description":"The reply Fin produced after the teammate's feedback.","example":"Refunds take 5 business days.","nullable":true},"outcome":{"type":"string","description":"How the consultation ended.","enum":["approved","taken_over","timed_out_sent","timed_out_escalated","superseded"],"example":"approved"},"approved_draft_type":{"type":"string","description":"Whether the teammate approved Fin's original draft or the one it revised after their feedback.","enum":["original","revised"],"example":"revised","nullable":true},"final_draft":{"type":"string","description":"The reply as it stood when the consultation ended.","example":"Refunds take 5 business days.","nullable":true},"sent_text":{"type":"string","description":"What was sent to the customer. Null when nothing was sent.","example":"Refunds take 5 business days.","nullable":true},"duration_seconds":{"type":"integer","description":"How long the consultation took, in seconds.","example":180,"nullable":true},"rounds_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How many rounds of teammate feedback the consultation had. Only the ten most recent are returned as events, so this can exceed the number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fin_teammate_input_received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]}],"example":1},"payload_truncated":{"type":"boolean","description":"Whether any text on this consultation was too long to store in full and was cut.","example":false}}}}}},"components/schemas/hitl_event_list":{"id":"components/schemas/hitl_event_list","kind":"json-schema","title":"HITL Event List","data":{"title":"HITL Event List","type":"object","description":"A list of human-in-the-loop events for a conversation, oldest first.","properties":{"type":{"type":"string","description":"The type of the object.","enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of HITL event objects.","items":{"$ref":"#/components/schemas/hitl_event"}}}}},"components/schemas/side_conversation_summary":{"id":"components/schemas/side_conversation_summary","kind":"json-schema","title":"Side Conversation Summary","data":{"title":"Side Conversation Summary","type":"object","description":"A side conversation with its conversation parts.","properties":{"side_conversation_id":{"type":"string","description":"The unique identifier for the side conversation.","example":"456"},"conversation_parts":{"type":"array","description":"The conversation parts (messages) in this side conversation.","items":{"$ref":"#/components/schemas/conversation_part"}},"total_count":{"type":"integer","description":"The total number of conversation parts in this side conversation.","example":1}}}},"components/schemas/side_conversation_list":{"id":"components/schemas/side_conversation_list","kind":"json-schema","title":"Side Conversation List","data":{"title":"Side Conversation List","type":"object","description":"A paginated list of side conversations for a conversation.","properties":{"type":{"type":"string","description":"The type of the response object.","enum":["side_conversation.list"],"example":"side_conversation.list"},"side_conversations":{"type":"array","description":"An array of side conversation objects.","items":{"$ref":"#/components/schemas/side_conversation_summary"}},"total_count":{"type":"integer","description":"The total number of side conversations.","example":1},"pages":{"type":"object","description":"Pagination metadata.","properties":{"type":{"type":"string","enum":["pages"],"example":"pages"},"page":{"type":"integer","description":"The current page number.","example":1},"per_page":{"type":"integer","description":"The number of results per page.","example":25},"total_pages":{"type":"integer","description":"The total number of pages.","example":1}}}}}},"components/schemas/help_center":{"id":"components/schemas/help_center","kind":"json-schema","title":"Help Center","data":{"title":"Help Center","type":"object","x-tags":["Help Center"],"description":"Help Centers contain collections","properties":{"id":{"type":"string","description":"The unique identifier for the Help Center which is given by Intercom.","example":"123"},"workspace_id":{"type":"string","description":"The id of the workspace which the Help Center belongs to.","example":"hfi1bx4l"},"created_at":{"type":"integer","format":"date-time","description":"The time when the Help Center was created.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the Help Center was last updated.","example":1672928610},"identifier":{"type":"string","description":"The identifier of the Help Center. This is used in the URL of the Help Center.","example":"intercom"},"website_turned_on":{"type":"boolean","description":"Whether the Help Center is turned on or not. This is controlled in your Help Center settings.","example":true},"display_name":{"type":"string","description":"The display name of the Help Center only seen by teammates.","example":"Intercom Help Center"},"url":{"type":"string","description":"The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.","example":"https://help.mycompany.com"},"custom_domain":{"type":"string","nullable":true,"description":"Custom domain configured for the help center","example":"help.mycompany.com"},"default":{"type":"boolean","description":"Whether this help center is the default for the workspace.","example":false},"locales":{"type":"array","description":"The locales in which the help center is available.","items":{"type":"string"},"example":["en","fr"]}}}},"components/schemas/help_center_list":{"id":"components/schemas/help_center_list","kind":"json-schema","title":"Help Centers","data":{"title":"Help Centers","type":"object","x-tags":["Help Center"],"description":"A list of Help Centers belonging to the App","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of Help Center objects","items":{"$ref":"#/components/schemas/help_center"}}}}},"components/schemas/jobs":{"id":"components/schemas/jobs","kind":"json-schema","title":"Jobs","data":{"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). Only set once the job has succeeded.","example":"123","nullable":true},"resource_url":{"type":"string","description":"The url of the resource created during job execution. Use this url to fetch the resource. Only set once the job has succeeded.","example":"https://api.intercom.io/tickets/123","nullable":true}},"required":["id"]}},"components/schemas/ip_allowlist":{"id":"components/schemas/ip_allowlist","kind":"json-schema","title":"IP Allowlist","data":{"title":"IP Allowlist","type":"object","description":"IP allowlist settings for the workspace.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip_allowlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ip_allowlist"},"enabled":{"type":"boolean","description":"Whether the IP allowlist is enabled for the workspace.","example":true},"ip_allowlist":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of allowed IP addresses and/or IP ranges in CIDR notation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single IP: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"192.168.0.1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP range: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"192.168.0.1/24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (allows 192.168.0.0 - 192.168.0.255)"},"children":[]}]}]}]}],"items":{"type":"string"},"example":["192.168.1.0/24","10.0.0.1"]}}}},"components/schemas/intercom_version":{"id":"components/schemas/intercom_version","kind":"json-schema","title":"intercom_version","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intercom API version."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you omit the header, the API uses the version set in your app package, and 1.0 if none is set."},"children":[]}]}]}],"type":"string","example":"2.18","enum":["1.0","1.1","1.2","1.3","1.4","2.0","2.1","2.2","2.3","2.4","2.5","2.6","2.7","2.8","2.9","2.10","2.11","2.12","2.13","2.14","2.15","2.16","2.17","2.18"]}},"components/schemas/linked_object":{"id":"components/schemas/linked_object","kind":"json-schema","title":"Linked Object","data":{"title":"Linked Object","type":"object","description":"A linked conversation or ticket.","properties":{"type":{"type":"string","description":"ticket or conversation","enum":["ticket","conversation"],"example":"ticket"},"id":{"type":"string","description":"The ID of the linked object","example":"7583"},"category":{"type":"string","description":"Category of the Linked Ticket Object.","enum":["Customer","Back-office","Tracker",null],"example":"Customer","nullable":true}}}},"components/schemas/linked_object_list":{"id":"components/schemas/linked_object_list","kind":"json-schema","title":"Linked Objects","data":{"title":"Linked Objects","type":"object","description":"An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.","properties":{"type":{"type":"string","description":"Always list.","enum":["list"],"example":"list"},"total_count":{"type":"integer","description":"The total number of linked objects.","example":100},"has_more":{"type":"boolean","description":"Whether or not there are more linked objects than returned.","example":false},"data":{"type":"array","description":"An array containing the linked conversations and linked tickets.","items":{"$ref":"#/components/schemas/linked_object"}}}}},"components/schemas/macro":{"id":"components/schemas/macro","kind":"json-schema","title":"Macro","data":{"title":"Macro","type":"object","x-tags":["Macros"],"description":"A macro is a pre-defined response template (saved reply) that can be used to quickly reply to conversations.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"macro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["macro"],"example":"macro"},"id":{"type":"string","description":"The unique identifier for the macro.","example":"123"},"name":{"type":"string","description":"The name of the macro.","example":"Order Status Update"},"body":{"type":"string","description":"The body of the macro in HTML format with placeholders transformed to XML-like format.","example":"<p>Hi <attribute key=\"user.name\" default=\"there\"/>, your order is ready!</p>"},"body_text":{"type":"string","description":"The plain text version of the macro body with original Intercom placeholder format.","example":"Hi {{user.name|fallback:\"there\"}}, your order is ready!"},"created_at":{"type":"string","format":"date-time","description":"The time the macro was created in ISO 8601 format.","example":"2025-07-17T11:18:08.000Z"},"updated_at":{"type":"string","format":"date-time","description":"The time the macro was last updated in ISO 8601 format.","example":"2025-07-17T15:30:24.000Z"},"visible_to":{"type":"string","description":"Who can view this macro.","enum":["everyone","specific_teams"],"example":"everyone"},"visible_to_team_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The team IDs that can view this macro when visible_to is set to specific_teams."},"children":[]}]}]}],"items":{"type":"string"},"example":["456","789"]},"available_on":{"type":"array","description":"Where the macro is available for use.","items":{"type":"string","enum":["inbox","messenger"]},"example":["inbox","messenger"]}}}},"components/schemas/macro_list":{"id":"components/schemas/macro_list","kind":"json-schema","title":"Macro List","data":{"title":"Macro List","type":"object","x-tags":["Macros"],"description":"A paginated list of macros (saved replies) in the workspace.","properties":{"type":{"type":"string","description":"Always list","enum":["list"],"example":"list"},"data":{"type":"array","description":"The list of macro objects","items":{"$ref":"#/components/schemas/macro"}},"pages":{"type":"object","description":"Pagination information","properties":{"type":{"type":"string","description":"The type of pagination","enum":["pages"],"example":"pages"},"per_page":{"type":"integer","description":"Number of results per page","example":50},"next":{"type":"object","nullable":true,"description":"Cursor for the next page","properties":{"starting_after":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded cursor containing [updated_at, id] for pagination"},"children":[]}]}]}],"example":"WzE3MTk0OTM3NTcuMCwgIjEyMyJd"}}}}}}}},"components/schemas/merge_contacts_request":{"id":"components/schemas/merge_contacts_request","kind":"json-schema","title":"Merge contact data","data":{"description":"Merge contact data.","type":"object","title":"Merge contact data","required":["from","into"],"properties":{"from":{"type":"string","description":"The unique identifier for the contact to merge away from. Must be a lead.","example":"5d70dd30de4efd54f42fd526"},"into":{"type":"string","description":"The unique identifier for the contact to merge into. Must be a user.","example":"5ba682d23d7cf92bef87bfd4"},"skip_duplicate_validation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to merge two contacts that are not duplicates (they share no matching email or phone)."},"children":[]}]}]}],"example":true}}}},"components/schemas/merge_history_item":{"id":"components/schemas/merge_history_item","kind":"json-schema","title":"Merge History Item","data":{"title":"Merge History Item","type":"object","description":"A record of a contact that was merged into another contact.","properties":{"type":{"type":"string","description":"The type of object.","example":"merge_history"},"source_contact_id":{"type":"string","description":"The Intercom ID of the contact that was merged into this contact.","example":"5ba682d23d7cf92bef87bfd3"},"source_contact_role":{"type":"string","description":"The role of the contact that was merged in.","enum":["lead","user"],"example":"lead"},"merged_at":{"type":"integer","nullable":true,"format":"date-time","description":"(Unix timestamp in seconds) The time when the merge occurred.","example":1571672154}}}},"components/schemas/merge_history_list":{"id":"components/schemas/merge_history_list","kind":"json-schema","title":"Merge History List","data":{"title":"Merge History List","type":"object","description":"A paginated list of merge history entries for a contact.","properties":{"type":{"type":"string","description":"The type of object.","enum":["list"],"example":"list"},"data":{"type":"array","description":"An array of merge history entries.","items":{"$ref":"#/components/schemas/merge_history_item"}},"next_cursor":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor to pass as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to fetch the next page of results. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when there are no more pages."},"children":[]}]}]}],"example":"WyIxNjM0NTY3ODkwIl0"},"has_more":{"type":"boolean","description":"Whether there are more results to fetch.","example":false}}}},"components/schemas/merge_preview_request":{"id":"components/schemas/merge_preview_request","kind":"json-schema","title":"Merge preview request","data":{"description":"Preview a contact merge.","type":"object","title":"Merge preview request","required":["from","into"],"properties":{"from":{"type":"string","description":"The unique identifier for the contact to merge away from (the source contact).","example":"6762f0d51bb69f9f2193bb7f"},"into":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the contact to merge into (the destination contact). Must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"6762f0d51bb69f9f2193bb80"},"skip_duplicate_validation":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", previews the merge even if the contacts don't share a common identifier. Must be a JSON boolean; the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"true\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not bypass the check. Defaults to false."},"children":[]}]}]}]},"custom_attribute_names":{"type":"array","description":"Custom attribute names to include in the previewed attribute changes.","items":{"type":"string"}}}}},"components/schemas/merge_preview_response":{"id":"components/schemas/merge_preview_response","kind":"json-schema","title":"Merge preview response","data":{"title":"Merge preview response","description":"The result of a merge preview. Either the merge is allowed (with a summary of the changes) or it is not (with reasons).","oneOf":[{"$ref":"#/components/schemas/merge_preview_allowed"},{"$ref":"#/components/schemas/merge_preview_blocked"}]}},"components/schemas/merge_preview_allowed":{"id":"components/schemas/merge_preview_allowed","kind":"json-schema","title":"Merge preview allowed","data":{"title":"Merge preview allowed","type":"object","description":"Returned when the merge is allowed.","properties":{"allowed":{"type":"boolean","enum":[true],"description":"Always true. The merge is allowed."},"summary":{"$ref":"#/components/schemas/merge_preview_summary"}}}},"components/schemas/merge_preview_blocked":{"id":"components/schemas/merge_preview_blocked","kind":"json-schema","title":"Merge preview not allowed","data":{"title":"Merge preview not allowed","type":"object","description":"Returned when the merge is not allowed.","properties":{"allowed":{"type":"boolean","enum":[false],"description":"Always false. The merge is not allowed."},"reasons":{"type":"array","description":"One or more reasons the merge is not allowed.","items":{"$ref":"#/components/schemas/merge_preview_reason"}}}}},"components/schemas/merge_preview_reason":{"id":"components/schemas/merge_preview_reason","kind":"json-schema","title":"Merge preview reason","data":{"title":"Merge preview reason","type":"object","description":"A reason a merge is not allowed.","properties":{"code":{"type":"string","description":"A stable code identifying the reason. Branch on this value.","enum":["source_same_as_target","invalid_merge_role_pair","no_shared_identifier","facebook_user","external_lead_channel_not_allowed","mailing_list","whatsapp_data_cannot_be_merged","telegram_data_cannot_be_merged","ms_teams_data_cannot_be_merged","phone_data_cannot_be_merged"]},"message":{"type":"string","description":"A human-readable explanation. Display this to people; do not match on it, as the wording may change."}}}},"components/schemas/merge_preview_summary":{"id":"components/schemas/merge_preview_summary","kind":"json-schema","title":"Merge preview summary","data":{"title":"Merge preview summary","type":"object","description":"A summary of the changes the merge would make to the surviving contact.","properties":{"attribute_changes":{"$ref":"#/components/schemas/merge_preview_attribute_changes"},"reassignments":{"$ref":"#/components/schemas/merge_preview_reassignments"}}}},"components/schemas/merge_preview_attribute_changes":{"id":"components/schemas/merge_preview_attribute_changes","kind":"json-schema","title":"Merge preview attribute changes","data":{"title":"Merge preview attribute changes","type":"object","description":"The attribute changes the merge would make to the surviving contact.","properties":{"attributes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The individual attribute changes. At most 50 custom attribute changes are included; changes to standard fields are always included, so this array can hold more than 50 items. total_count reflects the full number of changes."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/merge_preview_attribute_change"}},"total_count":{"type":"integer","description":"The total number of attribute changes detected, which may exceed the number of items in attributes.","example":3}}}},"components/schemas/merge_preview_attribute_change":{"id":"components/schemas/merge_preview_attribute_change","kind":"json-schema","title":"Merge preview attribute change","data":{"title":"Merge preview attribute change","type":"object","description":"A single attribute change on the surviving contact.","properties":{"field":{"type":"string","description":"The contact field that would change.","example":"name"},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the value is resolved. adopted = the source's value is taken; discarded = the source's value is dropped and the target's kept; merged = the two values are combined."},"children":[]}]}]}],"enum":["adopted","discarded","merged"]},"from_value":{"nullable":true,"description":"The source contact's value. Omitted when null. May be a string, array, or object depending on the field."},"into_value":{"nullable":true,"description":"The target contact's value. Omitted when null. May be a string, array, or object depending on the field."},"new_into_value":{"nullable":true,"description":"The resulting value on the surviving contact. Always present; may be null. May be a string, array, or object depending on the field."}}}},"components/schemas/merge_preview_reassignments":{"id":"components/schemas/merge_preview_reassignments","kind":"json-schema","title":"Merge preview reassignments","data":{"title":"Merge preview reassignments","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two counts per object type — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", how many are on the lead and would move to the surviving contact, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"into"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", how many the surviving contact already has. Only types with reassignments are included, and both counts are always present on a type that is included."},"children":[]}]}]}],"properties":{"conversations":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distinct non-ticket conversations, counting both conversations the contact owns and conversations it participates in. Tickets are excluded here and reported separately under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tickets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"from":{"type":"integer","description":"The number of non-ticket conversations on the lead that would be reassigned to the surviving contact.","example":12},"into":{"type":"integer","description":"The number of non-ticket conversations the surviving contact already has.","example":5}},"required":["from","into"]},"tickets":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tickets, meaning conversations of any ticket type. Counted separately from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so a single conversation is never counted twice."},"children":[]}]}]}],"properties":{"from":{"type":"integer","description":"The number of tickets on the lead that would be reassigned to the surviving contact.","example":2},"into":{"type":"integer","description":"The number of tickets the surviving contact already has.","example":1}},"required":["from","into"]},"phone_calls":{"type":"object","description":"Phone calls. Present only for phone-lead merges.","properties":{"from":{"type":"integer","description":"The number of phone calls on the lead that would be reassigned to the surviving contact.","example":1},"into":{"type":"integer","description":"The number of phone calls the surviving contact already has.","example":0}},"required":["from","into"]},"tags":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counts only tags the surviving contact does not already have."},"children":[]}]}]}],"properties":{"from":{"type":"integer","description":"The number of tags on the lead that would be added to the surviving contact.","example":3},"into":{"type":"integer","description":"The number of tags the surviving contact already has.","example":4}},"required":["from","into"]},"notes":{"type":"object","description":"Notes attached to the contact.","properties":{"from":{"type":"integer","description":"The number of notes on the lead that would be reassigned to the surviving contact.","example":2},"into":{"type":"integer","description":"The number of notes the surviving contact already has.","example":6}},"required":["from","into"]}}}},"components/schemas/merge_conversations_request":{"id":"components/schemas/merge_conversations_request","kind":"json-schema","title":"Merge Conversations Request","data":{"title":"Merge Conversations Request","type":"object","description":"Payload to merge a secondary conversation into a primary conversation.","x-tags":["Conversations"],"properties":{"merge_into_conversation_id":{"type":"integer","description":"The ID of the primary (target) conversation to merge into.","example":456}},"required":["merge_into_conversation_id"]}},"components/schemas/message":{"id":"components/schemas/message","kind":"json-schema","title":"Message","data":{"type":"object","title":"Message","x-tags":["Messages"],"description":"Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.","properties":{"type":{"type":"string","description":"The type of the message","example":"user_message"},"id":{"type":"string","description":"The id representing the message.","example":"1488971108"},"created_at":{"type":"integer","format":"date-time","description":"The time the conversation was created.","example":1667560812},"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subject of the message. Only present if message_type: email."},"children":[]}]}]}],"example":"Greetings"},"body":{"type":"string","description":"The message body, which may contain HTML.","example":"Hello"},"message_type":{"type":"string","enum":["email","inapp","facebook","twitter","whatsapp"],"description":"The type of message that was sent. Can be email, inapp, facebook, twitter or whatsapp.","example":"inapp"},"conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The associated conversation_id"},"children":[]}]}]}],"example":"64619700005570"},"owner":{"$ref":"#/components/schemas/admin","description":"The admin who sent the message. Only present when the message has an owner."},"template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The style of the email, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"plain"},"external_id":{"type":"string","description":"The external identifier of the message, if one was set when the message was created. Only returned for messages started by a contact.","example":"api:order-1234"},"whatsapp_message_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id WhatsApp gave the message. Only present for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" messages that WhatsApp accepted."},"children":[]}]}]}],"example":"wamid.EXAMPLE123"}},"required":["type","id","created_at","body","message_type"]}},"components/schemas/whatsapp_message_status":{"id":"components/schemas/whatsapp_message_status","kind":"json-schema","title":"whatsapp_message_status","data":{"type":"object","description":"The delivery status of a specific WhatsApp message.","properties":{"conversation_id":{"type":"string","description":"ID of the conversation","example":"123456789"},"status":{"type":"string","description":"Current delivery status of the message","enum":["sent","delivered","read","failed"],"example":"delivered"},"type":{"type":"string","description":"Event type","example":"broadcast_outbound"},"created_at":{"type":"integer","description":"Creation timestamp","example":1734537980},"updated_at":{"type":"integer","description":"Last update timestamp","example":1734538000},"template_name":{"type":"string","description":"Name of the WhatsApp template used","example":"appointment_reminder"},"message_id":{"type":"string","description":"The WhatsApp message ID","example":"wamid_abc123"},"error":{"type":"object","nullable":true,"description":"Error details, present only when status is \"failed\"","properties":{"message":{"type":"string","description":"Error message"},"details":{"type":"string","description":"Detailed error information"}}}}}},"components/schemas/whatsapp_message_status_list":{"id":"components/schemas/whatsapp_message_status_list","kind":"json-schema","title":"whatsapp_message_status_list","data":{"type":"object","required":["type","ruleset_id","pages","total_count","events"],"properties":{"type":{"type":"string","enum":["list"]},"ruleset_id":{"type":"string","description":"The provided ruleset ID"},"pages":{"type":"object","required":["type","per_page","total_pages"],"properties":{"type":{"type":"string","enum":["pages"]},"per_page":{"type":"integer","description":"Number of results per page"},"total_pages":{"type":"integer","description":"Total number of pages"},"next":{"type":"object","nullable":true,"description":"Information for fetching next page (null if no more pages)","properties":{"starting_after":{"type":"string","description":"Cursor for the next page"}}}}},"total_count":{"type":"integer","description":"Total number of events"},"events":{"type":"array","items":{"type":"object","required":["id","conversation_id","status","type","created_at","updated_at","whatsapp_message_id"],"properties":{"id":{"type":"string","description":"Event ID"},"conversation_id":{"type":"string","description":"ID of the conversation"},"status":{"type":"string","description":"Current status of the message","enum":["sent","delivered","read","failed"]},"type":{"type":"string","description":"Event type","enum":["broadcast_outbound"]},"created_at":{"type":"integer","description":"Creation timestamp"},"updated_at":{"type":"integer","description":"Last update timestamp"},"whatsapp_message_id":{"type":"string","description":"WhatsApp's message identifier"},"template_name":{"type":"string","description":"Name of the WhatsApp template used"}}}}}}},"components/schemas/multiple_filter_search_request":{"id":"components/schemas/multiple_filter_search_request","kind":"json-schema","title":"Multiple Filter Search Request","data":{"title":"Multiple Filter Search Request","description":"Search using Intercoms Search APIs with more than one filter.","type":"object","properties":{"operator":{"type":"string","enum":["AND","OR"],"description":"An operator to allow boolean inspection between multiple fields.","example":"AND"},"value":{"oneOf":[{"type":"array","description":"Add mutiple filters.","title":"multiple filter search request","items":{"$ref":"#/components/schemas/multiple_filter_search_request"}},{"type":"array","description":"Add a single filter field.","title":"single filter search request","items":{"$ref":"#/components/schemas/single_filter_search_request"}}]}}}},"components/schemas/news_item":{"id":"components/schemas/news_item","kind":"json-schema","title":"News Item","data":{"title":"News Item","type":"object","x-tags":["News"],"description":"A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.","properties":{"type":{"type":"string","description":"The type of object.","enum":["news-item"],"example":"news-item"},"id":{"type":"string","description":"The unique identifier for the news item which is given by Intercom.","example":"141"},"workspace_id":{"type":"string","description":"The id of the workspace which the news item belongs to.","example":"t74hdn32"},"title":{"type":"string","description":"The title of the news item.","example":"New feature: News Items"},"body":{"type":"string","description":"The news item body, which may contain HTML.","example":"We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers."},"sender_id":{"type":"integer","description":"The id of the sender of the news item. Must be a teammate on the workspace.","example":123},"state":{"type":"string","description":"News items will not be visible to your users in the assigned newsfeeds until they are set live.","enum":["draft","live"],"example":"live"},"newsfeed_assignments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of newsfeed_assignments to assign to the specified newsfeed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/newsfeed_assignment"}},"labels":{"type":"array","description":"Label names displayed to users to categorize the news item, sorted with uppercase letters before lowercase.","items":{"type":"string","description":"The label name.","example":"Product Update"}},"cover_image_url":{"type":"string","format":"uri","nullable":true,"description":"URL of the image used as cover. Must have .jpg or .png extension. Intercom copies the image you send on write, so the URL returned here is a signed Intercom URL that expires; fetch the news item again for a fresh one.","example":"https://example.com/cover.jpg"},"reactions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordered list of emoji reactions to the news item. When empty, reactions are disabled. An update that leaves out "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also disables them but leaves this list as it was."},"children":[]}]}]}],"items":{"type":"string","description":"The emoji reaction to the news item.","example":"👍"}},"deliver_silently":{"type":"boolean","description":"When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.","example":true},"created_at":{"type":"integer","format":"timestamp","description":"Timestamp for when the news item was created.","example":1610589632},"updated_at":{"type":"integer","format":"timestamp","description":"Timestamp for when the news item was last updated.","example":1610589632},"published_at":{"type":"integer","format":"timestamp","nullable":true,"description":"Timestamp for when the news item last went live. Null if the news item has never been live.","example":1610589632}}}},"components/schemas/news_item_request":{"id":"components/schemas/news_item_request","kind":"json-schema","title":"Create News Item Request","data":{"description":"A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.","type":"object","title":"Create News Item Request","properties":{"title":{"type":"string","description":"The title of the news item.","example":"Halloween is here!"},"body":{"type":"string","description":"The news item body, which may contain HTML.","example":"<p>New costumes in store for this spooky season</p>"},"sender_id":{"type":"integer","description":"The id of the sender of the news item. Must be a teammate on the workspace.","example":123},"state":{"type":"string","description":"News items will not be visible to your users in the assigned newsfeeds until they are set live.","enum":["draft","live"],"example":"live"},"deliver_silently":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the news item will appear in the messenger newsfeed without showing a notification badge."},"children":[]}]}]}],"example":true},"labels":{"type":"array","description":"Label names displayed to users to categorize the news item.","items":{"type":"string"},"example":["Product","Update","New"]},"cover_image_url":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the image to use as the cover. Must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in lower case, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are rejected. Intercom copies the image and serves it from its own signed URL."},"children":[]}]}]}],"example":"https://example.com/cover.jpg"},"reactions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordered list of emoji reactions to the news item. Send an empty list to disable reactions. Send at most five, each a single Unicode code point, so an emoji with a skin tone, a joiner sequence or a variation selector (such as ❤️) is rejected. More than five returns a 400, but the news item is still saved as a draft, with no reactions or cover image."},"children":[]}]}]}],"items":{"type":"string"},"example":["😆","😅"]},"newsfeed_assignments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of newsfeed_assignments to assign to the specified newsfeed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/newsfeed_assignment"}}},"required":["title","sender_id"]}},"components/schemas/update_news_item_request":{"id":"components/schemas/update_news_item_request","kind":"json-schema","title":"Update News Item Request","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of a request that updates an existing news item. Leaving "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newsfeed_assignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" out clears them, and leaving "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" out disables reactions; every other optional field keeps its current value when left out."},"children":[]}]}]}],"type":"object","title":"Update News Item Request","properties":{"title":{"type":"string","description":"The title of the news item.","example":"Halloween is here!"},"body":{"type":"string","description":"The news item body, which may contain HTML.","example":"<p>New costumes in store for this spooky season</p>"},"sender_id":{"type":"integer","description":"The id of the sender of the news item. Must be a teammate on the workspace.","example":123},"state":{"type":"string","description":"News items will not be visible to your users in the assigned newsfeeds until they are set live.","enum":["draft","live"],"example":"live"},"deliver_silently":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the news item will appear in the messenger newsfeed without showing a notification badge."},"children":[]}]}]}],"example":true},"labels":{"type":"array","description":"Label names displayed to users to categorize the news item. Send the full list; the labels you leave out are removed.","items":{"type":"string"},"example":["Product","Update","New"]},"cover_image_url":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the image to use as the cover. Must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in lower case, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are rejected. Intercom copies the image and serves it from its own signed URL."},"children":[]}]}]}],"example":"https://example.com/cover.jpg"},"reactions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordered list of emoji reactions to the news item. Send an empty list to disable reactions. Send at most five, each a single Unicode code point, so an emoji with a skin tone, a joiner sequence or a variation selector (such as ❤️) is rejected."},"children":[]}]}]}],"items":{"type":"string"},"example":["😆","😅"]},"newsfeed_assignments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of newsfeed_assignments to assign to the specified newsfeed. Send the full list; the assignments you leave out are removed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/newsfeed_assignment"}}},"required":["sender_id"]}},"components/schemas/newsfeed":{"id":"components/schemas/newsfeed","kind":"json-schema","title":"Newsfeed","data":{"title":"Newsfeed","type":"object","x-tags":["News"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A newsfeed is a collection of news items, targeted to a specific audience."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsfeeds currently cannot be edited through the API, please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.intercom.com/help/en/articles/6362267-getting-started-with-news"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set up your newsfeeds in Intercom."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"The unique identifier for the newsfeed which is given by Intercom.","example":"12312"},"type":{"type":"string","description":"The type of object.","enum":["newsfeed"],"example":"newsfeed"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the newsfeed. This name will never be visible to your users. Returned HTML-escaped, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&amp;"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The News Center newsfeed always returns the name "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"News center newsfeed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"My Newsfeed"},"created_at":{"type":"integer","format":"timestamp","description":"Timestamp for when the newsfeed was created.","example":1674917488},"updated_at":{"type":"integer","format":"timestamp","description":"Timestamp for when the newsfeed was last updated.","example":1674917488}}}},"components/schemas/newsfeed_assignment":{"id":"components/schemas/newsfeed_assignment","kind":"json-schema","title":"Newsfeed Assignment","data":{"title":"Newsfeed Assignment","type":"object","x-tags":["News"],"description":"Assigns a news item to a newsfeed.","properties":{"newsfeed_id":{"type":"integer","description":"The unique identifier for the newsfeed which is given by Intercom.","example":198313},"published_at":{"type":"integer","format":"timestamp","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\", and a date in the future is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Null while the news item isn't live."},"children":[]}]}]}],"example":1674917488}}}},"components/schemas/note":{"id":"components/schemas/note","kind":"json-schema","title":"Note","data":{"title":"Note","type":"object","x-tags":["Notes"],"description":"Notes allow you to annotate and comment on your contacts and companies. A note is attached to either a contact or a company, never both.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"note"},"id":{"type":"string","description":"The id of the note.","example":"17495962"},"created_at":{"type":"integer","format":"timestamp","description":"The time the note was created.","example":1674589321},"contact":{"type":"object","description":"Represents the contact that the note was created about.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":{"type":"string","description":"The id of the contact.","example":"214656d0c743eafcfde7f248"}}},"company":{"type":"object","description":"Represents the company that the note was created about.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":{"type":"string","description":"The id of the company.","example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}}},"author":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the Admin that created the note. When the note has no recorded admin, this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a single note and left out of each note in a list."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/admin"}]},"body":{"type":"string","description":"The body text of the note.","example":"<p>Text for the note.</p>"}}}},"components/schemas/note_list":{"id":"components/schemas/note_list","kind":"json-schema","title":"Paginated Response","data":{"title":"Paginated Response","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A paginated list of notes associated with a contact or a company. On the last page, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These lists never send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pages.prev"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"An array of notes.","items":{"$ref":"#/components/schemas/note"}},"total_count":{"type":"integer","description":"A count of the total number of notes.","example":1},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"components/schemas/open_conversation_request":{"id":"components/schemas/open_conversation_request","kind":"json-schema","title":"Open Conversation Request","data":{"title":"Open Conversation Request","type":"object","description":"Payload of the request to open a conversation","properties":{"message_type":{"type":"string","enum":["open"],"example":"open"},"admin_id":{"type":"string","description":"The id of the admin who is performing the action.","example":"5017690"},"assignee_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to assign the conversation to when it is opened. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unassign it, which clears both the teammate and the team assignee."},"children":[]}]}]}],"example":"4324241"},"skip_notifications":{"type":"boolean","description":"Option to disable notifications when opening a conversation. Available from API version 2.15.","example":true}},"required":["message_type","admin_id"]}},"components/schemas/pages_link":{"id":"components/schemas/pages_link","kind":"json-schema","title":"Pagination Object","data":{"title":"Pagination Object","type":"object","description":"The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.\n\nTheir responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.\n","properties":{"type":{"type":"string","example":"pages","enum":["pages"]},"page":{"type":"integer","example":1},"next":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to the next page of results. Omitted or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the last page, depending on the list. Some lists never include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prev"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so compare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to tell whether more pages remain."},"children":[]}]}]}],"nullable":true},"prev":{"type":"string","format":"uri","description":"A link to the previous page of results. Omitted on the first page.","nullable":true},"per_page":{"type":"integer","example":50},"total_pages":{"type":"integer","example":1}}}},"components/schemas/paginated_response":{"id":"components/schemas/paginated_response","kind":"json-schema","title":"Paginated Response","data":{"title":"Paginated Response","type":"object","description":"Paginated Response","properties":{"type":{"type":"string","description":"The type of object","enum":["list"],"example":"list"},"pages":{"$ref":"#/components/schemas/pages_link"},"total_count":{"type":"integer","description":"A count of the total number of objects.","example":1},"data":{"type":"array","description":"An array of Objects","items":{"anyOf":[{"$ref":"#/components/schemas/news_item"},{"$ref":"#/components/schemas/newsfeed"}]}}}}},"components/schemas/part_attachment":{"id":"components/schemas/part_attachment","kind":"json-schema","title":"Part attachment","data":{"title":"Part attachment","type":"object","description":"The file attached to a part","properties":{"type":{"type":"string","description":"The type of attachment","example":"upload"},"name":{"type":"string","description":"The name of the attachment","example":"example.png"},"url":{"type":"string","description":"The URL of the attachment","example":"https://picsum.photos/200/300"},"content_type":{"type":"string","description":"The content type of the attachment","example":"image/png"},"filesize":{"type":"integer","description":"The size of the attachment","example":100},"width":{"type":"integer","description":"The width of the attachment","example":100},"height":{"type":"integer","description":"The height of the attachment","example":100}}}},"components/schemas/phone_switch":{"id":"components/schemas/phone_switch","kind":"json-schema","title":"Phone Switch","data":{"title":"Phone Switch","type":"object","description":"Phone Switch Response","nullable":true,"properties":{"type":{"type":"string","description":"","enum":["phone_call_redirect"],"default":"phone_call_redirect","example":"phone_call_redirect"},"url":{"type":"string","description":"The Messenger link for the phone call redirect, which is also the link sent by SMS to the phone number.","example":"http://via.intercom.io/msgr/1add3dd1-a75e-4a96-96fd-984d16aba059"}}}},"components/schemas/quick_reply_option":{"id":"components/schemas/quick_reply_option","kind":"json-schema","title":"Quick Reply Option","data":{"title":"Quick Reply Option","type":"object","properties":{"text":{"type":"string","description":"The text to display in this quick reply option."},"uuid":{"type":"string","format":"uuid","description":"A unique identifier for this quick reply option. This value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option."}},"required":["text","uuid"]}},"components/schemas/register_fin_voice_call_request":{"id":"components/schemas/register_fin_voice_call_request","kind":"json-schema","title":"Register Fin Voice Call Request Payload","data":{"title":"Register Fin Voice Call Request Payload","type":"object","description":"Register a Fin Voice call with Intercom","nullable":true,"required":["phone_number","call_id"],"properties":{"phone_number":{"type":"string","description":"Phone number in E.164 format for the call","example":"+1234567890"},"call_id":{"type":"string","description":"External call identifier from the call provider","example":"call-123-abc"},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of the call. Can be \"five9\", \"zoom_phone\", \"nice_cxone\", \"dialpad\", \"generic\", or \"aws_connect\". Defaults to \"aws_connect\", and any other value is treated as \"aws_connect\"."},"children":[]}]}]}],"enum":["five9","zoom_phone","nice_cxone","dialpad","generic","aws_connect"],"example":"aws_connect"},"vendor_internal_id":{"type":"string","maxLength":191,"description":"Optional vendor-supplied identifier for linking the Fin Voice session to records in the vendor's own systems. Stored as-is and returned on every lookup. Cannot exceed 191 characters.","nullable":true,"example":"vendor-internal-abc-123"},"data":{"type":"object","description":"Additional metadata about the call","nullable":true,"example":{"key":"value"}}}}},"components/schemas/redact_conversation_request":{"id":"components/schemas/redact_conversation_request","kind":"json-schema","title":"redact_conversation_request","data":{"oneOf":[{"title":"Redact Conversation Part Request","type":"object","description":"Payload of the request to redact a conversation part","properties":{"type":{"type":"string","enum":["conversation_part"],"description":"The type of resource being redacted.","example":"conversation_part"},"conversation_id":{"type":"string","description":"The id of the conversation.","example":"19894788788"},"conversation_part_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the conversation_part."},"children":[]}]}]}],"example":"19381789428"}},"required":["type","conversation_id","conversation_part_id"]},{"title":"Redact Conversation Source Request","type":"object","description":"Payload of the request to redact a conversation source","properties":{"type":{"type":"string","enum":["source"],"description":"The type of resource being redacted.","example":"source"},"conversation_id":{"type":"string","description":"The id of the conversation.","example":"19894788788"},"source_id":{"type":"string","description":"The id of the source.","example":"19894781231"}},"required":["type","conversation_id","source_id"]}]}},"components/schemas/reference":{"id":"components/schemas/reference","kind":"json-schema","title":"Reference","data":{"title":"Reference","type":"object","description":"reference to another object","properties":{"type":{"type":"string","description":"","example":"contact"},"id":{"type":"string","nullable":true,"description":"","example":"1a2b3c"}}}},"components/schemas/reply_conversation_request":{"id":"components/schemas/reply_conversation_request","kind":"json-schema","title":"reply_conversation_request","data":{"oneOf":[{"$ref":"#/components/schemas/contact_reply_conversation_request"},{"$ref":"#/components/schemas/admin_reply_conversation_request"},{"$ref":"#/components/schemas/bot_reply_conversation_request"}]}},"components/schemas/search_request":{"id":"components/schemas/search_request","kind":"json-schema","title":"Search data","data":{"description":"Search using Intercoms Search APIs.","type":"object","title":"Search data","properties":{"query":{"oneOf":[{"$ref":"#/components/schemas/single_filter_search_request","title":"Single filter search request"},{"$ref":"#/components/schemas/multiple_filter_search_request","title":"multiple filter search request"}]},"pagination":{"$ref":"#/components/schemas/starting_after_paging"},"sort":{"type":"object","description":"How to sort the results. Without it, the endpoint's default order is used.","properties":{"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort by, one of the searchable fields listed for the endpoint. Some fields can't be sorted; the endpoint's Sorting section says which. A missing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or one that isn't searchable, returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"updated_at"},"order":{"type":"string","enum":["ascending","descending"],"default":"descending","description":"The sort order.","example":"descending"}},"required":["field"]}},"required":["query"]}},"components/schemas/company_search_request":{"id":"components/schemas/company_search_request","kind":"json-schema","title":"Company search request","data":{"description":"Search for companies using Intercom's Search API.","type":"object","title":"Company search request","properties":{"query":{"oneOf":[{"$ref":"#/components/schemas/single_filter_search_request","title":"Single filter search request"},{"$ref":"#/components/schemas/multiple_filter_search_request","title":"multiple filter search request"}]},"pagination":{"$ref":"#/components/schemas/starting_after_paging"},"sort":{"type":"object","description":"An optional object to sort the results by.","properties":{"field":{"type":"string","description":"The field to sort the results on.","example":"created_at"},"order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order to sort the results in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted. Values other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ascending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_sort_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ascending","descending"],"default":"descending","example":"descending"}}}},"required":["query"]}},"components/schemas/segment":{"id":"components/schemas/segment","kind":"json-schema","title":"Segment","data":{"title":"Segment","type":"object","x-tags":["Segments"],"description":"A segment is a group of your contacts defined by the rules that you set.","properties":{"type":{"type":"string","description":"The type of object.","enum":["segment"],"example":"segment"},"id":{"type":"string","description":"The unique identifier representing the segment.","example":"56203d253cba154d39010062"},"name":{"type":"string","description":"The name of the segment.","example":"Active"},"created_at":{"type":"integer","description":"The time the segment was created.","example":1394621988},"updated_at":{"type":"integer","description":"The time the segment was updated.","example":1394622004},"person_type":{"type":"string","description":"Type of the contact: contact (lead) or user.","enum":["contact","user"],"example":"contact"},"count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of items in the user segment. It's returned when the request has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a value. A company segment only gets a count when a contact segment has the same name, and it shows that segment's count."},"children":[]}]}]}],"example":3,"nullable":true}}}},"components/schemas/segment_list":{"id":"components/schemas/segment_list","kind":"json-schema","title":"Segment List","data":{"title":"Segment List","type":"object","description":"This will return a list of Segment Objects. The list is not paginated.","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment.list"],"example":"segment.list"},"segments":{"type":"array","description":"A list of Segment objects","items":{"$ref":"#/components/schemas/segment"}}}}},"components/schemas/single_filter_search_request":{"id":"components/schemas/single_filter_search_request","kind":"json-schema","title":"Single Filter Search Request","data":{"title":"Single Filter Search Request","description":"Search using Intercoms Search APIs with a single filter.","type":"object","properties":{"field":{"type":"string","description":"The accepted field that you want to search on.","example":"created_at"},"operator":{"type":"string","enum":["=","!=","IN","NIN","<","<=",">",">=","~","!~","^","$"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The accepted operators you can use to define how you want to search for the value. Operator support depends on the field's data type. The breakdown below is for Contacts search; the other search endpoints that share this schema accept a different set per field:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"~"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!~"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. Every other operator returns an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"boolean"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields (standard contact timestamps such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_seen_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Filtering is on the exact second, in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields (Date custom attributes): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supported and return an error. Values are truncated to a whole UTC day."},"children":[]}]}]}]}],"example":">"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}],"description":"The value that you want to search on.","example":"73732934","nullable":true}}}},"components/schemas/sla_applied":{"id":"components/schemas/sla_applied","kind":"json-schema","title":"Applied SLA","data":{"title":"Applied SLA","type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SLA Applied object contains the details for which SLA has been applied to this conversation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":"object type","example":"conversation_sla_summary"},"sla_name":{"type":"string","description":"The name of the SLA as given by the teammate when it was created.","example":""},"sla_status":{"type":"string","enum":["hit","missed","canceled","active"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SLA statuses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events."},"children":[]}]}]}]}],"example":"hit"}}}},"components/schemas/snooze_conversation_request":{"id":"components/schemas/snooze_conversation_request","kind":"json-schema","title":"Snooze Conversation Request","data":{"title":"Snooze Conversation Request","type":"object","description":"Payload of the request to snooze a conversation","properties":{"message_type":{"type":"string","enum":["snoozed"],"example":"snoozed"},"admin_id":{"type":"string","description":"The id of the admin who is performing the action.","example":"5017691"},"snoozed_until":{"type":"integer","format":"timestamp","description":"The time you want the conversation to reopen.","example":1673609604}},"required":["message_type","admin_id","snoozed_until"]}},"components/schemas/social_profile":{"id":"components/schemas/social_profile","kind":"json-schema","title":"Social Profile","data":{"title":"Social Profile","type":"object","description":"A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value is \"social_profile\""},"children":[]}]}]}],"example":"social_profile"},"name":{"type":"string","description":"The name of the Social media profile","example":"Facebook"},"url":{"type":"string","format":"uri","description":"The name of the Social media profile","example":"http://twitter.com/th1sland"}}}},"components/schemas/starting_after_paging":{"id":"components/schemas/starting_after_paging","kind":"json-schema","title":"Pagination: Starting After","data":{"title":"Pagination: Starting After","type":"object","nullable":true,"properties":{"per_page":{"type":"integer","description":"The number of results to fetch per page.","example":2},"starting_after":{"type":"string","description":"The cursor to use in the next request to get the next page of results.","nullable":true,"example":"your-cursor-from-response"}}}},"components/schemas/subscription_type":{"id":"components/schemas/subscription_type","kind":"json-schema","title":"Subscription Types","data":{"title":"Subscription Types","type":"object","x-tags":["Subscription Types"],"description":"A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.","properties":{"type":{"type":"string","description":"The type of the object - subscription","example":"subscription"},"id":{"type":"string","description":"The unique identifier representing the subscription type.","example":"123456"},"state":{"type":"string","description":"The state of the subscription type.","enum":["live","draft","archived"],"example":"live"},"default_translation":{"$ref":"#/components/schemas/translation"},"translations":{"type":"array","description":"An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.","items":{"$ref":"#/components/schemas/translation"}},"consent_type":{"type":"string","description":"Describes the type of consent.","enum":["opt_out","opt_in"],"example":"opt_in"},"content_types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message types that this subscription supports - can contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sms_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["email","sms_message"],"example":"email"}}}}},"components/schemas/subscription_type_list":{"id":"components/schemas/subscription_type_list","kind":"json-schema","title":"Subscription Types","data":{"title":"Subscription Types","type":"object","description":"A list of subscription type objects.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of subscription type objects associated with the workspace .","items":{"$ref":"#/components/schemas/subscription_type"}}}}},"components/schemas/tag":{"id":"components/schemas/tag","kind":"json-schema","title":"Tag","data":{"title":"Tag","type":"object","x-tags":["Tags"],"description":"A tag allows you to label your contacts, companies, conversations, tickets, articles, internal articles, content snippets and external pages, and list them using that tag.","properties":{"type":{"type":"string","description":"value is \"tag\"","example":"tag"},"id":{"type":"string","description":"The id of the tag","example":"123456"},"name":{"type":"string","description":"The name of the tag","example":"Test tag"},"applied_at":{"type":"integer","format":"timestamp","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, ticket, article, internal article, content snippet, or external page, when listing the tags on a contact, or when it is returned as part of an external page. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the tag has just been removed from an article, internal article, content snippet or external page. Removing a tag from a contact, conversation or ticket returns the original value."},"children":[]}]}]}],"example":1663597223},"applied_by":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, ticket, article, internal article, content snippet, or external page, when listing the tags on a contact, or when it is returned as part of an external page. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the tag has just been removed from an article, internal article, content snippet or external page. Removing a tag from a contact, conversation or ticket returns the original value. When no admin is recorded, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nobody_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/reference"}]}}}},"components/schemas/tag_basic":{"id":"components/schemas/tag_basic","kind":"json-schema","title":"Tag","data":{"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"}}}},"components/schemas/tag_create_response":{"id":"components/schemas/tag_create_response","kind":"json-schema","title":"Create or Update Tag Response","data":{"title":"Create or Update Tag Response","description":"The response for creating or updating a tag, including the entities that were tagged or untagged.","allOf":[{"$ref":"#/components/schemas/tag_basic"},{"type":"object","properties":{"users":{"type":"array","nullable":true,"description":"The users that were tagged or untagged.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Intercom ID of the user.","example":"6329e838deab40166d1a53f7"},"tagged":{"type":"boolean","description":"Whether the user was tagged (true) or untagged (false).","example":true}}},"example":[]},"companies":{"type":"array","nullable":true,"description":"The companies that were tagged or untagged.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Intercom ID of the company.","example":"6329e838deab40166d1a5400"},"tagged":{"type":"boolean","description":"Whether the company was tagged (true) or untagged (false).","example":true}}},"example":[]}}}]}},"components/schemas/tag_company_request":{"id":"components/schemas/tag_company_request","kind":"json-schema","title":"Tag Company Request Payload","data":{"description":"You can tag a single company or a list of companies.","type":"object","title":"Tag Company Request Payload","properties":{"name":{"type":"string","maxLength":191,"description":"The name of the tag, which will be created if not found. Names can be at most 191 characters long.","example":"Independent"},"companies":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The Intercom defined id representing the company.","example":"531ee472cce572a6ec000006"},"company_id":{"type":"string","description":"The company id you have defined for the company.","example":"6"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, used to look it up when neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is given."},"children":[]}]}]}],"example":"Intercom"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id, company_id or name of the company can be passed as input parameters. Companies that cannot be found are skipped."},"children":[]}]}]}]}},"required":["name","companies"]}},"components/schemas/tag_list":{"id":"components/schemas/tag_list","kind":"json-schema","title":"Tags","data":{"title":"Tags","type":"object","description":"A list of tags objects in the workspace.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of tags objects associated with the workspace .","items":{"$ref":"#/components/schemas/tag"}}}}},"components/schemas/tag_multiple_users_request":{"id":"components/schemas/tag_multiple_users_request","kind":"json-schema","title":"Tag Users Request Payload","data":{"description":"You can tag or untag a list of users.","type":"object","title":"Tag Users Request Payload","properties":{"name":{"type":"string","maxLength":191,"description":"The name of the tag, which will be created if not found. Names can be at most 191 characters long.","example":"Independent"},"users":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id, user_id or email of the user can be passed as input parameters. Users that cannot be found are skipped."},"children":[]}]}]}],"items":{"properties":{"id":{"type":"string","description":"The Intercom defined id representing the user.","example":"5f7f0d217289f8d2f4262080"},"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user id you have defined for the user, used to look it up when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not given."},"children":[]}]}]}],"example":"25"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address of the user, used to look it up when neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is given."},"children":[]}]}]}],"example":"jane@example.com"},"untag":{"type":"boolean","description":"Set to true to remove the tag from this user instead of applying it.","example":true}}}}},"required":["name","users"]}},"components/schemas/tags":{"id":"components/schemas/tags","kind":"json-schema","title":"Tags","data":{"title":"Tags","type":"object","description":"A list of tags objects associated with a conversation, article or internal article","properties":{"type":{"type":"string","description":"The type of the object","enum":["tag.list"],"example":"tag.list"},"tags":{"type":"array","description":"A list of tags objects associated with the object.","items":{"$ref":"#/components/schemas/tag"}}}}},"components/schemas/team":{"id":"components/schemas/team","kind":"json-schema","title":"Team","data":{"title":"Team","type":"object","x-tags":["Teams"],"description":"Teams are groups of admins in Intercom.","properties":{"type":{"type":"string","description":"Value is always \"team\"","example":"team"},"id":{"type":"string","description":"The id of the team","example":"814865"},"name":{"type":"string","description":"The name of the team","example":"Example Team"},"admin_ids":{"type":"array","description":"The list of admin IDs that are a part of the team.","example":[493881],"items":{"type":"integer"}},"admin_priority_level":{"$ref":"#/components/schemas/admin_priority_level"},"assignment_limit":{"type":"integer","nullable":true,"description":"The assignment limit for the team. This field is only present when the team's distribution type is load balanced.","example":10},"distribution_method":{"type":"string","nullable":true,"description":"Describes how assignments are distributed among the team members","example":"round_robin"}}}},"components/schemas/team_list":{"id":"components/schemas/team_list","kind":"json-schema","title":"Team List","data":{"title":"Team List","type":"object","description":"This will return a list of team objects for the App.","properties":{"type":{"type":"string","description":"The type of the object","enum":["team.list"],"example":"team.list"},"teams":{"type":"array","description":"A list of team objects","items":{"$ref":"#/components/schemas/team"}}}}},"components/schemas/team_priority_level":{"id":"components/schemas/team_priority_level","kind":"json-schema","title":"Team Priority Level","data":{"title":"Team Priority Level","type":"object","nullable":true,"description":"Admin priority levels for teams","properties":{"primary_team_ids":{"type":"array","description":"The primary team ids for the team","nullable":true,"example":[814865],"items":{"type":"integer"}},"secondary_team_ids":{"type":"array","description":"The secondary team ids for the team","nullable":true,"example":[493881],"items":{"type":"integer"}}}}},"components/schemas/teammate_reference":{"id":"components/schemas/teammate_reference","kind":"json-schema","title":"Teammate Reference","data":{"title":"Teammate Reference","type":"object","description":"A reference to a teammate","required":["type","id","name"],"properties":{"type":{"type":"string","enum":["admin","team","bot"],"description":"The type of teammate","example":"admin"},"id":{"type":"integer","description":"The unique identifier of the teammate","example":123},"name":{"type":"string","description":"The display name of the teammate","example":"Jane Example"},"email":{"type":"string","format":"email","description":"The email address of the teammate (optional for teams/bots)","example":"jane@example.com","nullable":true}}}},"components/schemas/ticket":{"id":"components/schemas/ticket","kind":"json-schema","title":"Ticket","data":{"title":"Ticket","type":"object","x-tags":["Tickets"],"description":"Tickets are how you track requests from your users.","nullable":true,"properties":{"type":{"type":"string","description":"Always ticket","enum":["ticket"],"default":"ticket","example":"ticket"},"id":{"type":"string","description":"The unique identifier for the ticket which is given by Intercom.","example":"1295"},"ticket_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries."},"children":[]}]}]}],"example":"1390"},"category":{"type":"string","description":"Category of the Ticket.","enum":["Customer","Back-office","Tracker"],"example":"Customer"},"ticket_attributes":{"$ref":"#/components/schemas/ticket_custom_attributes"},"ticket_state":{"$ref":"#/components/schemas/ticket_state"},"ticket_type":{"$ref":"#/components/schemas/ticket_type"},"contacts":{"$ref":"#/components/schemas/ticket_contacts"},"admin_assignee_id":{"type":"integer","description":"The id representing the admin assigned to the ticket. If it's not assigned to an admin it will return 0.","example":1295},"team_assignee_id":{"type":"integer","description":"The id representing the team assigned to the ticket. If it's not assigned to a team it will return 0.","example":1295},"created_at":{"type":"integer","format":"date-time","description":"The time the ticket was created as a UTC Unix timestamp.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the ticket was updated as a UTC Unix timestamp.","example":1663597260},"open":{"type":"boolean","description":"Whether or not the ticket is open. If false, the ticket is closed.","example":true},"snoozed_until":{"type":"integer","format":"date-time","description":"The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.","example":1663597260},"linked_objects":{"$ref":"#/components/schemas/linked_object_list"},"ticket_parts":{"$ref":"#/components/schemas/ticket_parts"},"is_shared":{"type":"boolean","description":"Whether or not the ticket is shared with the customer.","example":true},"company_id":{"type":"string","nullable":true,"description":"The ID of the company the ticket is associated with. Omitted when the ticket has no company.","example":"531ee472cce572a6ec000006"},"channel":{"type":"string","nullable":true,"description":"The channel the ticket was created through. Defaults to messenger when no channel is specified at creation.","example":"messenger"},"previous_ticket_state_id":{"type":"string","nullable":true,"description":"The ID of the previous ticket state from the most recent state change. Returns null if no state change history exists. Useful for tracking state transitions for reporting and compliance.","example":"7493"}}}},"components/schemas/ticket_deleted":{"id":"components/schemas/ticket_deleted","kind":"json-schema","title":"Ticket Deleted","data":{"title":"Ticket Deleted","type":"object","description":"deleted ticket object","properties":{"id":{"type":"string","description":"The unique identifier for the ticket.","example":"5ba682d23d7cf92bef87bfd4"},"object":{"type":"string","description":"always ticket","enum":["ticket"],"example":"ticket"},"deleted":{"type":"boolean","description":"Whether the ticket is deleted or not.","example":true}}}},"components/schemas/ticket_contacts":{"id":"components/schemas/ticket_contacts","kind":"json-schema","title":"Contacts","data":{"title":"Contacts","type":"object","x-tags":["Tickets"],"description":"The list of contacts affected by a ticket.","properties":{"type":{"type":"string","description":"always contact.list","enum":["contact.list"],"example":"contact.list"},"contacts":{"type":"array","description":"The list of contacts affected by this ticket.","items":{"$ref":"#/components/schemas/contact_reference"}}}}},"components/schemas/ticket_custom_attributes":{"id":"components/schemas/ticket_custom_attributes","kind":"json-schema","title":"Ticket Attributes","data":{"title":"Ticket Attributes","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_default_title_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_default_description_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"$ref":"#/components/schemas/file_attribute"}},{"$ref":"#/components/schemas/file_attribute"}]},"example":{"_default_title_":"Found a bug","_default_description_":"The button's not working"}}},"components/schemas/ticket_list":{"id":"components/schemas/ticket_list","kind":"json-schema","title":"Ticket List","data":{"title":"Ticket List","type":"object","description":"Tickets are how you track requests from your users.","properties":{"type":{"type":"string","description":"Always ticket.list","enum":["ticket.list"],"example":"ticket.list"},"tickets":{"type":"array","description":"The list of ticket objects","items":{"$ref":"#/components/schemas/ticket"}},"total_count":{"type":"integer","description":"A count of the total number of objects.","example":12345},"pages":{"$ref":"#/components/schemas/cursor_pages"}}}},"components/schemas/ticket_part":{"id":"components/schemas/ticket_part","kind":"json-schema","title":"Ticket Part","data":{"title":"Ticket Part","type":"object","x-tags":["Tickets"],"description":"A Ticket Part represents a message in the ticket.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always ticket_part"},"children":[]}]}]}],"example":"ticket_part"},"id":{"type":"string","description":"The id representing the ticket part.","example":"3"},"part_type":{"type":"string","description":"The type of ticket part.","example":"comment"},"body":{"type":"string","nullable":true,"description":"The message body, which may contain HTML.","example":"<p>Okay!</p>"},"previous_ticket_state":{"type":"string","enum":["submitted","in_progress","waiting_on_customer","resolved"],"description":"The previous state of the ticket.","example":"submitted"},"ticket_state":{"type":"string","enum":["submitted","in_progress","waiting_on_customer","resolved"],"description":"The state of the ticket.","example":"submitted"},"created_at":{"type":"integer","format":"date-time","description":"The time the ticket part was created.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the ticket part was updated.","example":1663597260},"assigned_to":{"$ref":"#/components/schemas/reference","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assignee this ticket_part assigned the ticket to, as a reference whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the part unassigned the ticket, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nobody_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Null when the part did not change the assignment, or when the assignee has since been deleted."},"children":[]}]}]}]},"admin_assignee_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the teammate that this ticket_part assigned the ticket to, or 0 if the part removed the teammate. Null or absent when the part did not change the teammate, including an unassignment that did not name which assignee it cleared. A bot is reported here, because assignment treats anything that is not a team as a teammate."},"children":[]}]}]}],"example":991268013},"team_assignee_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the team that this ticket_part assigned the ticket to, or 0 if the part removed the team. Null or absent when the part did not change the team, including an unassignment that did not name which assignee it cleared. A part can assign a team and a teammate at the same time, for example when the team uses Round Robin distribution and the teammate is resolved inline. In that case assigned_to reports only the teammate, and these two fields report each assignee separately."},"children":[]}]}]}],"example":5017691},"author":{"$ref":"#/components/schemas/ticket_part_author"},"attachments":{"title":"Ticket part attachments","type":"array","description":"A list of attachments for the part.","items":{"$ref":"#/components/schemas/part_attachment"}},"external_id":{"type":"string","nullable":true,"description":"The external id of the ticket part","example":"abcd1234"},"redacted":{"type":"boolean","description":"Whether or not the ticket part has been redacted.","example":false},"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."},"translations":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of the reply text keyed by locale code. Backs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket.admin.replied.translated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook topic. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"original"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the locale code the reply was written in, when it is known; every other key holds the reply translated into that locale."},"children":[]}]}]}],"properties":{"original":{"type":"string","description":"The locale code identifying the language the reply was originally written in.","example":"en"}},"additionalProperties":{"type":"string"},"example":{"original":"en","en":"<p>Hello</p>","fr":"<p>Bonjour</p>"}},"updated_attribute_data":{"title":"Updated Attribute","type":"object","description":"The updated attribute data of the ticket part. Only present for attribute update parts.","nullable":true,"properties":{"attribute":{"type":"object","description":"Information about the attribute that was updated.","properties":{"type":{"type":"string","description":"The type of the object. Always 'attribute'.","enum":["attribute"],"example":"attribute"},"id":{"type":"string","description":"The unique identifier of the attribute.","example":"7"},"label":{"type":"string","description":"The human-readable name of the attribute.","example":"Progress"}},"required":["type","id","label"]},"value":{"type":"object","description":"The new value of the attribute.","properties":{"type":{"type":"string","description":"The type of the object. Always 'value'.","enum":["value"],"example":"value"},"id":{"oneOf":[{"type":"string","description":"The value for text/number/decimal/boolean/date attributes, or the ID of the list option for list attributes.","nullable":true,"example":"Fast"},{"type":"array","description":"Array of file IDs for file attributes.","items":{"type":"integer"},"example":[2]}]},"label":{"oneOf":[{"type":"string","description":"The display value for text/number/decimal/boolean/date/list attributes.","example":"Fast"},{"type":"array","description":"Array of file names for file attributes.","items":{"type":"string"},"example":["photo.png"]}]}},"required":["type","id","label"]}},"required":["attribute","value"]}}}},"components/schemas/ticket_part_author":{"id":"components/schemas/ticket_part_author","kind":"json-schema","title":"Ticket part author","data":{"title":"Ticket part author","type":"object","description":"The author that wrote or triggered the part. Can be a bot, admin, team or user.","properties":{"type":{"type":"string","description":"The type of the author","example":"admin","enum":["admin","bot","team","user"]},"id":{"type":"string","description":"The id of the author","example":"274"},"name":{"type":"string","nullable":true,"description":"The name of the author","example":"Operator"},"email":{"type":"string","format":"email","description":"The email of the author","example":"operator+abcd1234@intercom.io"}}}},"components/schemas/ticket_parts":{"id":"components/schemas/ticket_parts","kind":"json-schema","title":"Ticket Parts","data":{"title":"Ticket Parts","type":"object","description":"A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.","properties":{"type":{"type":"string","description":"","enum":["ticket_part.list"],"example":"ticket_part.list"},"ticket_parts":{"title":"Tickt Parts","type":"array","description":"A list of Ticket Part objects for each ticket. There is a limit of 500 parts.","items":{"$ref":"#/components/schemas/ticket_part"}},"total_count":{"type":"integer","description":"","example":2}}}},"components/schemas/ticket_reply":{"id":"components/schemas/ticket_reply","kind":"json-schema","title":"A Ticket Part representing a note, comment, or quick_reply on a ticket","data":{"title":"A Ticket Part representing a note, comment, or quick_reply on a ticket","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Ticket Part representing a note, comment, or quick_reply on a ticket"},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always ticket_part"},"children":[]}]}]}],"example":"ticket_part","enum":["ticket_part"]},"id":{"type":"string","description":"The id representing the part.","example":"3"},"part_type":{"type":"string","description":"Type of the part","example":"note","enum":["note","comment","quick_reply"]},"body":{"type":"string","nullable":true,"description":"The message body, which may contain HTML.","example":"<p>Okay!</p>"},"created_at":{"type":"integer","format":"date-time","description":"The time the note was created.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the note was updated.","example":1663597260},"author":{"$ref":"#/components/schemas/ticket_part_author"},"attachments":{"title":"Ticket part attachments","type":"array","description":"A list of attachments for the part.","items":{"$ref":"#/components/schemas/part_attachment"}},"redacted":{"type":"boolean","description":"Whether or not the ticket part has been redacted.","example":false},"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."},"translations":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of the reply text keyed by locale code. Backs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket.admin.replied.translated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook topic. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"original"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the locale code the reply was written in, when it is known; every other key holds the reply translated into that locale."},"children":[]}]}]}],"properties":{"original":{"type":"string","description":"The locale code identifying the language the reply was originally written in.","example":"en"}},"additionalProperties":{"type":"string"},"example":{"original":"en","en":"<p>Hello</p>","fr":"<p>Bonjour</p>"}}}}},"components/schemas/ticket_request_custom_attributes":{"id":"components/schemas/ticket_request_custom_attributes","kind":"json-schema","title":"Ticket Attributes","data":{"title":"Ticket Attributes","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_default_title_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_default_description_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"ref:get_ticket-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"listing the ticket type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if the ticket type has an attribute called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the key should be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the value of the attribute should be the guid of the list item (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de1825a0-0164-4070-8ca6-13e22462fa7e"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute, pass an array of upload ids; for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relationship"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute, pass an array of related object ids as strings."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"integer"}},{"type":"array","items":{"type":"string"}}]},"example":{"_default_title_":"Found a bug","_default_description_":"The button is not working"}}},"components/schemas/ticket_state":{"id":"components/schemas/ticket_state","kind":"json-schema","title":"Ticket State","data":{"title":"Ticket State","type":"object","x-tags":["Tickets"],"description":"A ticket state, used to define the state of a ticket.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ticket_state"},"id":{"type":"string","description":"The id of the ticket state","example":"12"},"category":{"type":"string","description":"The category of the ticket state","example":"in_progress","enum":["submitted","in_progress","waiting_on_customer","resolved"]},"internal_label":{"type":"string","description":"The state the ticket is currently in, in a human readable form - visible in Intercom","example":"With Dev Team"},"external_label":{"type":"string","description":"The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.","example":"In Progress"}}}},"components/schemas/ticket_state_detailed":{"id":"components/schemas/ticket_state_detailed","kind":"json-schema","title":"Ticket State","data":{"title":"Ticket State","type":"object","x-tags":["Tickets"],"description":"A ticket state, used to define the state of a ticket.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ticket_state"},"id":{"type":"string","description":"The id of the ticket state","example":"12"},"category":{"type":"string","description":"The category of the ticket state","example":"in_progress","enum":["submitted","in_progress","waiting_on_customer","resolved"]},"internal_label":{"type":"string","description":"The state the ticket is currently in, in a human readable form - visible in Intercom","example":"With Dev Team"},"external_label":{"type":"string","description":"The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.","example":"In Progress"},"archived":{"type":"boolean","description":"Whether the ticket state is archived","example":false},"ticket_types":{"type":"object","description":"A list of the ticket types that use this ticket state.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"A summary of each ticket type that uses this ticket state. It doesn't include the ticket type's attributes or ticket states; retrieve the ticket type for those.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ticket_type"},"id":{"type":"string","description":"The id representing the ticket type.","example":"1295"},"name":{"type":"string","description":"The name of the ticket type","example":"Bug"},"description":{"type":"string","description":"The description of the ticket type","example":"A bug that has been reported."},"icon":{"type":"string","description":"The icon of the ticket type","example":"🐞"},"archived":{"type":"boolean","description":"Whether the ticket type is archived or not.","example":false},"is_internal":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if tickets of this type are internal only and can never be shared with customers; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if they are, or can be, shared."},"children":[]}]}]}],"example":false},"category":{"type":"string","description":"Category of the Ticket Type.","enum":["Customer","Back-office","Tracker"],"example":"Customer"}}}}}}}}},"components/schemas/ticket_state_list":{"id":"components/schemas/ticket_state_list","kind":"json-schema","title":"Ticket States","data":{"title":"Ticket States","type":"object","description":"A list of ticket states associated with a given ticket type.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"A list of ticket states associated with a given ticket type.","items":{"$ref":"#/components/schemas/ticket_state_detailed"}}}}},"components/schemas/ticket_type":{"id":"components/schemas/ticket_type","kind":"json-schema","title":"Ticket Type","data":{"title":"Ticket Type","type":"object","x-tags":["Tickets"],"description":"A ticket type, used to define the data fields to be captured in a ticket.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ticket_type"},"id":{"type":"string","description":"The id representing the ticket type.","example":"1295"},"category":{"type":"string","description":"Category of the Ticket Type.","enum":["Customer","Back-office","Tracker"],"example":"Customer"},"name":{"type":"string","description":"The name of the ticket type","example":"Bug"},"description":{"type":"string","description":"The description of the ticket type","example":"A bug that has been reported."},"icon":{"type":"string","description":"The icon of the ticket type","example":"🐞"},"workspace_id":{"type":"string","description":"The id of the workspace that the ticket type belongs to.","example":"ecahpwf5"},"ticket_type_attributes":{"$ref":"#/components/schemas/ticket_type_attribute_list"},"ticket_states":{"title":"Ticket States","type":"object","description":"A list of ticket states associated with a given ticket type.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"A list of ticket states associated with a given ticket type.","items":{"$ref":"#/components/schemas/ticket_state"}}}},"archived":{"type":"boolean","description":"Whether the ticket type is archived or not.","example":false},"is_internal":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if tickets of this type are internal only and can never be shared with customers; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if they are, or can be, shared."},"children":[]}]}]}],"example":false},"created_at":{"type":"integer","format":"timestamp","description":"The date and time the ticket type was created."},"updated_at":{"type":"integer","format":"timestamp","description":"The date and time the ticket type was last updated."}}}},"components/schemas/ticket_type_attribute":{"id":"components/schemas/ticket_type_attribute","kind":"json-schema","title":"Ticket Type Attribute","data":{"title":"Ticket Type Attribute","type":"object","description":"Ticket type attribute, used to define each data field to be captured in a ticket.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_type_attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ticket_type_attribute"},"id":{"type":"string","description":"The id representing the ticket type attribute.","example":"1"},"workspace_id":{"type":"string","description":"The id of the workspace that the ticket type attribute belongs to.","example":"ecahpwf5"},"name":{"type":"string","description":"The name of the ticket type attribute","example":"Title"},"description":{"type":"string","description":"The description of the ticket type attribute","example":"Bug title."},"data_type":{"type":"string","description":"The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")","example":"string"},"input_options":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input options for the attribute. For a string attribute this holds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multiline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it was set; for a list attribute it holds the list's options. When the attribute has no input options, this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or left out of the create and update ticket type attribute responses."},"children":[]}]}]}],"example":{"multiline":true}},"order":{"type":"integer","description":"The order of the attribute against other attributes","example":1},"required_to_create":{"type":"boolean","description":"Whether the attribute is required or not for teammates.","default":false,"example":false},"required_to_create_for_contacts":{"type":"boolean","description":"Whether the attribute is required or not for contacts.","default":false,"example":false},"visible_on_create":{"type":"boolean","description":"Whether the attribute is visible or not to teammates.","default":true,"example":false},"visible_to_contacts":{"type":"boolean","description":"Whether the attribute is visible or not to contacts.","default":true,"example":false},"default":{"type":"boolean","description":"Whether the attribute is built in or not.","example":true},"ticket_type_id":{"type":"integer","description":"The id of the ticket type that the attribute belongs to.","example":42},"archived":{"type":"boolean","description":"Whether the ticket type attribute is archived or not.","example":false},"created_at":{"type":"integer","format":"timestamp","description":"The date and time the ticket type attribute was created."},"updated_at":{"type":"integer","format":"timestamp","description":"The date and time the ticket type attribute was last updated."}}}},"components/schemas/ticket_type_attribute_list":{"id":"components/schemas/ticket_type_attribute_list","kind":"json-schema","title":"Ticket Type Attributes","data":{"title":"Ticket Type Attributes","type":"object","description":"A list of attributes associated with a given ticket type.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":"A list of ticket type attributes associated with a given ticket type.","items":{"$ref":"#/components/schemas/ticket_type_attribute"}}}}},"components/schemas/ticket_type_list":{"id":"components/schemas/ticket_type_list","kind":"json-schema","title":"Ticket Types","data":{"title":"Ticket Types","type":"object","description":"A list of ticket types associated with a given workspace.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object's type. Always has the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"list"},"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of ticket_types associated with a given workspace."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ticket_type"}}}}},"components/schemas/translation":{"id":"components/schemas/translation","kind":"json-schema","title":"Translation","data":{"title":"Translation","type":"object","description":"A translation object contains the localised details of a subscription type.","properties":{"name":{"type":"string","description":"The localised name of the subscription type.","example":"Announcements"},"description":{"type":"string","description":"The localised description of the subscription type.","example":"Offers, product and feature announcements"},"locale":{"type":"string","description":"The two character identifier for the language of the translation object.","example":"en"}}}},"components/schemas/untag_company_request":{"id":"components/schemas/untag_company_request","kind":"json-schema","title":"Untag Company Request Payload","data":{"description":"You can tag a single company or a list of companies.","type":"object","title":"Untag Company Request Payload","properties":{"name":{"type":"string","maxLength":191,"description":"The name of the tag which will be untagged from the company. Names can be at most 191 characters long.","example":"Independent"},"companies":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The Intercom defined id representing the company.","example":"531ee472cce572a6ec000006"},"company_id":{"type":"string","description":"The company id you have defined for the company.","example":"6"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, used to look it up when neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is given."},"children":[]}]}]}],"example":"Intercom"},"untag":{"type":"boolean","description":"Always set to true","example":true}},"required":["untag"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id, company_id or name of the company can be passed as input parameters. Companies that cannot be found are skipped."},"children":[]}]}]}]}},"required":["name","companies"]}},"components/schemas/update_audience_request":{"id":"components/schemas/update_audience_request","kind":"json-schema","title":"Update Audience Request","data":{"title":"Update Audience Request","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for updating an audience. All fields are optional — only provided fields will be updated."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"The name of the audience.","example":"Enterprise Accounts"},"predicates":{"type":"array","description":"The predicates that define which contacts belong to the audience.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"custom_attributes.plan","type":"string","comparison":"eq","value":"enterprise"}]},"role_predicates":{"type":"array","description":"Role-based predicates that further filter audience membership by contact role.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}]}}}},"components/schemas/publish_article_draft_request":{"id":"components/schemas/publish_article_draft_request","kind":"json-schema","title":"Publish Article Draft Request Payload","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional body for publishing a staged article draft. On a single-language"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"workspace the body can be omitted. On a multilingual workspace, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locales"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is required and lists which locales' drafts to publish."},"children":[]}]}]}],"type":"object","title":"Publish Article Draft Request Payload","nullable":true,"properties":{"locales":{"type":"array","description":"The locales whose staged drafts should be published. Required on\nmultilingual workspaces; each locale must have a pending draft.\n","items":{"type":"string"},"example":["en","fr"]},"author_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the teammate to publish as. This is only used when the access token is not associated with a teammate, and is then required; omitting it returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise the authenticating teammate is used. Must be a teammate on the workspace."},"children":[]}]}]}],"example":1295}}}},"components/schemas/update_article_request":{"id":"components/schemas/update_article_request","kind":"json-schema","title":"Update Article Request Payload","data":{"description":"You can Update an Article","type":"object","title":"Update Article Request Payload","nullable":true,"properties":{"title":{"type":"string","description":"The title of the article. For multilingual articles, this will be the title of the default language's content.","example":"Thanks for everything"},"description":{"type":"string","description":"The description of the article. For multilingual articles, this will be the description of the default language's content.","example":"Description of the Article"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in HTML. For multilingual articles, this will be the body of the default language's content. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"<p>This is the body in html</p>"},"body_markdown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in markdown. For multilingual articles, this will be the body of the default language's content. An alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — you can provide content as markdown instead of HTML. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"## Updated heading\n\nNew content.\n"},"author_id":{"type":"integer","description":"The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.","example":1295},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the article will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or will be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitting this field leaves the publish state unchanged, so a draft stays a draft and an edit to a published article goes live immediately unless that article already has a pending draft or a scheduled publish time is set in the same request. For multilingual articles, this will be the state of the default language's content."},"children":[]}]}]}],"enum":["published","draft"],"example":"draft"},"parent_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the collection or section to move the article into. Omitting this field or sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" leaves the article's parent unchanged. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove the article from its collection so that it stands alone."},"children":[]}]}]}],"example":"18"},"parent_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ids of the parent collections to place this article in. Send an empty array to remove the article from all collections. When provided, this takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"integer"},"example":[18,19]},"translated_content":{"$ref":"#/components/schemas/article_translated_content"},"folder_id":{"type":"integer","nullable":true,"description":"The ID of the folder to place this article in, or null to remove it from its folder.","example":6},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to assign to this article for Fin AI Agent targeting. Sending a top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" broadcasts the same set to every locale. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience_ids: []"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears all audience memberships from every locale. For per-locale targeting, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translated_content.<locale>.audience_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Sending both top-level and per-locale in the same request causes top-level to win. Unknown audience IDs return a 404 error. No partial commit occurs."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the article should be available for AI Chatbot (Fin). For multilingual articles, this sets the default language's availability.","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the article should be available for AI Copilot. For multilingual articles, this sets the default language's availability.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the article should be available for AI Sales Agent. For multilingual articles, this sets the default language's availability.","example":true},"scheduled_publish_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 timestamp at which to schedule a future publish of the article. When set together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"published\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the article is scheduled instead of published immediately. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels a pending publish schedule. Timestamps in the past or equal to the current time are rejected with 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the value must be strictly in the future. Combining with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"draft\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sending in the same request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_unpublish_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400 — only one pending schedule per article. Empty string returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-12-31T09:00:00Z"},"scheduled_unpublish_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 timestamp at which to schedule a future unpublish of the article. The article must already be published; setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"published\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the same request does not count, and the request returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Combining with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: \"draft\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value must be strictly in the future; timestamps in the past or equal to the current time are rejected with 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cancels a pending unpublish schedule. Sending in the same request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_publish_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400 — only one pending schedule per article. Empty string returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-12-31T17:00:00Z"}}}},"components/schemas/update_internal_article_request":{"id":"components/schemas/update_internal_article_request","kind":"json-schema","title":"Update Internal Article Request Payload","data":{"description":"You can Update an Internal Article","type":"object","title":"Update Internal Article Request Payload","nullable":true,"properties":{"title":{"type":"string","description":"The title of the article.","example":"Thanks for everything"},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in HTML. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"body_markdown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article in markdown. An alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — you can provide content as markdown instead of HTML. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"## Updated\n\nNew content.\n"},"json_blocks":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the article as a list of content blocks. Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If none of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body_markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json_blocks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the existing content is kept."},"children":[]}]}]}],"items":{"type":"object"}},"locale":{"type":"string","description":"The locale of the article. If omitted, the existing locale is kept.","example":"en"},"author_id":{"type":"integer","description":"The id of the author of the article.","example":1295},"owner_id":{"type":"integer","description":"The id of the author of the article.","example":1295},"folder_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the folder to place this article in. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove it from its folder. If omitted, the folder is unchanged."},"children":[]}]}]}],"example":6},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to target this internal article to for Fin AI Agent. Omitting the field leaves existing audience memberships unchanged (PATCH semantics). Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear all audience memberships. Unknown audience IDs return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with no partial commit."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the internal article should be available for AI Chatbot (Fin).","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the internal article should be available for AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the internal article should be available for AI Sales Agent.","example":true}}}},"components/schemas/update_collection_request":{"id":"components/schemas/update_collection_request","kind":"json-schema","title":"Update Collection Request Payload","data":{"description":"You can update a collection","type":"object","title":"Update Collection Request Payload","properties":{"name":{"type":"string","description":"The name of the collection. For multilingual collections, this will be the name of the default language's content.","example":"collection 51"},"description":{"type":"string","description":"The description of the collection. For multilingual collections, this will be the description of the default language's content.","example":"English description"},"icon":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The icon of the collection, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"book-bookmark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you leave out "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"icon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or send it empty, the collection's icon is reset to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"book-bookmark"},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"},"parent_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the parent collection to move the collection into. Omitting this field or sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" leaves the collection where it is. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move it to the first level."},"children":[]}]}]}],"example":"6871118"},"help_center_id":{"type":"integer","nullable":true,"description":"Checked against the collection's Help Center but not applied, so it can't move the collection to another Help Center.","example":123}}}},"components/schemas/update_contact_request":{"id":"components/schemas/update_contact_request","kind":"json-schema","title":"Update Contact Request Payload","data":{"description":"You can update a contact","type":"object","title":"Update Contact Request Payload","properties":{"role":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role of the contact, either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Any other value is ignored. A user can't be changed to a lead; sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a user returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},"external_id":{"type":"string","description":"A unique identifier for the contact which is given to Intercom"},"email":{"type":"string","description":"The contacts email","example":"jdoe@example.com"},"email_verified":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the contact has proved they own this email address, for example through a confirmation link or one-time code you sent. Send it together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing a contact's email resets it to not verified. Intercom reuses leads with a verified email when an inbound email, conversation or ticket matches the address."},"children":[]}]}]}],"example":true},"phone":{"type":"string","nullable":true,"description":"The contacts phone","example":"+353871234567"},"name":{"type":"string","nullable":true,"description":"The contacts name","example":"John Doe"},"avatar":{"type":"string","nullable":true,"description":"An image URL containing the avatar of a contact","example":"https://www.example.com/avatar_image.jpg"},"signed_up_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time specified for when a contact signed up.","example":1571672154},"last_seen_at":{"type":"integer","format":"date-time","nullable":true,"description":"(Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).","example":1571672154},"owner_id":{"type":"string","nullable":true,"description":"The id of an admin that has been assigned account ownership of the contact","example":"321"},"unsubscribed_from_emails":{"type":"boolean","nullable":true,"description":"Whether the contact is unsubscribed from emails","example":true},"sms_consent":{"type":"boolean","description":"Whether the contact has consented to receive SMS messages.","example":false},"unsubscribed_from_sms":{"type":"boolean","description":"Whether the contact is unsubscribed from SMS messages.","example":false},"language_override":{"type":"string","nullable":true,"description":"A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.","example":"en"},"custom_attributes":{"type":"object","nullable":true,"description":"The custom attributes which are set for the contact"}}}},"components/schemas/update_content_import_source_request":{"id":"components/schemas/update_content_import_source_request","kind":"json-schema","title":"Update Content Import Source Payload","data":{"title":"Update Content Import Source Payload","type":"object","description":"You can modify a Content Import Source of your Fin Content Library.","nullable":false,"properties":{"sync_behavior":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you intend to create or update External Pages via the API, this should be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can not change the value to or from api."},"children":[]}]}]}],"enum":["api","automatic","manual"],"example":"api"},"status":{"type":"string","description":"The status of the content import source.","enum":["active","deactivated"],"default":"active","example":"active"},"url":{"type":"string","description":"The URL of the content import source. It must be an http or https URL whose host is a valid public domain name. This may only be different from the existing value if the sync behavior is API.","example":"https://help.example.com"},"audience_ids":{"nullable":true,"description":"The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers. Set to null or an empty array to remove all audiences.","example":[5678],"oneOf":[{"type":"integer"},{"type":"array","items":{"type":"integer"}}]},"apply_audience_to_existing_content":{"type":"boolean","description":"When true, the audience will be applied to all existing external pages belonging to this content import source.","default":false,"example":false}},"required":["sync_behavior","url"]}},"components/schemas/update_conversation_request":{"id":"components/schemas/update_conversation_request","kind":"json-schema","title":"Update Conversation Request","data":{"title":"Update Conversation Request","type":"object","description":"Payload of the request to update a conversation","properties":{"read":{"type":"boolean","description":"Mark a conversation as read within Intercom.","example":true},"title":{"type":"string","description":"The title given to the conversation","example":"Conversation Title"},"custom_attributes":{"$ref":"#/components/schemas/custom_attributes_request"},"company_id":{"type":"string","description":"The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.","example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}}}},"components/schemas/update_data_attribute_request":{"id":"components/schemas/update_data_attribute_request","kind":"json-schema","title":"Update Data Attribute Request","data":{"description":"","type":"object","title":"Update Data Attribute Request","properties":{"archived":{"type":"boolean","description":"Whether the attribute is to be archived or not.","example":false},"description":{"type":"string","description":"The readable description you see in the UI for the attribute.","example":"My Data Attribute Description"},"messenger_writable":{"type":"boolean","description":"Can this attribute be updated by the Messenger","example":false}},"oneOf":[{"properties":{"options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of objects representing the options of the list, with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the key and the option as the value. At least two options are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"value":{"type":"string"}}},"example":[{"value":"1-10"},{"value":"11-50"}]}},"required":["options"],"title":"list attribute"},{"title":"other type"}]}},"components/schemas/update_external_page_request":{"id":"components/schemas/update_external_page_request","kind":"json-schema","title":"Update External Page Payload","data":{"title":"Update External Page Payload","type":"object","description":"You can update an External Page in your Fin Content Library.","nullable":false,"properties":{"title":{"type":"string","description":"The title of the external page.","example":"Getting started with..."},"html":{"type":"string","description":"The body of the external page in HTML.","example":"<p>Hello world!</p>"},"url":{"type":"string","description":"The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. If omitted, the page's existing URL is removed.","example":"https://help.example.com/en/articles/1234-getting-started"},"ai_agent_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Agent.","example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Copilot.","example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by AI Sales Agent.","example":true},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code of the external page, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must be a language supported by the workspace."},"children":[]}]}]}],"example":"en"},"source_id":{"type":"integer","description":"The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.","example":1234},"external_id":{"type":"string","description":"The identifier for the external page which was given by the source. Must be unique for the source.","example":"5678"},"audience_ids":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of audience IDs to target this external page to for Fin AI Agent. Replaces all existing audience memberships. Omitting the field leaves existing audience memberships unchanged. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear all audience memberships. Unknown audience IDs return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]}},"required":["title","html","locale","source_id","external_id"]}},"components/schemas/update_ticket_request":{"id":"components/schemas/update_ticket_request","kind":"json-schema","title":"Update Ticket Request Payload","data":{"description":"You can update a Ticket","type":"object","title":"Update Ticket Request Payload","properties":{"ticket_attributes":{"type":"object","description":"The attributes set on the ticket.","example":{"_default_title_":"example","_default_description_":"having a problem"}},"ticket_state_id":{"type":"string","description":"The ID of the ticket state associated with the ticket type.","example":"123"},"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.","example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"},"open":{"type":"boolean","description":"Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.","example":true},"is_shared":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to share a ticket with the customer. Only a ticket that isn't shared yet can be shared: a Back-office ticket, of a ticket type that isn't internal, that is linked to a conversation with no other shared linked ticket. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a ticket that is already shared (Customer tickets are shared by default) or can't be shared (Tracker tickets), returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"snoozed_until":{"type":"integer","format":"timestamp","description":"The time you want the ticket to reopen.","example":1673609604},"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"}}}},"components/schemas/update_ticket_type_attribute_request":{"id":"components/schemas/update_ticket_type_attribute_request","kind":"json-schema","title":"Update Ticket Type Attribute Request Payload","data":{"description":"You can update a Ticket Type Attribute","type":"object","title":"Update Ticket Type Attribute Request Payload","properties":{"name":{"type":"string","description":"The name of the ticket type attribute","example":"Bug Priority"},"description":{"type":"string","description":"The description of the attribute presented to the teammate or contact","example":"Priority level of the bug"},"required_to_create":{"type":"boolean","description":"Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.","default":false,"example":false},"required_to_create_for_contacts":{"type":"boolean","description":"Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.","default":false,"example":false},"visible_on_create":{"type":"boolean","description":"Whether the attribute is visible to teammates when creating a ticket in Inbox.","default":true,"example":true},"visible_to_contacts":{"type":"boolean","description":"Whether the attribute is visible to contacts when creating a ticket in Messenger.","default":true,"example":true},"multiline":{"type":"boolean","description":"Whether the attribute allows multiple lines of text (only applicable to string attributes)","example":false},"list_items":{"type":"string","description":"A comma delimited list of items for the attribute value (only applicable to list attributes)","example":"Low Priority,Medium Priority,High Priority"},"allow_multiple_values":{"type":"boolean","description":"Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)","example":false},"archived":{"type":"boolean","description":"Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)","example":false}}}},"components/schemas/update_ticket_type_request":{"id":"components/schemas/update_ticket_type_request","kind":"json-schema","title":"Update Ticket Type Request Payload","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request payload for updating a ticket type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can copy the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"icon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property for your ticket type from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://twemoji-cheatsheet.vercel.app/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twemoji Cheatsheet"},"children":[]}]}]}]}],"type":"object","title":"Update Ticket Type Request Payload","nullable":true,"properties":{"name":{"type":"string","description":"The name of the ticket type.","example":"Bug"},"description":{"type":"string","description":"The description of the ticket type.","example":"A bug has been occured"},"category":{"type":"string","description":"Category of the Ticket Type.","enum":["Customer","Back-office","Tracker"],"example":"Customer"},"icon":{"type":"string","description":"The icon of the ticket type.","example":"🐞","default":"🎟️"},"archived":{"type":"boolean","description":"The archived status of the ticket type.","example":false},"is_internal":{"type":"boolean","description":"Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.","example":false,"default":false}}}},"components/schemas/update_visitor_request":{"id":"components/schemas/update_visitor_request","kind":"json-schema","title":"Update Visitor Request Payload","data":{"description":"Update an existing visitor.","type":"object","title":"Update Visitor Request Payload","properties":{"id":{"type":"string","description":"A unique identified for the visitor which is given by Intercom. Used to look the visitor up; it is not changed by this request.","example":"8a88a590-e"},"user_id":{"type":"string","description":"A unique identified for the visitor which is given by you. Used to look the visitor up; it is not changed by this request.","example":"123"},"name":{"type":"string","description":"The visitor's name.","example":"Christian Bale"},"email":{"type":"string","description":"The visitor's email address. Sending this promotes the visitor to a lead and the response becomes a contact object.","example":"winstonsmith@truth.org"},"phone":{"type":"string","description":"The visitor's phone number.","example":"+353871234567"},"owner_id":{"type":"integer","description":"The id of the teammate who owns the visitor.","example":991267734},"last_request_at":{"type":"integer","description":"The time the visitor was last seen, as a Unix timestamp.","example":1663597223},"last_seen_ip":{"type":"string","description":"The IP address the visitor was last seen from.","example":"1.2.3.4"},"last_seen_user_agent":{"type":"string","description":"The user agent the visitor was last seen with.","example":"Mozilla/5.0"},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the visitor is unsubscribed from emails.","example":false},"language_override":{"type":"string","description":"The language to send the visitor messages in, overriding the language we detect.","example":"fr"},"avatar":{"type":"string","description":"An image URL for the visitor's avatar.","example":"https://example.org/128Wu8Q.jpg"},"companies":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The companies to associate the visitor with. Only applied when the same request sends "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which promotes the visitor to a lead."},"children":[]}]}]}],"items":{"type":"object"}},"utm_campaign":{"type":"string","description":"The campaign the visitor arrived from.","example":"intercom-link"},"utm_content":{"type":"string","description":"The content the visitor arrived from.","example":"banner"},"utm_medium":{"type":"string","description":"The medium the visitor arrived from.","example":"email"},"utm_source":{"type":"string","description":"The source the visitor arrived from.","example":"Intercom"},"utm_term":{"type":"string","description":"The search term the visitor arrived from.","example":"messenger"},"custom_attributes":{"type":"object","description":"The custom attributes which are set for the visitor.","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}}},"anyOf":[{"required":["id"]},{"required":["user_id"]}]}},"components/schemas/visitor":{"id":"components/schemas/visitor","kind":"json-schema","title":"Visitor","data":{"title":"Visitor","type":"object","description":"Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.","nullable":true,"properties":{"type":{"type":"string","description":"Value is 'visitor'","default":"visitor","example":"visitor"},"id":{"type":"string","description":"The Intercom defined id representing the Visitor.","example":"530370b477ad7120001d"},"user_id":{"type":"string","description":"Automatically generated identifier for the Visitor.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"anonymous":{"type":"boolean","description":"Identifies if this visitor is anonymous.","example":false},"email":{"type":"string","format":"email","description":"The email of the visitor.","example":"jane.doe@example.com"},"phone":{"type":"string","nullable":true,"description":"The phone number of the visitor.","example":"555-555-5555"},"name":{"type":"string","nullable":true,"description":"The name of the visitor.","example":"Jane Doe"},"pseudonym":{"type":"string","nullable":true,"description":"The pseudonym of the visitor.","example":"Red Duck from Dublin"},"avatar":{"type":"object","properties":{"type":{"type":"string","description":"","default":"avatar","example":"avatar"},"image_url":{"type":"string","format":"uri","nullable":true,"description":"This object represents the avatar associated with the visitor.","example":"https://example.com/avatar.png"}}},"app_id":{"type":"string","description":"The id of the app the visitor is associated with.","example":"hfi1bx4l"},"companies":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["company.list"],"example":"company.list"},"companies":{"type":"array","description":"Companies are returned in a reduced form here, with only these four keys.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["company"],"example":"company"},"company_id":{"type":"string","nullable":true,"description":"The company id you have defined for the company.","example":"625"},"id":{"type":"string","description":"The Intercom defined id representing the company.","example":"531ee472cce572a6ec000006"},"name":{"type":"string","description":"The name of the company.","example":"Blue Sun"}}}}}},"location_data":{"type":"object","properties":{"type":{"type":"string","description":"","default":"location_data","example":"location_data"},"city_name":{"type":"string","description":"The city name of the visitor.","example":"Dublin"},"continent_code":{"type":"string","description":"The continent code of the visitor.","example":"EU"},"country_code":{"type":"string","description":"The country code of the visitor.","example":"IRL"},"country_name":{"type":"string","description":"The country name of the visitor.","example":"Ireland"},"postal_code":{"type":"string","description":"The postal code of the visitor.","example":"D02 N960"},"region_name":{"type":"string","description":"The region name of the visitor.","example":"Leinster"},"timezone":{"type":"string","description":"The timezone of the visitor.","example":"Europe/Dublin"}}},"last_request_at":{"type":"integer","description":"The time the Lead last recorded making a request.","example":1663597260},"created_at":{"type":"integer","description":"The time the Visitor was added to Intercom.","example":1663597223},"remote_created_at":{"type":"integer","description":"The time the Visitor was added to Intercom.","example":1663597223},"signed_up_at":{"type":"integer","description":"The time the Visitor signed up for your product.","example":1663597223},"updated_at":{"type":"integer","description":"The last time the Visitor was updated.","example":1663597260},"session_count":{"type":"integer","description":"The number of sessions the Visitor has had.","example":1},"social_profiles":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["social_profile.list"],"example":"social_profile.list"},"social_profiles":{"type":"array","items":{"type":"string"}}}},"owner_id":{"type":"string","nullable":true,"description":"The id of the admin that owns the Visitor.","example":"5169261"},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the Visitor is unsubscribed from emails.","example":false},"marked_email_as_spam":{"type":"boolean","description":"Identifies if this visitor has marked an email as spam.","example":false},"has_hard_bounced":{"type":"boolean","description":"Identifies if this visitor has had a hard bounce.","example":false},"tags":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["tag.list"],"example":"tag.list"},"tags":{"type":"array","items":{"properties":{"type":{"type":"string","description":"The type of the object","enum":["tag"],"example":"tag"},"id":{"type":"string","description":"The id of the tag.","example":"8482"},"name":{"type":"string","description":"The name of the tag.","example":"tag_name"}}}}}},"segments":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment.list"],"example":"segment.list"},"segments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment"],"example":"segment"},"id":{"type":"string","description":"The Intercom defined id representing the segment.","example":"56203d455f71e8285f000020"}}}}}},"custom_attributes":{"type":"object","description":"The custom attributes you have set on the Visitor.","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"integer"},{"type":"number"},{"type":"boolean"}]}},"referrer":{"type":"string","nullable":true,"description":"The referer of the visitor.","example":"https://www.google.com/"},"utm_campaign":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The utm_campaign of the visitor."},"children":[]}]}]}],"example":"intercom-link"},"utm_content":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The utm_content of the visitor."},"children":[]}]}]}],"example":"banner"},"utm_medium":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The utm_medium of the visitor."},"children":[]}]}]}],"example":"email"},"utm_source":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The utm_source of the visitor."},"children":[]}]}]}],"example":"Intercom"},"utm_term":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The utm_term of the visitor."},"children":[]}]}]}],"example":"messenger"},"do_not_track":{"type":"boolean","nullable":true,"description":"Identifies if this visitor has do not track enabled.","example":false}}}},"components/schemas/visitor_deleted_object":{"id":"components/schemas/visitor_deleted_object","kind":"json-schema","title":"Visitor Deleted Object","data":{"title":"Visitor Deleted Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the visitor which is given by Intercom.","example":"530370b477ad7120001d"},"type":{"type":"string","description":"The type of object which was deleted","enum":["visitor"],"example":"visitor"},"user_id":{"type":"string","description":"Automatically generated identifier for the Visitor.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"}}}},"components/schemas/workflow_export":{"id":"components/schemas/workflow_export","kind":"json-schema","title":"Workflow Export","data":{"title":"Workflow Export","type":"object","description":"A workflow export containing the complete workflow configuration.","properties":{"export_version":{"type":"string","description":"The version of the export format.","example":"1.0"},"exported_at":{"type":"string","format":"date-time","description":"The timestamp when the export was generated.","example":"2026-01-26T12:00:00Z"},"app_id":{"type":"integer","description":"The workspace identifier.","example":12345},"workflow":{"type":"object","description":"The workflow configuration.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the workflow. This is not the ruleset ID that the export endpoint's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter expects."},"children":[]}]}]}],"example":"67890"},"title":{"type":"string","description":"The title of the workflow.","example":"My Workflow"},"description":{"type":"string","nullable":true,"description":"The description of the workflow.","example":"A workflow that handles customer inquiries"},"trigger_type":{"type":"string","description":"The type of trigger that starts this workflow.","example":"inbound_conversation"},"state":{"type":"string","description":"The current state of the workflow.","enum":["live","draft","paused"],"example":"live"},"target_channels":{"type":"array","items":{"type":"string"},"description":"The channels this workflow targets.","example":["chat"]},"preferred_devices":{"type":"array","items":{"type":"string"},"description":"The preferred devices for this workflow.","example":["desktop","mobile"]},"created_at":{"type":"string","format":"date-time","description":"When the workflow was created.","example":"2025-06-15T10:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"When the workflow was last updated.","example":"2026-01-20T14:45:00Z"},"targeting":{"type":"object","nullable":true,"description":"The targeting rules for this workflow."},"snapshot":{"type":"object","nullable":true,"description":"The current snapshot of workflow steps and configuration."},"attributes":{"type":"array","items":{"type":"object"},"description":"Custom attributes defined for this workflow."},"embedded_rules":{"type":"array","items":{"type":"object"},"description":"Rules embedded within the workflow steps."}}}}}},"components/schemas/ecommerce_catalog_upload_part_response":{"id":"components/schemas/ecommerce_catalog_upload_part_response","kind":"json-schema","title":"Ecommerce Catalog Upload Part Response","data":{"title":"Ecommerce Catalog Upload Part Response","type":"object","description":"Returned after a multipart catalog part is successfully uploaded.","properties":{"import_job_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the active upload session. Pass this as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_job_id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in subsequent part uploads and in the finalization request."},"children":[]}]}]}],"example":"job_01abc123"},"next_part_number":{"type":"integer","description":"The part number to use in the next upload request.","example":2}}}},"components/schemas/ecommerce_catalog_upload_response":{"id":"components/schemas/ecommerce_catalog_upload_response","kind":"json-schema","title":"Ecommerce Catalog Upload Response","data":{"title":"Ecommerce Catalog Upload Response","type":"object","description":"Returned when a catalog upload is accepted and sync has started.","properties":{"import_job_id":{"type":"string","description":"The unique identifier for the import job.","example":"job_01abc123"},"status":{"type":"string","description":"The current status of the catalog sync.","enum":["processing"],"example":"processing"},"message":{"type":"string","description":"A human-readable description of the sync status.","example":"Catalog received. Sync has started."}}}},"components/schemas/ecommerce_catalog_variant":{"id":"components/schemas/ecommerce_catalog_variant","kind":"json-schema","title":"Ecommerce Catalog Variant","data":{"title":"Ecommerce Catalog Variant","type":"object","description":"A product variant in an ecommerce catalog upload.","properties":{"id":{"type":"string","description":"Unique identifier for this variant within the product.","example":"var-001"},"title":{"type":"string","description":"Variant display name shown to shoppers (e.g. \"Small / Blue\").","example":"Blue / Large"},"price":{"type":"number","description":"Price of this specific variant. Fin uses variant prices for precise budget filtering and displays the variant price in recommendation cards.","example":29.99,"nullable":true},"compare_at_price":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original price before a discount. When provided, Fin will naturally mention the saving to the shopper (e.g. \"down from $129 to $99\")."},"children":[]}]}]}],"example":39.99,"nullable":true},"in_stock":{"type":"boolean","description":"Whether this variant is currently available. Out-of-stock variants are not shown in Fin's recommendation cards and Fin will not suggest them to shoppers.","example":true},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct link to this variant's page. Takes precedence over the product URL in recommendation cards. If omitted, constructed automatically as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{product_url}?variant={id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://example.com/products/t-shirt?variant=var-001","nullable":true},"image_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image specific to this variant. Takes precedence over the product's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no valid image can be resolved, this variant's recommendation card will not be shown."},"children":[]}]}]}],"example":"https://cdn.example.com/images/t-shirt-blue.jpg","nullable":true},"selected_options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific option values that define this variant (e.g. Size=Small, Color=Blue). Fin uses these to match shopper requests like \"do you have this in medium?\" to the correct variant."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"Option name.","example":"Size"},"value":{"type":"string","description":"Selected option value.","example":"Large"}}}},"sku":{"type":"string","description":"Stock-keeping unit for this specific variant. Fin uses this to resolve shopper requests like \"do you have this in size M?\" to the exact variant, and can quote it back when a shopper asks for it directly.","example":"TSHIRT-BLU-L","nullable":true}}}},"components/schemas/ecommerce_catalog_product":{"id":"components/schemas/ecommerce_catalog_product","kind":"json-schema","title":"Ecommerce Catalog Product","data":{"title":"Ecommerce Catalog Product","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A product object in an ecommerce catalog upload. The catalog file must be a JSON"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of these objects. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required; all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"others are optional."},"children":[]}]}]}],"required":["id","title","url"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your unique product identifier. Used to match products on re-upload so only changed products are re-indexed. Also the delete key — any product ID absent from a new upload is removed from Fin's knowledge. Must be stable across uploads."},"children":[]}]}]}],"example":"prod-12345"},"title":{"type":"string","description":"Product name. Used by Fin when searching for and recommending products.","example":"Classic Cotton T-Shirt"},"url":{"type":"string","description":"Canonical product page URL shown in Fin's product recommendations. Must be a valid https:// URL.","example":"https://example.com/products/classic-cotton-t-shirt"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product description that Fin reads to understand what the product is. HTML formatting is supported and safely sanitized ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description_html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence if both are provided). This is the primary field Fin uses to match products to shopper questions — a richer description leads to better recommendations."},"children":[]}]}]}],"example":"A comfortable everyday t-shirt made from 100% organic cotton.","nullable":true},"description_html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML product description. Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when both are provided. HTML is safely sanitized before indexing."},"children":[]}]}]}],"example":"<p>A comfortable everyday t-shirt made from <strong>100% organic cotton</strong>.</p>","nullable":true},"featured_image_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary product image shown in Fin's recommendation cards. Falls back to the first entry of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided. If no valid image can be resolved for a variant, that variant's recommendation card is not shown to the shopper."},"children":[]}]}]}],"example":"https://cdn.example.com/images/t-shirt-main.jpg","nullable":true},"image_urls":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional product images. Used as a fallback image source when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"featured_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is absent or when a variant has no specific image."},"children":[]}]}]}],"items":{"type":"string"},"example":["https://cdn.example.com/images/t-shirt-back.jpg","https://cdn.example.com/images/t-shirt-detail.jpg"]},"price_min":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lowest price across all variants. If omitted, derived automatically from variant prices. Fin uses this to filter products when a shopper mentions a budget (e.g. \"under $100\"). Displayed as a range alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or as a single value if both are equal."},"children":[]}]}]}],"example":19.99,"nullable":true},"price_max":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Highest price across all variants. If omitted, derived from variant prices. Used alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for budget filtering and price display."},"children":[]}]}]}],"example":39.99,"nullable":true},"currency":{"type":"string","description":"ISO 4217 currency code for all prices on this product (e.g. \"USD\", \"EUR\", \"GBP\"). Defaults to USD if omitted. Used to format prices with the correct symbol in Fin's responses and product cards.","example":"USD","nullable":true},"in_stock":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product is available to purchase. If omitted, derived from variant stock — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product is in stock if at least one variant has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_stock: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Products with no in-stock"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants are hidden from Fin entirely and will not be recommended to shoppers."},"children":[]}]}]}],"example":true,"nullable":true},"tags":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form keywords matching how shoppers phrase needs in chat (e.g. \"waterproof\", \"gift\", \"plus-size\"). Used by Fin to match fuzzy queries; complements "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category_path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"example":["organic","bestseller"]},"collections":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections or groupings this product belongs to in your store. Fin uses collections to understand your catalog's structure and answer questions like \"what's in the sale collection?\". Each element may be a plain string or an object with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"items":{"oneOf":[{"type":"string","example":"Summer Collection"},{"type":"object","properties":{"title":{"type":"string","example":"Summer Collection"}}}]}},"category_path":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchical category breadcrumb for the product. Fin understands the hierarchy — a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shopper asking about \"Clothing\" will see products from all subcategories underneath it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most specific category is shown in search results. Strongly recommended. Provide as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a pre-formatted string (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Clothing > T-Shirts\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or as an array of path segments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"Clothing\", \"T-Shirts\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Array segments are joined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"type":"string","example":"Clothing > T-Shirts"},{"type":"array","items":{"type":"string"},"example":["Clothing","T-Shirts"]}],"nullable":true},"available_options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option types available for this product and their possible values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"name\": \"Size\", \"values\": [\"S\", \"M\", \"L\"]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Fin uses these to understand what"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"choices a shopper can make and to correctly filter variants when a shopper asks for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific size, colour, or other attribute."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"Option name (e.g. \"Size\").","example":"Size"},"values":{"type":"array","description":"All available values for this option.","items":{"type":"string"},"example":["Small","Medium","Large"]}}}},"variants":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual purchasable variants of the product. Fin recommends specific variants (not just products), so populating variants with accurate stock, price, and option data leads to more precise recommendations. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecommerce_catalog_variant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the variant object schema."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ecommerce_catalog_variant"}},"additional_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom attributes for your business. Fin uses these to show each customer only the products relevant to them (e.g. regional availability or warehouse codes). All keys must be consistent across all products in your catalog — the attribute schema is read from the first product in the file."},"children":[]}]}]}],"example":{"sku":"TSHIRT-BLU-L","vendor":"Acme Apparel"},"nullable":true}}}},"components/schemas/ecommerce_product_event_error":{"id":"components/schemas/ecommerce_product_event_error","kind":"json-schema","title":"Ecommerce Product Event Error","data":{"title":"Ecommerce Product Event Error","type":"object","description":"Returned when a product event is rejected.","properties":{"type":{"type":"string","description":"The error code.","enum":["invalid_event","import_source_not_found","not_found","catalog_not_uploaded"],"example":"invalid_event"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable description of the error. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", every validation error is listed, separated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"data.product.id is required"}}}},"components/schemas/ecommerce_product_event_product":{"id":"components/schemas/ecommerce_product_event_product","kind":"json-schema","title":"Ecommerce Product Event Product","data":{"title":"Ecommerce Product Event Product","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full product sent in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event. It uses the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecommerce_catalog_product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is required. The serialized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product must be 60 KB or smaller."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ecommerce_catalog_product"},{"type":"object","required":["updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","description":"When the product was created in your store, as an ISO 8601 timestamp.","example":"2026-10-14T09:30:00Z","nullable":true},"updated_at":{"type":"string","format":"date-time","description":"When the product was last changed in your store, as an ISO 8601 timestamp.","example":"2026-10-15T14:05:00Z"}}}]}},"components/schemas/ecommerce_product_event_request":{"id":"components/schemas/ecommerce_product_event_request","kind":"json-schema","title":"Ecommerce Product Event Request","data":{"title":"Ecommerce Product Event Request","type":"object","description":"A single product event.","required":["type","occurred_at","data"],"properties":{"type":{"type":"string","description":"The kind of product change.","enum":["product.created","product.updated","product.deleted"],"example":"product.updated"},"occurred_at":{"type":"string","format":"date-time","description":"When the change happened, as an ISO 8601 timestamp.","example":"2026-10-15T14:05:00Z"},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event payload. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"product":{"$ref":"#/components/schemas/ecommerce_product_event_product"},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the product to delete. Required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"tent-2p-ultralight"}}}}}},"components/schemas/ecommerce_product_event_response":{"id":"components/schemas/ecommerce_product_event_response","kind":"json-schema","title":"Ecommerce Product Event Response","data":{"title":"Ecommerce Product Event Response","type":"object","description":"Returned when a product event is accepted and queued.","properties":{"event_id":{"type":"integer","description":"The unique identifier for the queued event.","example":81273}}}},"components/schemas/granted_company_list":{"id":"components/schemas/granted_company_list","kind":"json-schema","title":"Granted Company List","data":{"title":"Granted Company List","type":"object","description":"A list of the company ids a contact has been granted access to.","properties":{"type":{"type":"string","description":"The type of object","enum":["list"],"example":"list"},"company_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values of the companies the contact has been granted access to."},"children":[]}]}]}],"items":{"type":"string","example":"acme-corp"}},"pages":{"allOf":[{"$ref":"#/components/schemas/pages_link"}],"type":"object","description":"Pagination details. Null on the replace response, which returns the whole stored set.","nullable":true},"total_count":{"type":"integer","description":"The total number of companies the contact has been granted access to.","example":2}}}},"components/schemas/replace_granted_companies_request":{"id":"components/schemas/replace_granted_companies_request","kind":"json-schema","title":"Replace Granted Companies Request","data":{"title":"Replace Granted Companies Request","type":"object","description":"The full set of companies to grant the contact access to. Any company id left out is dropped.","required":["company_ids"],"properties":{"company_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values of the companies to grant the contact access to. Send an empty array to drop every grant. Maximum of 100 ids."},"children":[]}]}]}],"maxItems":100,"items":{"type":"string","example":"acme-corp"},"example":["acme-corp","1234"]}}}},"components/schemas/role":{"id":"components/schemas/role","kind":"json-schema","title":"Role","data":{"title":"Role","type":"object","x-tags":["Roles"],"description":"A role defines what a teammate can do in a workspace. The teammates endpoint returns the id and name of the role a teammate holds; this schema adds the role's description.","properties":{"type":{"type":"string","description":"Value is always \"role\"","example":"role"},"id":{"type":"string","description":"The id of the role","example":"991267902"},"name":{"type":"string","description":"The name of the role","example":"Support Lead"},"description":{"type":"string","nullable":true,"description":"The description of the role","example":"Can view and reply to conversations"}}}},"components/schemas/role_list":{"id":"components/schemas/role_list","kind":"json-schema","title":"Role List","data":{"title":"Role List","type":"object","x-tags":["Roles"],"description":"A list of role objects in the workspace.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of role objects","items":{"$ref":"#/components/schemas/role"},"example":[{"type":"role","id":"991267902","name":"Support Lead","description":"Can view and reply to conversations"}]}}}},"components/schemas/team_handling_segment":{"id":"components/schemas/team_handling_segment","kind":"json-schema","title":"Team Handling Segment","data":{"title":"Team Handling Segment","type":"object","description":"A period one teammate actively handled the conversation, attributed to the team assigned to it at the time. Teammate identity is not included.","required":["team","started_at","ended_at"],"properties":{"team":{"type":"object","nullable":true,"description":"The team assigned when the period ran, or null if no team was assigned","required":["type","id","name"],"properties":{"type":{"type":"string","enum":["team"],"example":"team"},"id":{"type":"string","example":"814865"},"name":{"type":"string","example":"Billing"}}},"started_at":{"type":"string","format":"date-time","example":"2026-09-28T10:10:00Z"},"ended_at":{"type":"string","format":"date-time","nullable":true,"description":"Null while the period is still open","example":"2026-09-28T10:20:00Z"},"start_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team_change when the team changed while the teammate kept handling without a break, otherwise null"},"children":[]}]}]}],"example":"team_change"},"end_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why the period ended (switch, assignment, reassign, snooze, close, away, auto_away, session_drop, team_change). Null while the period is still open."},"children":[]}]}]}],"example":"assignment"}}}},"components/schemas/team_handling_segment_list":{"id":"components/schemas/team_handling_segment_list","kind":"json-schema","title":"Team Handling Segment List","data":{"title":"Team Handling Segment List","type":"object","properties":{"team_handling_segments":{"type":"array","items":{"$ref":"#/components/schemas/team_handling_segment"},"example":[{"team":{"type":"team","id":"814865","name":"Billing"},"started_at":"2026-09-28T10:10:00Z","ended_at":"2026-09-28T10:20:00Z","start_reason":null,"end_reason":"assignment"}]}}}},"components/schemas/standalone_platform_handoff":{"id":"components/schemas/standalone_platform_handoff","kind":"json-schema","title":"Part type - standalone_platform_handoff","data":{"title":"Part type - standalone_platform_handoff","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the handoff Fin attempted to an external platform, for conversation part type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standalone_platform_handoff"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"handoff":{"type":"object","description":"The handoff Fin attempted.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The handoff type. One of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zendesk_ticket"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zendesk_agent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesforce_case"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesforce_in_app_messaging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesforce_team"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external_agent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external_ticket"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Older parts can also return "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesforce_chat"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"salesforce_case"},"success":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the handoff completed and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it failed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means no outcome was recorded on this part, for example a Salesforce in-app messaging handoff that was only initiated."},"children":[]}]}]}],"example":true},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the handoff. Always present. For a successful "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesforce_case"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" handoff it holds the created Case's "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case_number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise it is an empty object."},"children":[]}]}]}],"properties":{"case_id":{"type":"string","description":"The ID of the Salesforce Case created by the handoff.","example":"500XX0000001"},"case_number":{"type":"string","description":"The number of the Salesforce Case created by the handoff.","example":"00001234"}},"example":{"case_id":"500XX0000001","case_number":"00001234"}}},"example":{"type":"salesforce_case","success":true,"data":{"case_id":"500XX0000001","case_number":"00001234"}}}}}},"schema_1149":{"kind":"json-schema","data":{"$ref":"#/components/schemas/intercom_version"},"id":"schema_1149"},"schema_1150":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_1150"},"schema_1151":{"kind":"json-schema","data":{"type":"object","required":["away_mode_enabled","away_mode_reassign"],"properties":{"away_mode_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change the status of the admin to away, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set them back to active."},"children":[]}]}]}],"example":true},"away_mode_reassign":{"type":"boolean","description":"Set to \"true\" to assign any new conversation replies to your default inbox.","example":false},"away_status_reason_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the away status reason. Only allowed when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"away_mode_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the reason can't be archived, unless it is already the admin's current reason. Required if your workspace makes away status reasons mandatory."},"children":[]}]}]}],"example":12345}}},"id":"schema_1151"},"schema_1152":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1152"},"schema_1153":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_1153"},"schema_1154":{"kind":"json-schema","data":{"type":"integer","default":20,"minimum":1,"maximum":250},"id":"schema_1154"},"schema_1155":{"kind":"json-schema","data":{"type":"object","properties":{"created_at_after":{"type":"integer","format":"date-time","description":"The start date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to 30 days before the request.","example":1677253093},"created_at_before":{"type":"integer","format":"date-time","description":"The end date that you request data for. It must be formatted as a UNIX timestamp. If you leave it out, it defaults to the time of the request.","example":1677861493},"event_types":{"type":"array","description":"An optional list of event types to filter activity logs by. Use the list all activity log event types endpoint to retrieve available values.","items":{"type":"string"},"example":["app_name_change","message_state_change"]},"page":{"type":"integer","description":"The page number of results to return.","default":1,"example":1},"per_page":{"type":"integer","description":"The number of results per page. Must be between 1 and 250.","default":20,"minimum":1,"maximum":250,"example":20}}},"id":"schema_1155"},"schema_1156":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1156"},"schema_1157":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"team_id":{"type":"integer","example":789},"assignee_id":{"type":"integer","example":456}}}},"id":"schema_1157"},"schema_1158":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the removed admin.","example":"123"},"object":{"type":"string","enum":["admin"],"example":"admin"},"removed":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the admin was removed. Returned as the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"true\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["true"],"example":"true"}}},"id":"schema_1158"},"schema_1159":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_1159"},"schema_1160":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":150,"default":50},"id":"schema_1160"},"schema_1161":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the tag to apply, as given by Intercom.","example":"7522907"},"admin_id":{"type":"string","nullable":true,"description":"Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate.","example":"1234"}}},"id":"schema_1161"},"schema_1162":{"kind":"json-schema","data":{"type":"integer","maximum":250},"id":"schema_1162"},"schema_1163":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the tag to apply, as given by Intercom.","example":"7522907"},"admin_id":{"type":"string","nullable":true,"description":"Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate. Does not affect authorization.","example":"1234"}}},"id":"schema_1163"},"schema_1164":{"kind":"json-schema","data":{"type":"string","maxLength":500},"id":"schema_1164"},"schema_1165":{"kind":"json-schema","data":{"type":"string","enum":["published","draft","all"],"default":"published"},"id":"schema_1165"},"schema_1166":{"kind":"json-schema","data":{"type":"integer","maximum":50},"id":"schema_1166"},"schema_1167":{"kind":"json-schema","data":{"type":"integer","default":20,"minimum":1,"maximum":50},"id":"schema_1167"},"schema_1168":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":25},"id":"schema_1168"},"schema_1169":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":"The signed recording URL"}}},"id":"schema_1169"},"schema_1170":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/call_transcript_turn"}},"id":"schema_1170"},"schema_1171":{"kind":"json-schema","data":{"type":"object","required":["conversation_ids"],"properties":{"conversation_ids":{"type":"array","description":"A list of conversation ids to fetch calls for. Maximum 20.","minItems":1,"maxItems":20,"items":{"type":"string"}}}},"id":"schema_1171"},"schema_1172":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","example":"list"},"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/call"},{"type":"object","properties":{"transcript":{"type":"array","description":"The call transcript if available, otherwise an empty array.","items":{"type":"object","additionalProperties":true}},"transcript_status":{"type":"string","nullable":true,"description":"The status of the transcript if available."}}}]}}}},"id":"schema_1172"},"schema_1173":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ai_call_response"}},"id":"schema_1173"},"schema_1174":{"kind":"json-schema","data":{"type":"string","enum":["user","users"]},"id":"schema_1174"},"schema_1175":{"kind":"json-schema","data":{"type":"integer","maximum":60},"id":"schema_1175"},"schema_1176":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/company"},{"$ref":"#/components/schemas/company_list"},{"$ref":"#/components/schemas/company_user_list"}]},"id":"schema_1176"},"schema_1177":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/company"},{"$ref":"#/components/schemas/company_user_list"}]},"id":"schema_1177"},"schema_1178":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"]},"id":"schema_1178"},"schema_1179":{"kind":"json-schema","data":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The text of the note.","example":"New note"},"admin_id":{"type":"string","description":"The unique identifier of the admin creating the note. If not provided, defaults to the admin associated with the access token.","example":"991267583"}}},"id":"schema_1179"},"schema_1180":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the company which is given by Intercom","example":"58a430d35458202d41b1e65b"}}},"id":"schema_1180"},"schema_1181":{"kind":"json-schema","data":{"type":"integer","default":1,"example":1},"id":"schema_1181"},"schema_1182":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":60,"example":50},"id":"schema_1182"},"schema_1183":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"desc","example":"desc"},"id":"schema_1183"},"schema_1184":{"kind":"json-schema","data":{"type":"integer","default":50},"id":"schema_1184"},"schema_1185":{"kind":"json-schema","data":{"type":"string","default":"desc","enum":["asc","desc"]},"id":"schema_1185"},"schema_1186":{"kind":"json-schema","data":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The text of the note.","example":"New note"},"admin_id":{"type":"string","description":"The unique identifier of a given admin.","example":"123"}}},"id":"schema_1186"},"schema_1187":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the subscription which is given by Intercom","example":"37846"},"consent_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ignored. Whether the contact is opted in or out is decided by the subscription type's own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not by this value."},"children":[]}]}]}],"example":"opt_in"}}},"id":"schema_1187"},"schema_1188":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier for the tag which is given by Intercom","example":"7522907"}}},"id":"schema_1188"},"schema_1189":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":10,"maximum":150},"id":"schema_1189"},"schema_1190":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_1190"},"schema_1191":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_1191"},"schema_1192":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/update_contact_request"}]},"id":"schema_1192"},"schema_1193":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/contact"}],"properties":{"enabled_push_messaging":{"type":"boolean","nullable":true,"description":"If the user has enabled push messaging.","example":true}}},"id":"schema_1193"},"schema_1194":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","example":"</contacts/6762f0d01bb69f9f2193bb7d>; rel=\"canonical\"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the canonical (merged-into) contact. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"</contacts/{id}>; rel=\"canonical\""},"children":[]}]}]}]}}},"id":"schema_1194"},"schema_1195":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/create_contact_request"}]},"id":"schema_1195"},"schema_1196":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","example":"</contacts/6762f0df1bb69f9f2193bb84>; rel=\"canonical\"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the canonical (merged-into) contact. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"</contacts/{id}>; rel=\"canonical\""},"children":[]}]}]}]}}},"id":"schema_1196"},"schema_1197":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":50},"id":"schema_1197"},"schema_1198":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["published","draft"]}},"id":"schema_1198"},"schema_1199":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_1199"},"schema_1200":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_1200"},"schema_1201":{"kind":"json-schema","data":{"type":"string","enum":["IN","NIN"]},"id":"schema_1201"},"schema_1202":{"kind":"json-schema","data":{"type":"string","enum":["folder"]},"id":"schema_1202"},"schema_1203":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["snippet","external_content","file_source_content","internal_article","article"]}},"id":"schema_1203"},"schema_1204":{"kind":"json-schema","data":{"type":"string","enum":["on","off"]},"id":"schema_1204"},"schema_1205":{"kind":"json-schema","data":{"type":"integer","example":1},"id":"schema_1205"},"schema_1206":{"kind":"json-schema","data":{"type":"integer","example":20},"id":"schema_1206"},"schema_1207":{"kind":"json-schema","data":{"type":"string","example":"123"},"id":"schema_1207"},"schema_1208":{"kind":"json-schema","data":{"type":"object","required":["id","admin_id"],"properties":{"id":{"type":"string","description":"The unique identifier for the tag which is given by Intercom","example":"7522907"},"admin_id":{"type":"string","description":"The unique identifier for the admin which is given by Intercom.","example":"780"}}},"id":"schema_1208"},"schema_1209":{"kind":"json-schema","data":{"type":"object","required":["admin_id"],"properties":{"admin_id":{"type":"string","description":"The unique identifier for the admin which is given by Intercom.","example":"123"}}},"id":"schema_1209"},"schema_1210":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":150},"id":"schema_1210"},"schema_1211":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/message"}],"required":["conversation_id"]},"id":"schema_1211"},"schema_1212":{"kind":"json-schema","data":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"id":"schema_1212"},"schema_1213":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_1213"},"schema_1214":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":500,"default":20},"id":"schema_1214"},"schema_1215":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/close_conversation_request"},{"$ref":"#/components/schemas/snooze_conversation_request"},{"$ref":"#/components/schemas/open_conversation_request"},{"$ref":"#/components/schemas/assign_conversation_request"}]},"id":"schema_1215"},"schema_1216":{"kind":"json-schema","data":{"type":"integer","default":25,"maximum":50},"id":"schema_1216"},"schema_1217":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":60},"id":"schema_1217"},"schema_1218":{"kind":"json-schema","data":{"type":"integer","maximum":150},"id":"schema_1218"},"schema_1219":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/custom_object_instances_paginated_list"},{"$ref":"#/components/schemas/custom_object_instance"},{"$ref":"#/components/schemas/custom_object_instance_not_found"}]},"id":"schema_1219"},"schema_1220":{"kind":"json-schema","data":{"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"]},"id":"schema_1220"},"schema_1221":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/custom_object_instance"},{"$ref":"#/components/schemas/custom_object_instance_not_found"}]},"id":"schema_1221"},"schema_1222":{"kind":"json-schema","data":{"type":"string","enum":["contact","company"]},"id":"schema_1222"},"schema_1223":{"kind":"json-schema","data":{"type":"string","enum":["draft","live"],"default":"live"},"id":"schema_1223"},"schema_1224":{"kind":"json-schema","data":{"type":"string","example":"12345"},"id":"schema_1224"},"schema_1225":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":30},"id":"schema_1225"},"schema_1226":{"kind":"json-schema","data":{"type":"string","enum":["true","false"]},"id":"schema_1226"},"schema_1227":{"kind":"json-schema","data":{"type":"string","enum":["request_configuration_error","faraday_error","3rd_party_error","response_mapping_error","token_refresh_error","fin_action_response_formatting_error","fin_action_identity_verification_error","email_verification_error","non_fin_standalone_action_identity_verification_error","request_validation_error","client_side_action_error","code_block_transformation_error","otp_preview_not_supported_error"]},"id":"schema_1227"},"schema_1228":{"kind":"json-schema","data":{"type":"string","example":"99001"},"id":"schema_1228"},"schema_1229":{"kind":"json-schema","data":{"type":"integer","example":9821},"id":"schema_1229"},"schema_1230":{"kind":"json-schema","data":{"type":"object","oneOf":[{"title":"user_id query parameter","properties":{"user_id":{"type":"string"}},"required":["user_id"],"additionalProperties":false},{"title":"intercom_user_id query parameter","properties":{"intercom_user_id":{"type":"string"}},"required":["intercom_user_id"],"additionalProperties":false},{"title":"email query parameter","properties":{"email":{"type":"string"}},"required":["email"],"additionalProperties":false},{"title":"anonymous_id query parameter","properties":{"anonymous_id":{"type":"string"}},"required":["anonymous_id"],"additionalProperties":false}]},"id":"schema_1230"},"schema_1231":{"kind":"json-schema","data":{"type":"string","enum":["user","lead"]},"id":"schema_1231"},"schema_1232":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_1232"},"schema_1233":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/data_event_list"},{"$ref":"#/components/schemas/data_event_summary"}]},"id":"schema_1233"},"schema_1234":{"kind":"json-schema","data":{"type":"string","example":"42939"},"id":"schema_1234"},"schema_1235":{"kind":"json-schema","data":{"type":"object","properties":{"catalog":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The catalog JSON file. Required for all requests except finalization"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalize=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Must be a valid JSON array of product objects. Max 99 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each element in the array must conform to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_product"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecommerce_catalog_product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required on every product;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all other fields are optional. Variants, if provided, must conform to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/references/rest-api/api.intercom.io/models/ecommerce_catalog_variant"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecommerce_catalog_variant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema."},"children":[]}]}]}]},"finalize":{"type":"string","enum":["true","false"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to finalize a multipart upload session and start the catalog sync."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No catalog file is required when finalizing. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to upload a part in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a multipart session. Omit entirely for a single-file upload."},"children":[]}]}]}],"example":"false"},"import_job_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The import job ID returned from the first multipart upload request. Required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when uploading subsequent parts ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ≥ 2) and when finalizing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a multipart session ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finalize=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"job_01abc123"},"part_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sequential part number for a multipart upload. Must be a positive integer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in each response to guide the next request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrying the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"part_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is safe and idempotent."},"children":[]}]}]}],"example":2}}},"id":"schema_1235"},"schema_1236":{"kind":"json-schema","data":{"type":"integer","maximum":50,"example":20},"id":"schema_1236"},"schema_1237":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The ID of the conversation that is calling Fin via this API.","example":"ext-123"},"message":{"$ref":"#/components/schemas/fin_agent_message"},"user":{"$ref":"#/components/schemas/fin_agent_user"},"attachments":{"type":"array","description":"An array of attachments to include with the message. Maximum of 10 attachments.","maxItems":10,"items":{"$ref":"#/components/schemas/fin_agent_attachment"}},"conversation_metadata":{"$ref":"#/components/schemas/fin_agent_conversation_metadata"},"environment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the environment to start the conversation in. Only Fin for Platforms workspaces use it; other workspaces ignore it. Use the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messenger_environment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your Messenger installation. Defaults to the workspace's default environment. On a Fin for Platforms workspace, an identifier that matches no environment returns a 422 error."},"children":[]}]}]}],"example":"a1b2c3d4e5"},"response_format":{"type":"string","enum":["html","markdown"],"default":"html","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Fin's replies. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requesting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a workspace where it is not enabled returns a 403 error."},"children":[]}]}]}],"example":"html"}},"required":["conversation_id","message","user"]},"id":"schema_1237"},"schema_1238":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"ext-123"},"intercom_conversation_id":{"type":"string","description":"The internal Intercom conversation ID, useful for matching this Agent API session to the conversation in Intercom.","example":"192837465"},"user_id":{"type":"string","description":"The ID of the user.","example":"user-456"},"status":{"type":"string","enum":["thinking","replying","awaiting_user_reply","escalated","resolved","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's status when the request was accepted. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thinking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; later statuses arrive as events."},"children":[]}]}]}],"example":"thinking"},"created_at_ms":{"type":"string","format":"date-time","description":"The timestamp the response was created at, with millisecond precision.","example":"2025-01-24T10:00:00.123Z"},"errors":{"$ref":"#/components/schemas/fin_agent_attribute_errors"}}},"id":"schema_1238"},"schema_1239":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation messages keyed by the field they apply to, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures."},"children":[]}]}]}],"example":{"conversation_id":"Conversation ID is required"},"additionalProperties":true}}},"id":"schema_1239"},"schema_1240":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"123456"},"message":{"$ref":"#/components/schemas/fin_agent_message"},"user":{"$ref":"#/components/schemas/fin_agent_user"},"attachments":{"type":"array","description":"An array of attachments to include with the message. Maximum of 10 attachments.","maxItems":10,"items":{"$ref":"#/components/schemas/fin_agent_attachment"}},"response_format":{"type":"string","enum":["html","markdown"],"default":"html","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Fin's replies. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requesting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a workspace where it is not enabled returns a 403 error."},"children":[]}]}]}],"example":"html"}},"required":["conversation_id","message","user"]},"id":"schema_1240"},"schema_1241":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your external conversation ID — the same ID you started the conversation with, and the one echoed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csat_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]}]}]}],"example":"ext-123"},"rating":{"type":"string","enum":["terrible","bad","ok","good","amazing"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rating the user selected — one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csat_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event's options."},"children":[]}]}]}],"example":"amazing"},"remark":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional free-text comment the user left alongside the rating. Can be added to an already-rated survey, but only once — the rating locks after a remark is recorded."},"children":[]}]}]}],"example":"Fin solved my problem in seconds."}},"required":["conversation_id","rating"]},"id":"schema_1241"},"schema_1242":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The external ID of the rated conversation.","example":"ext-123"},"rating":{"type":"string","enum":["terrible","bad","ok","good","amazing"],"description":"The rating now recorded on the conversation.","example":"amazing"},"status":{"type":"string","enum":["rated"],"description":"The result of the submission.","example":"rated"}}},"id":"schema_1242"},"schema_1243":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation messages keyed by the field they apply to, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for conversation-level failures."},"children":[]}]}]}],"example":{"base":"The rating window for this conversation has closed"},"additionalProperties":{"type":"string"}}}},"id":"schema_1243"},"schema_1244":{"kind":"json-schema","data":{"type":"object","properties":{"user":{"allOf":[{"$ref":"#/components/schemas/fin_agent_user"},{"description":"The user to list capabilities for. If no user exists for the id, one is created from the supplied details; if the user already exists, the supplied email and attributes update it."}]}},"required":["user"]},"id":"schema_1244"},"schema_1245":{"kind":"json-schema","data":{"type":"object","properties":{"version":{"type":"string","description":"The API version the capabilities document was generated for.","example":"2.17"},"capabilities":{"type":"array","description":"The list of capabilities available to this user, as tool definitions.","items":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capability name. Procedures are named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"run_procedure_<title_slug>_<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the slug cut to 80 characters, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"run_procedure_<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the title gives no usable slug (for example a blank or non-Latin title); the static actions are named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"escalate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"run_procedure_reset_password_12345"},"description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the capability. For a procedure, the text is wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<untrusted-content>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tags, and is null when the procedure has no description."},"children":[]}]}]}],"example":"Send a user reply into an existing Fin conversation and get Fin's next turn. Use this to continue any ongoing conversation — including one opened by a procedure run — whenever its status is `awaiting_user_reply`."},"inputSchema":{"type":"object","description":"A JSON Schema describing the request body to send to the capability's endpoint.","additionalProperties":true},"endpoint":{"type":"string","description":"The endpoint path to call to use this capability.","example":"/fin/procedures/12345/run"},"method":{"type":"string","description":"The HTTP method to use.","example":"POST"}}}},"errors":{"$ref":"#/components/schemas/fin_agent_attribute_errors"}}},"id":"schema_1245"},"schema_1246":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation messages keyed by the field they apply to, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures."},"children":[]}]}]}],"example":{"user":"Cannot update more than 10 attributes at once. Received 11 attributes."},"additionalProperties":true}}},"id":"schema_1246"},"schema_1247":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your external conversation ID. Fin creates a conversation for this ID. If a conversation already exists for it, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"example":"ext-123"},"message":{"$ref":"#/components/schemas/fin_agent_message"},"user":{"$ref":"#/components/schemas/fin_agent_user"},"conversation_metadata":{"$ref":"#/components/schemas/fin_agent_conversation_metadata"},"attachments":{"type":"array","description":"An array of attachments to include with the message. Maximum of 10 attachments.","maxItems":10,"items":{"$ref":"#/components/schemas/fin_agent_attachment"}},"environment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the environment to start the conversation in. Only Fin for Platforms workspaces use it; other workspaces ignore it. Use the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messenger_environment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your Messenger installation. Defaults to the workspace's default environment. On a Fin for Platforms workspace, an identifier that matches no environment returns a 422 error."},"children":[]}]}]}],"example":"a1b2c3d4e5"},"response_format":{"type":"string","enum":["html","markdown"],"default":"html","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Fin's replies. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requesting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"markdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a workspace where it is not enabled returns a 403 error."},"children":[]}]}]}],"example":"html"}},"required":["conversation_id","message","user"]},"id":"schema_1247"},"schema_1248":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The external ID of the conversation.","example":"ext-123"},"intercom_conversation_id":{"type":"string","description":"The internal Intercom conversation ID, useful for matching this Agent API session to the conversation in Intercom.","example":"192837465"},"user_id":{"type":"string","description":"The ID of the user.","example":"user-456"},"status":{"type":"string","enum":["thinking","replying","resolved","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's status when the request was accepted. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thinking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; later statuses arrive as events."},"children":[]}]}]}],"example":"thinking"},"created_at_ms":{"type":"string","format":"date-time","description":"The timestamp the response was created at, with millisecond precision.","example":"2025-01-24T10:00:00.123Z"},"errors":{"$ref":"#/components/schemas/fin_agent_attribute_errors"}}},"id":"schema_1248"},"schema_1249":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your external conversation ID. Fin creates a conversation for this ID. If a conversation already exists for it, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"example":"ext-123"},"user":{"$ref":"#/components/schemas/fin_agent_user"},"message":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional message posted to the conversation before the procedure runs. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"properties":{"body":{"type":"string","description":"The body of the message.","example":"Starting your refund request."},"author":{"type":"string","enum":["user","agent","fin"],"description":"Accepted but has no effect. The trigger message is always posted as an operator message.","example":"agent"}},"required":["body"]},"conversation_metadata":{"type":"object","description":"Metadata about the conversation. Only attributes are accepted (no history).","properties":{"attributes":{"type":"object","description":"A hash of conversation attributes. Limit to 20 attributes.\n","maxProperties":20,"additionalProperties":true,"example":{"order_id":"98765"}}}},"environment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the environment to start the conversation in. Only Fin for Platforms workspaces use it; other workspaces ignore it. Use the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messenger_environment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your Messenger installation. Defaults to the workspace's default environment. On a Fin for Platforms workspace, an identifier that matches no environment returns a 422 error."},"children":[]}]}]}],"example":"a1b2c3d4e5"}},"required":["conversation_id","user"]},"id":"schema_1249"},"schema_1250":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"ext-123"},"intercom_conversation_id":{"type":"string","description":"The internal Intercom conversation ID, useful for matching this Agent API session to the conversation in Intercom.","example":"192837465"},"user_id":{"type":"string","description":"The ID of the user.","example":"user-456"},"procedure_id":{"type":"string","description":"The ID of the procedure that was run.","example":"12345"},"status":{"type":"string","enum":["thinking","replying","awaiting_user_reply","escalated","resolved","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fin's status when the request was accepted. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thinking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; later statuses arrive as events."},"children":[]}]}]}],"example":"thinking"},"created_at_ms":{"type":"string","format":"date-time","description":"The timestamp the response was created at, with millisecond precision.","example":"2025-01-24T10:00:00.123Z"},"errors":{"$ref":"#/components/schemas/fin_agent_attribute_errors"}}},"id":"schema_1250"},"schema_1251":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external ID of the conversation to escalate. Provide this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required on Fin for Platforms, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not supported."},"children":[]}]}]}],"example":"ext-123"},"user":{"allOf":[{"$ref":"#/components/schemas/fin_agent_user"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user to escalate on behalf of, creating a new conversation. Provide this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Not supported on Fin for Platforms."},"children":[]}]}]}]}]},"context":{"type":"string","maxLength":10000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional background for the receiving teammate, valid with either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On the Intercom Helpdesk, it appears above the summary in the internal note of the new conversation the teammate picks up, and is never shown to the end user. Not surfaced on Fin for Platforms. Avoid including credentials or unnecessary personal data — it is visible to any teammate with access to the conversation."},"children":[]}]}]}],"example":"Customer is requesting a refund and is frustrated."}},"oneOf":[{"required":["conversation_id"]},{"required":["user"]}]},"id":"schema_1251"},"schema_1252":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external ID of the conversation. When you escalate an existing conversation by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conversation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this echoes the ID you sent. When you escalate a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Fin creates an agent conversation for the escalation and generates this ID for it."},"children":[]}]}]}],"example":"ext-123"},"intercom_conversation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal Intercom ID of the agent conversation created for the escalation. Returned only when escalating on behalf of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Fin closes this conversation once the handoff completes; the teammate works in a separate Helpdesk conversation."},"children":[]}]}]}],"example":"987654321"},"status":{"type":"string","enum":["escalated"],"description":"The resulting status of the conversation.","example":"escalated"}}},"id":"schema_1252"},"schema_1253":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation messages keyed by the field they apply to, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for request-level failures."},"children":[]}]}]}],"example":{"conversation_id":"Conversation not found for the given conversation_id"},"additionalProperties":true}}},"id":"schema_1253"},"schema_1254":{"kind":"json-schema","data":{"type":"integer","example":50},"id":"schema_1254"},"schema_1255":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"],"example":"list"},"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The folders on this page. Unlike when you retrieve a single folder, the keys "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emoji"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_folder_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted when they are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/folder"}},"total_count":{"type":"integer","description":"Total number of folders","example":2},"pages":{"$ref":"#/components/schemas/pages_link"}}},"id":"schema_1255"},"schema_1256":{"kind":"json-schema","data":{"type":"object","required":["folder"],"properties":{"folder":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the folder","example":"Product Documentation"},"description":{"type":"string","description":"The description of the folder","example":"Internal product documentation"},"emoji":{"type":"string","description":"An emoji for the folder","example":"📚"},"parent_folder_id":{"type":"integer","nullable":true,"description":"The ID of the parent folder","example":null}}}}},"id":"schema_1256"},"schema_1257":{"kind":"json-schema","data":{"type":"object","required":["folder"],"properties":{"folder":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder","example":"Updated Product Documentation"},"description":{"type":"string","description":"The description of the folder","example":"Updated internal product documentation"},"emoji":{"type":"string","description":"An emoji for the folder","example":"📖"},"parent_folder_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the parent folder. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move the folder to the top level. If omitted, the parent folder is unchanged."},"children":[]}]}]}],"example":null}}}}},"id":"schema_1257"},"schema_1258":{"kind":"json-schema","data":{"type":"integer","example":10},"id":"schema_1258"},"schema_1259":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":100},"id":"schema_1259"},"schema_1260":{"kind":"json-schema","data":{"type":"integer","default":10,"maximum":20,"example":10},"id":"schema_1260"},"schema_1261":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":20,"example":20},"id":"schema_1261"},"schema_1262":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"456"},"object":{"type":"string","example":"office_hours_exception"},"deleted":{"type":"boolean","example":true}}},"id":"schema_1262"},"schema_1263":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"123"},"object":{"type":"string","example":"office_hours_schedule"},"deleted":{"type":"boolean","example":true}}},"id":"schema_1263"},"schema_1264":{"kind":"json-schema","data":{"type":"object","required":["dataset_id","attribute_ids","start_time","end_time"],"properties":{"dataset_id":{"type":"string","example":"conversation"},"attribute_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of attribute identifiers to include in the export. Requires qualified_id format (e.g., \"people.Brand\", \"standard.conversation_id\"). Use the qualified_id returned from the get_datasets response."},"children":[]}]}]}],"items":{"type":"string"},"example":["standard.conversation_id","timestamp.conversation_started_at"]},"start_time":{"type":"integer","format":"int64","description":"Start of the export period, as a Unix timestamp in seconds. Must be within your workspace's reporting data retention period, which is 2 years by default (3 years for workspaces with extended retention).","example":1788220800},"end_time":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the export period, as a Unix timestamp in seconds. Must not be earlier than start_time and must also be within the retention period."},"children":[]}]}]}],"example":1788307200}}},"id":"schema_1264"},"schema_1265":{"kind":"json-schema","data":{"type":"object","properties":{"job_identifier":{"type":"string","example":"job1"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the job. A newly enqueued job is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"pending"},"download_url":{"type":"string","description":"Empty until the job is complete."},"download_expires_at":{"type":"string","description":"Empty until the job is complete."}}},"id":"schema_1265"},"schema_1266":{"kind":"json-schema","data":{"type":"object","properties":{"job_identifier":{"type":"string","description":"Unique identifier of the job."},"status":{"type":"string","description":"The status of the job.","enum":["pending","complete","failed"]},"download_url":{"type":"string","description":"The URL to download the export from. Empty until the job is complete."},"download_expires_at":{"description":"The time after which the export can no longer be downloaded, as a Unix timestamp in seconds. Empty string until the job is complete.","oneOf":[{"type":"integer","format":"int64"},{"type":"string","maxLength":0}]}}},"id":"schema_1266"},"schema_1267":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","example":"list"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"conversation"},"name":{"type":"string","example":"Conversation"},"description":{"type":"string","example":"Conversation-level details: status, channel, assignee."},"default_time_attribute_id":{"type":"string","example":"conversation.conversation_created_at"},"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The simple attribute identifier. Note that this may be ambiguous if the same name exists across different attribute types. Use qualified_id when calling the enqueue endpoint."},"children":[]}]}]}],"example":"conversation_id"},"qualified_id":{"type":"string","description":"A namespaced identifier that uniquely identifies the attribute across all types. Format is \"prefix.name\" (e.g., \"people.Brand\", \"conversation.Brand\"). A ticket field also includes its ticket type (e.g., \"ticket.Bug.Priority\"). Required when calling the enqueue endpoint.","example":"standard.conversation_id"},"name":{"type":"string","example":"Conversation ID"}}}}}}}}},"id":"schema_1267"},"schema_1268":{"kind":"json-schema","data":{"type":"string","example":"application/octet-stream","enum":["application/octet-stream"]},"id":"schema_1268"},"schema_1269":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_1269"},"schema_1270":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Encoding":{"type":"string","example":"gzip","description":"The encoding applied to the response body."}}},"id":"schema_1270"},"schema_1271":{"kind":"json-schema","data":{"type":"string","enum":["user","company"]},"id":"schema_1271"},"schema_1272":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/tag_list"},{"$ref":"#/components/schemas/tag_basic"}]},"id":"schema_1272"},"schema_1273":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/create_or_update_tag_request"},{"$ref":"#/components/schemas/tag_company_request"},{"$ref":"#/components/schemas/untag_company_request"},{"$ref":"#/components/schemas/tag_multiple_users_request"}]},"id":"schema_1273"},"schema_1274":{"kind":"json-schema","data":{"type":"integer","default":1800,"example":1800},"id":"schema_1274"},"schema_1275":{"kind":"json-schema","data":{"title":"Ticket ID","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the ticket to target."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Not the Inbox ticket ID"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from the API response, not the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ticket_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" displayed in the Intercom Inbox (e.g., #12345). Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the ticket object returned by the API."},"children":[]}]}]}]}],"example":"123"},"id":"schema_1275"},"schema_1276":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/contact_reply_ticket_request"},{"$ref":"#/components/schemas/admin_reply_ticket_request"}],"properties":{"skip_notifications":{"type":"boolean","description":"Option to disable notifications when replying to a Ticket.","example":true}}},"id":"schema_1276"},"schema_1277":{"kind":"json-schema","data":{"type":"object","required":["conversation_id"],"properties":{"conversation_id":{"type":"string","description":"The unique identifier (given by Intercom) for the conversation or customer ticket to link to the tracker ticket.","example":"204"}}},"id":"schema_1277"},"schema_1278":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/create_ticket_request"}],"properties":{"skip_notifications":{"type":"boolean","description":"Option to disable notifications when a Ticket is created.","example":true}}},"id":"schema_1278"},"schema_1279":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/update_ticket_request"}],"properties":{"skip_notifications":{"type":"boolean","description":"Option to disable notifications when a Ticket is updated.","example":true}}},"id":"schema_1279"}},"exampleStore":{"paths/~1me/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"admin","id":"991267459","email":"admin1@email.com","name":"Ciaran1 Lee","email_verified":true,"app":{"type":"app","id_code":"this_is_an_id1_that_should_be_at_least_40","name":"MyApp 1","created_at":1734537243,"secure":false,"identity_verification":false,"timezone":"America/Los_Angeles","region":"US"},"avatar":{"type":"avatar","image_url":"https://static.intercomassets.com/assets/default-avatars/admins/128.png"},"has_inbox_seat":true},"key":"Successful response","summary":"Successful response","id":"paths/~1me/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1me/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1me/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1me/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1me/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1me/get/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"b154eb7d-2ef7-4df5-afb2-4bee6c21039b","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1me/get/responses/404/content/application~1json/examples/Admin not found"},"paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response":{"value":{"away_mode_enabled":true,"away_mode_reassign":true,"away_status_reason_id":12345},"key":"successful_response","summary":"Successful response","id":"paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/successful_response"},"paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found":{"value":{"away_mode_enabled":true,"away_mode_reassign":true},"key":"admin_not_found","summary":"Admin not found","id":"paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized":{"value":{"away_mode_enabled":true,"away_mode_reassign":true},"key":"unauthorized","summary":"Unauthorized","id":"paths/~1admins~1{admin_id}~1away/put/requestBody/content/application~1json/examples/unauthorized"},"paths/~1admins~1{admin_id}~1away/put/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"admin","id":"991267460","name":"Ciaran2 Lee","email":"admin2@email.com","away_mode_enabled":true,"away_mode_reassign":true,"has_inbox_seat":true,"away_status_reason_id":12345,"team_ids":[991267903],"team_priority_level":{}},"key":"Successful response","summary":"Successful response","id":"paths/~1admins~1{admin_id}~1away/put/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/parameter_invalid":{"value":{"type":"error.list","request_id":"640daa00-327f-4d79-ae61-3c47b1f78736","errors":[{"code":"parameter_invalid","message":"Away status reason is archived"}]},"key":"parameter_invalid","summary":"Example of an archived away_status_reason_id","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/parameter_invalid"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_found":{"value":{"type":"error.list","request_id":"39d6f280-b1bf-45e6-a8e7-92343943e361","errors":[{"code":"parameter_invalid","message":"Away status reason not found"}]},"key":"away_status_reason_not_found","summary":"Example of an away_status_reason_id that does not exist","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_found"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_mandatory":{"value":{"type":"error.list","request_id":"bd8d3fca-202d-429c-a13d-4abd9833cb6d","errors":[{"code":"away_status_reason_mandatory","message":"Away status reason is mandatory"}]},"key":"away_status_reason_mandatory","summary":"Example of a missing away_status_reason_id when away reasons are mandatory","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_mandatory"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_allowed":{"value":{"type":"error.list","request_id":"552e4a27-c479-4d15-abfd-81e662896952","errors":[{"code":"parameter_invalid","message":"Away status reason must not be provided when away mode disabled"}]},"key":"away_status_reason_not_allowed","summary":"Example of an away_status_reason_id sent with away_mode_enabled set to false","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_status_reason_not_allowed"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_required":{"value":{"type":"error.list","request_id":"c8d12440-d0c3-4a7f-a2ea-6cc30e2f1d6a","errors":[{"code":"parameter_invalid","message":"Reassign conversations must be provided when away mode is changing"}]},"key":"away_mode_reassign_required","summary":"Example of a missing away_mode_reassign when away_mode_enabled is true","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_required"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_not_allowed":{"value":{"type":"error.list","request_id":"744ef872-e215-4ce9-ac4e-0ea7fbcd5d75","errors":[{"code":"parameter_invalid","message":"Reassign conversations cannot be enabled when away mode is disabled"}]},"key":"away_mode_reassign_not_allowed","summary":"Example of away_mode_reassign set to true when away_mode_enabled is false","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_reassign_not_allowed"},"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_enabled_missing":{"value":{"type":"error.list","request_id":"609e0487-f2ca-4bb8-a1b9-4e186763cc53","errors":[{"code":"parameter_missing","message":"param is missing or the value is empty or invalid: away_mode_enabled"}]},"key":"away_mode_enabled_missing","summary":"Example of a missing away_mode_enabled","id":"paths/~1admins~1{admin_id}~1away/put/responses/400/content/application~1json/examples/away_mode_enabled_missing"},"paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e76b2df0-2413-4215-8a5a-b5f6ebd4e642","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1admins~1{admin_id}~1away/put/responses/403/content/application~1json/examples/Admin without Inbox access":{"value":{"type":"error.list","request_id":"8e4a1ee0-2a4c-4a9f-9c3f-1c2b6d7e5f01","errors":[{"code":"action_forbidden","message":"This admin does not have Inbox access permissions"}]},"key":"Admin without Inbox access","summary":"Admin without Inbox access","id":"paths/~1admins~1{admin_id}~1away/put/responses/403/content/application~1json/examples/Admin without Inbox access"},"paths/~1admins~1{admin_id}~1away/put/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"efcd0531-798b-4c22-bccd-68877ed7faa4","errors":[{"code":"admin_not_found","message":"Admin for admin_id not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1admins~1{admin_id}~1away/put/responses/404/content/application~1json/examples/Admin not found"},"paths/~1admins~1{admin_id}~1away/put/responses/405/content/application~1json/examples/Admin is a bot":{"value":{"type":"error.list","request_id":"2f448921-6b3a-48f6-a4dc-eef1ca0ca095","errors":[{"code":"action_forbidden","message":"This method is not allowed for this type of Admin for admin_id"}]},"key":"Admin is a bot","summary":"Example of an id that belongs to a bot rather than a teammate","id":"paths/~1admins~1{admin_id}~1away/put/responses/405/content/application~1json/examples/Admin is a bot"},"paths/~1admins~1activity_logs/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"activity_log.list","pages":{"type":"pages","next":null,"page":1,"per_page":20,"total_pages":1},"activity_logs":[{"type":"admin_activity_log_event","id":"fca05814-4b72-4dce-ad4f-77a786a2c136","performed_by":{"type":"admin","id":"991267464","email":"admin5@email.com","ip":"127.0.0.1"},"metadata":{"before":"before","after":"after"},"created_at":1734537253,"activity_type":"app_name_change","activity_description":"Ciaran5 Lee changed your app name from before to after."},{"type":"admin_activity_log_event","id":"f48c653b-0185-48ac-a276-23d11006bafb","performed_by":{"type":"admin","id":"991267464","email":"admin5@email.com","ip":"127.0.0.1"},"metadata":{"message":{"id":123,"title":"Initial message title"},"before":"Initial message title","after":"Eventual message title"},"created_at":1734537253,"activity_type":"message_state_change","activity_description":"Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title."}]},"key":"Successful response","summary":"Successful response","id":"paths/~1admins~1activity_logs/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/event_types not supported":{"value":{"type":"error.list","request_id":"d1fd16d4-97de-41ae-a996-38055f993a1d","errors":[{"code":"parameter_invalid","message":"event_types filtering is not supported on this endpoint. Use the search activity logs endpoint (POST /admins/activity_logs/search) to filter by event_types."}]},"key":"event_types not supported","summary":"event_types not supported","id":"paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/event_types not supported"},"paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/per_page above 250":{"value":{"type":"error.list","request_id":"5b7c1e24-9a3d-4f60-8e12-6d0a4c9b2f87","errors":[{"code":"parameter_not_found","message":"Please provide the following parameters: max_per_page"}]},"key":"per_page above 250","summary":"Example of a per_page greater than 250","id":"paths/~1admins~1activity_logs/get/responses/400/content/application~1json/examples/per_page above 250"},"paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"57cc6148-2c0a-471b-bd9e-859538110958","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types":{"value":{"created_at_after":1677253093,"created_at_before":1677861493,"event_types":["app_name_change","message_state_change"]},"key":"search_with_event_types","summary":"Search with event types filter","id":"paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_with_event_types"},"paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters":{"value":{"created_at_after":1677253093,"created_at_before":1677861493},"key":"search_without_filters","summary":"Search with date range only","id":"paths/~1admins~1activity_logs~1search/post/requestBody/content/application~1json/examples/search_without_filters"},"paths/~1admins~1activity_logs~1search/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"activity_log.list","pages":{"type":"pages","next":null,"page":1,"per_page":20,"total_pages":1},"activity_logs":[{"type":"admin_activity_log_event","id":"fca05814-4b72-4dce-ad4f-77a786a2c136","performed_by":{"type":"admin","id":"991267464","email":"admin5@email.com","ip":"127.0.0.1"},"metadata":{"before":"before","after":"after"},"created_at":1734537253,"activity_type":"app_name_change","activity_description":"Ciaran5 Lee changed your app name from before to after."}]},"key":"Successful response","summary":"Successful response","id":"paths/~1admins~1activity_logs~1search/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins~1activity_logs~1search/post/responses/400/content/application~1json/examples/per_page above 250":{"value":{"type":"error.list","request_id":"5b7c1e24-9a3d-4f60-8e12-6d0a4c9b2f87","errors":[{"code":"parameter_not_found","message":"Please provide the following parameters: max_per_page"}]},"key":"per_page above 250","summary":"Example of a per_page greater than 250","id":"paths/~1admins~1activity_logs~1search/post/responses/400/content/application~1json/examples/per_page above 250"},"paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"57cc6148-2c0a-471b-bd9e-859538110958","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1admins~1activity_log_event_types/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"activity_log_event_type.list","event_types":["admin_avatar_change","admin_away_mode_change","admin_occupancy_state_change","admin_channel_change","admin_deletion","admin_deprovisioned","intercom_teammate_removal","admin_impersonation_consent_approved","admin_impersonation_consent_revoked","admin_impersonation_end","admin_impersonation_start","admin_invite_change","admin_bulk_invite_creation","admin_bulk_notification_settings_change","admin_invite_creation","admin_invite_deletion","admin_unauthorized_sign_in_method","admin_login_failure","admin_login_success","admin_logout","admin_login_attempts_reset","admin_mobile_login_failure","admin_mobile_login_success","admin_sign_in_method_expired","admin_password_reset_request","admin_password_reset_success","admin_permission_change","admin_provisioned","admin_name_change","admin_email_change","admin_password_change","admin_locale_change","app_admin_join","app_authentication_method_change","app_data_deletion","app_data_export","request_log_export_requested","workspace_deletion_request","workspace_owner_designation_change","app_google_sso_domain_change","app_identity_verification_change","app_identity_verification_reminder_disabled","identity_verification_unmarked","app_name_change","app_outbound_address_change","app_package_installation","app_package_token_regeneration","app_package_uninstallation","developer_hub_secret_revealed","developer_hub_secret_copied","app_team_creation","app_team_deletion","app_team_membership_modification","app_timezone_change","app_webhook_creation","app_webhook_deletion","articles_in_messenger_enabled_change","automatic_domain_authentication_started","automatic_domain_authentication_complete","messenger_api_secret_creation","messenger_api_secret_deletion","messenger_search_required_change","messenger_spaces_change","bulk_data_export_creation","bulk_data_export_delete","bulk_data_export_run","bulk_data_export_settings_change","bulk_delete","bulk_export","call_settings_change","campaign_deletion","campaign_state_change","content_sync_pair_creation","content_sync_pair_deletion","content_sync_pair_run","content_sync_pair_update","conversation_attribute_archive","conversation_deletion","conversation_deletion_schedule_creation","conversation_deletion_schedule_state_change","conversation_deletion_schedule_update","conversation_hard_deletion_enqueued","conversation_part_deletion","conversation_part_edited","conversation_part_redaction","conversation_pdf_export","conversation_redaction_enqueued","conversation_sla_change","conversation_topic_change","conversation_topic_creation","conversation_topic_deletion","csv_import_completion","csv_import_creation","taxonomy_upload_creation","automation_roadmap_form_submission_creation","data_connector_log_retention_setting_creation","data_connector_log_retention_setting_update","email_settings_change","strip_inbound_email_links_change","help_center_settings_change","inbound_conversations_change","inbox_access_change","inbox_bulk_action","internal_agent_proposal_applied","message_deletion","ruleset_activation","ruleset_deletion","ruleset_creation","workflow_creation","workflow_deletion","workflow_update","workflow_status_change","workflow_participant_action_configured","oauth_token_revocation","article_creation","article_deletion","article_content_creation","article_content_update","article_content_deletion","article_content_published","article_content_unpublished","article_content_audience_updated","message_state_change","messenger_look_and_feel_change","office_hours_change","office_hours_exception_change","role_change","role_creation","role_deletion","seat_change","seat_revoke","pre_migration_seat_expiration_date_change","post_migration_seat_deletion","post_migration_seat_update","post_migration_seat_creation","security_settings_change","temporary_expectation_auto_expired","temporary_expectation_change","temporary_expectation_messages_change","welcome_message_change","start_conversation_button_text_change","upfront_email_collection_change","admin_assignment_limit_change","admin_channel_limit_change","admin_conversation_assignment_limit_change","admin_ticket_assignment_limit_change","admin_unassign_unsnoozed_at_capacity_change","team_assignment_limit_change","teammate_skills_synced","skill_category_created","skill_category_updated","snooze_presets_change","team_skill_categories_updated","admin_two_factor_auth_change","admin_two_factor_login_failure","email_signature_change","recovery_code_sent","billing_addressees_change","billing_addressees_bounced_and_removed","billing_details_change","broadcast_deletion","fin_opt_in","fin_free_usage_window_create","fin_free_usage_window_extension","fin_ingestion_consent","ip_allowlist_setting_change","rest_api_ip_allowlist_setting_change","messenger_platform_availability_change","messenger_platform_inactivity_disable_event","custom_report_update","custom_report_delete","custom_report_create","reporting_folder_create","reporting_folder_delete","teammate_office_hours_schedule_assign","teammate_office_hours_schedule_unassign","report_snapshot_create","report_scheduled_share_create","report_scheduled_share_update","report_scheduled_share_delete","reporting_folder_name_change","reporting_folder_position_change","reporting_folder_reports_change","reporting_folder_pin_change","reporting_csv_export","pii_data_revealed","privacy_policy_notice_change","privacy_policy_notice_contents_change","report_access_create","report_access_delete","report_access_update","fin_persisted_data_context_attribute_change","fin_sdr_connector_generated","fin_sdr_connector_activated","fin_sdr_marketo_connected","fin_sdr_marketo_partition_selected","fin_sdr_marketo_disconnected","fin_sdr_playbook_updated","generic_ecommerce_connector_creation","ai_agent_customization_settings_change","ai_agent_identity_settings_change","ai_agent_multilingual_settings_change","ai_agent_safety_guard_settings_change","messenger_language_change","ai_agent_guidance_change","ai_category_change","escalation_rule_change","hitl_rule_change","safety_response_category_config_change","hitl_inbox_action","brand_creation","brand_update","brand_deletion","brand_settings_change","action_created","action_risk_accepted_change","data_connector_security_warning_acknowledged","action_published","action_status_change","action_update","allowed_attachment_filetypes_setting_change","ai_agent_fin_playground_change","ai_agent_preview_token_generated","selection_set_creation","selection_set_archive","series_creation","series_deletion","series_settings_update","series_status_change","series_update","messenger_launch_to_conversation_change","messenger_launcher_display_condition_change","alias_mode_change","alias_name_change","hippa_compliance_settings_change","ai_inbox_translation_setting_change","slack_integration_auto_promoted","slack_oauth_fresh_install","slack_oauth_reinstall","slack_oauth_reauthentication","slack_integration_uninstalled","telegram_identity_reset","telegram_integration_installed","telegram_integration_uninstalled","slack_user_association_setting_change","ms_teams_user_association_setting_change","slack_integration_type_change","slack_multi_conversational_changed","whatsapp_direct_send_changed","slack_user_token_creation","standalone_channel_change","standalone_connection_config_change","standalone_schedule_sync_deletion","skill_category_deleted","skill_based_routing_toggled","consent_banner_settings_change","content_redaction_rule_creation","content_redaction_rule_deletion","content_redaction_rule_update","content_suggestions_change","suggestions_limiters_reset","custom_authentication_token_creation","custom_authentication_token_update","custom_authentication_token_deletion","device_token_deletion","predictive_answers_settings_change","custom_emoji_deletion","customer_facing_name_change","attach_uploads_inline_setting_change","user_camera_attachments_setting_change","user_media_attachments_setting_change","user_file_attachments_setting_change","file_upload_audience_predicates_setting_change","user_gifs_setting_change","user_emojis_setting_change","user_voice_notes_setting_change","user_conversation_attachments_setting_change","teammate_gifs_setting_change","scim_group_creation","scim_group_update","scim_groups_bulk_update","scim_group_deletion","scim_group_membership_change","scim_admin_role_change","scim_admin_bulk_role_assignment","scim_admin_profile_update","scim_admin_password_update","scim_system_enabled","scim_system_disabled","scim_settings_change","macro_content_export_run","personal_macro_admin_read","personal_macro_admin_convert","personal_macro_admin_destroy","macro_creation","macro_deletion","macro_update","macro_usage_export","mcp_server_created","mcp_server_updated","mcp_server_deleted","mcp_server_enabled","mcp_server_disabled","mcp_server_oauth_connected","mcp_server_oauth_disconnected","mcp_server_reconnected","mcp_action_added","mcp_actions_batch_added","mcp_action_updated","mcp_action_removed","fin_agent_api_settings_change","fin_procedures_hitl_settings_change","fin_procedures_hitl_access_token_rotated","fin_agent_api_secret_revealed","fin_agent_api_secret_copied","a2a_agent_registered","a2a_agent_oauth_connected","automatic_away_mode_setting_change","admin_occupancy_setting_change","unassign_unsnoozed_at_capacity_setting_change","unassign_unsnoozed_when_away_setting_change","unassign_triggers_setting_change","malicious_domains_setting_change","trusted_domains_setting_change","messenger_allowed_domains_change","qa_monitor_creation","qa_monitor_update","qa_monitor_archive","qa_monitor_restore","qa_scorecard_creation","qa_scorecard_update","qa_scorecard_archive","qa_review_plan_creation","qa_review_plan_archive","lead_to_user_merge","user_to_user_merge","sales_messenger_configuration_change","shopify_refund_order","shopify_replacement_order","shopify_gift_card_compensation","shopify_add_replacement_item","shopify_disable_discount_code","shopify_disable_gift_card","shopify_create_discount_code","shopify_update_shipping_address","channel_identity_rule_change","topic_curation_set_live","hide_csat_from_agents_setting_change","phone_purchase_diagnostic","phone_number_purchase","sip_domain_provisioned","sip_domain_deleted","sip_integration_stage_confirmed","sip_header_mappings_updated","phone_queue_call_pinned","phone_queue_call_unpinned","phone_queue_call_pin_cleared","outbound_phone_campaign_creation","outbound_phone_campaign_change","outbound_phone_campaign_deletion","outbound_phone_campaign_state_change","outbound_phone_campaign_csv_upload","outbound_phone_campaign_import","outbound_phone_campaign_session_start","channel_wrap_up_settings_change","ticket_state_customer_notifications_change","schedule_template_update","schedule_template_creation","schedule_template_deletion","schedule_template_apply","wfm_google_calendar_connected","wfm_google_calendar_disconnected","wfm_google_calendar_sync_setting_change","github_sync_disconnected","github_sync_cleanup_deleted_folder","github_sync_installed","github_sync_connector_cloned","github_sync_pulled","fallback_admin_alias_change","spam_email_deletion","snowflake_share_activated","snowflake_share_torn_down","calendar_mapping_rule_creation","calendar_mapping_rule_deletion","calendar_mapping_rule_update","activity_type_creation","masked_admin_avatar_change"]},"key":"Successful response","summary":"Successful response","id":"paths/~1admins~1activity_log_event_types/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"85a1e5b6-e743-4e89-a6e2-1d7c0c3f4a5b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1admins/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"admin.list","admins":[{"type":"admin","email":"admin7@email.com","id":"991267466","name":"Ciaran7 Lee","away_mode_enabled":false,"away_mode_reassign":false,"has_inbox_seat":true,"team_ids":[]}]},"key":"Successful response","summary":"Successful response","id":"paths/~1admins/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5ef5682e-f66e-40a4-b828-8592175f83b8","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1admins/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1admins~1{admin_id}/get/responses/200/content/application~1json/examples/Admin found":{"value":{"type":"admin","id":"991267468","name":"Ciaran9 Lee","email":"admin9@email.com","away_mode_enabled":false,"away_mode_reassign":false,"has_inbox_seat":true,"away_status_reason_id":null,"team_ids":[814865,991267903],"team_priority_level":{"primary_team_ids":[814865]}},"key":"Admin found","summary":"Admin found","id":"paths/~1admins~1{admin_id}/get/responses/200/content/application~1json/examples/Admin found"},"paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ff783bc1-754f-4a9f-887b-22f94fec18f0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1admins~1{admin_id}/get/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"c59f7ca5-1639-4284-a66d-50e34ed98ab3","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1admins~1{admin_id}/get/responses/404/content/application~1json/examples/Admin not found"},"paths/~1admins~1remove/delete/responses/200/content/application~1json/examples/Successful response":{"value":{"id":"123","object":"admin","removed":"true"},"key":"Successful response","summary":"Successful response","id":"paths/~1admins~1remove/delete/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins~1remove/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"00000000-0000-4000-8000-000000000002","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1remove/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1remove/delete/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","errors":[{"code":"action_forbidden","message":"The admin for reassign_conversations_admin_id does not have Inbox access permissions"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1admins~1remove/delete/responses/403/content/application~1json/examples/Forbidden"},"paths/~1admins~1remove/delete/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"00000000-0000-4000-8000-000000000001","errors":[{"code":"admin_not_found","message":"Admin for admin_id not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1admins~1remove/delete/responses/404/content/application~1json/examples/Admin not found"},"paths/~1admins~1remove/delete/responses/405/content/application~1json/examples/Method Not Allowed":{"value":{"type":"error.list","errors":[{"code":"action_forbidden","message":"This method is not allowed for this type of Admin for admin_id"}]},"key":"Method Not Allowed","summary":"Method Not Allowed","id":"paths/~1admins~1remove/delete/responses/405/content/application~1json/examples/Method Not Allowed"},"paths/~1ai~1content_import_sources/get/responses/200/content/application~1json/examples/successful":{"value":{"data":[{"id":33,"type":"content_import_source","last_synced_at":1734537259,"status":"active","url":"https://support.example.com/us/1","sync_behavior":"automatic","created_at":1734537259,"updated_at":1734537259,"audience_ids":[]},{"id":34,"type":"content_import_source","last_synced_at":1734537259,"status":"active","url":"https://support.example.com/us/2","sync_behavior":"automatic","created_at":1734537259,"updated_at":1734537259,"audience_ids":[]},{"id":35,"type":"content_import_source","last_synced_at":1734537259,"status":"active","url":"https://support.example.com/us/3","sync_behavior":"automatic","created_at":1734537259,"updated_at":1734537259,"audience_ids":[]}],"pages":{"type":"pages","page":1,"per_page":50,"total_pages":1},"total_count":3,"type":"list"},"key":"successful","summary":"successful","id":"paths/~1ai~1content_import_sources/get/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Invalid page":{"value":{"type":"error.list","request_id":"6c1f2a54-8d0b-4e0e-9a43-0f5b1d7a2c11","errors":[{"code":"parameter_invalid","message":"Page must be greater than or equal to 1"}]},"key":"Invalid page","summary":"Invalid page","id":"paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Invalid page"},"paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Page size too large":{"value":{"type":"error.list","request_id":"b7d94e0a-3f52-4c58-8a1e-52c0e9d36f27","errors":[{"code":"parameter_invalid","message":"Page size must be less than or equal to 150"}]},"key":"Page size too large","summary":"Page size too large","id":"paths/~1ai~1content_import_sources/get/responses/400/content/application~1json/examples/Page size too large"},"paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9e554e0f-ed0a-4fc6-b141-105d70c9d485","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful":{"value":{"sync_behavior":"api","url":"https://www.example.com"},"key":"successful","summary":"successful","id":"paths/~1ai~1content_import_sources/post/requestBody/content/application~1json/examples/successful"},"paths/~1ai~1content_import_sources/post/responses/200/content/application~1json/examples/successful":{"value":{"id":36,"type":"content_import_source","last_synced_at":1734537261,"status":"active","url":"https://www.example.com","sync_behavior":"api","created_at":1734537261,"updated_at":1734537261,"audience_ids":[]},"key":"successful","summary":"successful","id":"paths/~1ai~1content_import_sources/post/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Missing parameter":{"value":{"type":"error.list","request_id":"0a7e5c31-9b24-4d86-b3f1-6e8d2c4a9f15","errors":[{"code":"parameter_not_found","message":"sync_behavior is a required parameter"}]},"key":"Missing parameter","summary":"Missing parameter","id":"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Missing parameter"},"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid URL":{"value":{"type":"error.list","request_id":"73d1b8e6-4c0a-4f59-82d7-a5e91c3b0f48","errors":[{"code":"parameter_invalid","message":"URL must be a valid URI with a http or https protocol"}]},"key":"Invalid URL","summary":"Invalid URL","id":"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid URL"},"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Sync behavior must be api":{"value":{"type":"error.list","request_id":"c5f09a27-3e81-4b6d-9a42-d8b17e6c0a93","errors":[{"code":"parameter_invalid","message":"Sync behavior must be api"}]},"key":"Sync behavior must be api","summary":"Sync behavior must be api","id":"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Sync behavior must be api"},"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid audience IDs":{"value":{"type":"error.list","request_id":"1e6b3d98-a2c7-4f05-8b91-47d0c5e2a6f3","errors":[{"code":"parameter_invalid","message":"audience_ids contains invalid audience references"}]},"key":"Invalid audience IDs","summary":"Invalid audience IDs","id":"paths/~1ai~1content_import_sources/post/responses/400/content/application~1json/examples/Invalid audience IDs"},"paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"31262ee6-aa3b-4748-a260-a1084754ebae","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"093e1dd9-996a-4154-a64c-80803a5c2084","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1content_import_sources~1{source_id}/delete/responses/404/content/application~1json/examples/Content import source not found":{"value":{"type":"error.list","request_id":"2f8a6d13-5b7c-4e49-b0d2-9e1c4a7f3b58","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Content import source not found","summary":"Content import source not found","id":"paths/~1ai~1content_import_sources~1{source_id}/delete/responses/404/content/application~1json/examples/Content import source not found"},"paths/~1ai~1content_import_sources~1{source_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":38,"type":"content_import_source","last_synced_at":1734537265,"status":"active","url":"https://support.example.com/us/5","sync_behavior":"api","created_at":1734537265,"updated_at":1734537265,"audience_ids":[]},"key":"successful","summary":"successful","id":"paths/~1ai~1content_import_sources~1{source_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5556d3dd-d4e2-4424-9757-2ad0accb52e5","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1content_import_sources~1{source_id}/get/responses/404/content/application~1json/examples/Content import source not found":{"value":{"type":"error.list","request_id":"2f8a6d13-5b7c-4e49-b0d2-9e1c4a7f3b58","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Content import source not found","summary":"Content import source not found","id":"paths/~1ai~1content_import_sources~1{source_id}/get/responses/404/content/application~1json/examples/Content import source not found"},"paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"sync_behavior":"api","url":"https://www.example.com"},"key":"successful","summary":"successful","id":"paths/~1ai~1content_import_sources~1{source_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":39,"type":"content_import_source","last_synced_at":1734537267,"status":"active","url":"https://www.example.com","sync_behavior":"api","created_at":1734537267,"updated_at":1734537267,"audience_ids":[]},"key":"successful","summary":"successful","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Missing parameter":{"value":{"type":"error.list","request_id":"9d3a1f60-5e27-4c84-a0b6-2f7c8e1d4b59","errors":[{"code":"parameter_not_found","message":"url is a required parameter"}]},"key":"Missing parameter","summary":"Missing parameter","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Missing parameter"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Sync behavior must be api":{"value":{"type":"error.list","request_id":"4b8e2c75-0d19-4a63-95f8-e3a1b7c60d24","errors":[{"code":"parameter_invalid","message":"Sync behavior must be api"}]},"key":"Sync behavior must be api","summary":"Sync behavior must be api","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Sync behavior must be api"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Invalid audience IDs":{"value":{"type":"error.list","request_id":"f2c75a09-6b3e-4d18-b4a7-80e9d1c35f62","errors":[{"code":"parameter_invalid","message":"audience_ids contains invalid audience references"}]},"key":"Invalid audience IDs","summary":"Invalid audience IDs","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/400/content/application~1json/examples/Invalid audience IDs"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"cb4a6795-2cdb-44f9-adb7-0624702f7e8a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1content_import_sources~1{source_id}/put/responses/404/content/application~1json/examples/Content import source not found":{"value":{"type":"error.list","request_id":"2f8a6d13-5b7c-4e49-b0d2-9e1c4a7f3b58","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Content import source not found","summary":"Content import source not found","id":"paths/~1ai~1content_import_sources~1{source_id}/put/responses/404/content/application~1json/examples/Content import source not found"},"paths/~1ai~1external_pages/get/responses/200/content/application~1json/examples/successful":{"value":{"data":[{"id":"19","type":"external_page","title":"My External Content","html":"<h1>Hello world</h1><p>This is external content</p>","url":"https://support.example.com/us/3","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":42,"external_id":"3","audience_ids":[],"tags":{"type":"tag.list","tags":[]},"created_at":1734537269,"updated_at":1734537269,"last_ingested_at":1734537269},{"id":"18","type":"external_page","title":"My External Content","html":"<h1>Hello world</h1><p>This is external content</p>","url":"https://support.example.com/us/2","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":41,"external_id":"2","audience_ids":[],"tags":{"type":"tag.list","tags":[]},"created_at":1734537269,"updated_at":1734537269,"last_ingested_at":1734537269},{"id":"17","type":"external_page","title":"My External Content","html":"<h1>Hello world</h1><p>This is external content</p>","url":"https://support.example.com/us/1","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":40,"external_id":"1","audience_ids":[],"tags":{"type":"tag.list","tags":[]},"created_at":1734537269,"updated_at":1734537269,"last_ingested_at":1734537269}],"pages":{"type":"pages","page":1,"per_page":50,"total_pages":1},"total_count":3,"type":"list"},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages/get/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Invalid page":{"value":{"type":"error.list","request_id":"6c1f2a54-8d0b-4e0e-9a43-0f5b1d7a2c11","errors":[{"code":"parameter_invalid","message":"Page must be greater than or equal to 1"}]},"key":"Invalid page","summary":"Invalid page","id":"paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Invalid page"},"paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page size too large":{"value":{"type":"error.list","request_id":"b7d94e0a-3f52-4c58-8a1e-52c0e9d36f27","errors":[{"code":"parameter_invalid","message":"Page size must be less than or equal to 150"}]},"key":"Page size too large","summary":"Page size too large","id":"paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page size too large"},"paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page limit exceeded":{"value":{"type":"error.list","request_id":"d2a8f6c1-5b3e-4a79-8e0d-7c41f9b2a6e3","errors":[{"code":"bad_request","message":"page limit reached, please use scroll API"}]},"key":"Page limit exceeded","summary":"Page limit exceeded","id":"paths/~1ai~1external_pages/get/responses/400/content/application~1json/examples/Page limit exceeded"},"paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"bd0c53dd-d3fd-4095-be25-94537a8ba364","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful":{"value":{"audience_ids":[1,2],"external_id":"abc1234","html":"<html><body><h1>Test</h1></body></html>","locale":"en","source_id":44,"title":"Test","url":"https://www.example.com"},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages/post/requestBody/content/application~1json/examples/successful"},"paths/~1ai~1external_pages/post/responses/200/content/application~1json/examples/successful":{"value":{"id":"21","type":"external_page","title":"Test","html":"<html><body><h1>Test</h1></body></html>","url":"https://www.example.com","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":44,"external_id":"abc1234","audience_ids":[1,2],"tags":{"type":"tag.list","tags":[]},"created_at":1734537273,"updated_at":1734537274,"last_ingested_at":1734537274},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages/post/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Missing parameter":{"value":{"type":"error.list","request_id":"3a9d6e21-8f04-4b7c-a5d3-1c0e7b92f846","errors":[{"code":"parameter_not_found","message":"external_id is a required parameter"}]},"key":"Missing parameter","summary":"Missing parameter","id":"paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Missing parameter"},"paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Unsupported locale":{"value":{"type":"error.list","request_id":"a8e14c63-2d75-4f09-b1a8-6d3f90c5e7b2","errors":[{"code":"parameter_invalid","message":"Locale must be supported"}]},"key":"Unsupported locale","summary":"Unsupported locale","id":"paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Unsupported locale"},"paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Source is not an API source":{"value":{"type":"error.list","request_id":"5f0b9d84-1a36-4e72-8c4d-b27e5a1f0c69","errors":[{"code":"parameter_invalid","message":"Content Import Source must have API sync behaviour"}]},"key":"Source is not an API source","summary":"Source is not an API source","id":"paths/~1ai~1external_pages/post/responses/400/content/application~1json/examples/Source is not an API source"},"paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"205ffc13-1b25-43b2-a176-cb817af5f899","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Content import source not found":{"value":{"type":"error.list","request_id":"58c2f0b9-7e14-4a3d-a6c8-1d9b3e5f7a02","errors":[{"code":"content_import_source_not_found","message":"Content Import Source not found"}]},"key":"Content import source not found","summary":"Content import source not found","id":"paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Content import source not found"},"paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","request_id":"e9a30c47-1b6d-4d52-8f0a-7c5e2b9d1a36","errors":[{"code":"parameter_invalid","message":"audience_ids contains unknown audience IDs: 999"}]},"key":"Unknown audience IDs","summary":"Unknown audience IDs","id":"paths/~1ai~1external_pages/post/responses/404/content/application~1json/examples/Unknown audience IDs"},"paths/~1ai~1external_pages~1{page_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"22","type":"external_page","title":"My External Content","html":"","url":"https://support.example.com/us/5","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":45,"external_id":"4","audience_ids":[],"tags":{"type":"tag.list","tags":[]},"created_at":1734537276,"updated_at":1734537276,"last_ingested_at":1734537276},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages~1{page_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2380cdd5-c4a0-451a-b07d-a6f4b720add3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1external_pages~1{page_id}/delete/responses/404/content/application~1json/examples/External page not found":{"value":{"type":"error.list","request_id":"d41b7e92-6a03-4f8c-91e5-3c2a8b0f6d74","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"External page not found","summary":"External page not found","id":"paths/~1ai~1external_pages~1{page_id}/delete/responses/404/content/application~1json/examples/External page not found"},"paths/~1ai~1external_pages~1{page_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"23","type":"external_page","title":"My External Content","html":"<h1>Hello world</h1><p>This is external content</p>","url":"https://support.example.com/us/6","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":46,"external_id":"5","audience_ids":[],"tags":{"type":"tag.list","tags":[]},"created_at":1734537278,"updated_at":1734537278,"last_ingested_at":1734537278},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages~1{page_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"504cde98-f786-4f64-b373-e26a6a41fd11","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1external_pages~1{page_id}/get/responses/404/content/application~1json/examples/External page not found":{"value":{"type":"error.list","request_id":"d41b7e92-6a03-4f8c-91e5-3c2a8b0f6d74","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"External page not found","summary":"External page not found","id":"paths/~1ai~1external_pages~1{page_id}/get/responses/404/content/application~1json/examples/External page not found"},"paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"audience_ids":[1,2],"external_id":"5678","html":"<html><body><h1>Test</h1></body></html>","locale":"en","source_id":47,"title":"Test","url":"https://www.example.com"},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages~1{page_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1ai~1external_pages~1{page_id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"24","type":"external_page","title":"Test","html":"<html><body><h1>Test</h1></body></html>","url":"https://www.example.com","ai_agent_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"fin_availability":true,"locale":"en","source_id":47,"external_id":"5678","audience_ids":[1,2],"tags":{"type":"tag.list","tags":[]},"created_at":1734537280,"updated_at":1734537281,"last_ingested_at":1734537281},"key":"successful","summary":"successful","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Missing parameter":{"value":{"type":"error.list","request_id":"e07c4a15-9b62-4d38-a1f5-c3d8b6e20a74","errors":[{"code":"parameter_not_found","message":"html is a required parameter"}]},"key":"Missing parameter","summary":"Missing parameter","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Missing parameter"},"paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Source cannot be changed":{"value":{"type":"error.list","request_id":"2d9f6b30-7a58-4c14-93e6-0b4a1d8c5f27","errors":[{"code":"parameter_invalid","message":"You can't update source_id"}]},"key":"Source cannot be changed","summary":"Source cannot be changed","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Source cannot be changed"},"paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Unsupported locale":{"value":{"type":"error.list","request_id":"b61a3e97-4c08-4f25-8d70-9e5c2a1b7d43","errors":[{"code":"parameter_invalid","message":"Locale must be supported"}]},"key":"Unsupported locale","summary":"Unsupported locale","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/400/content/application~1json/examples/Unsupported locale"},"paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8217b189-b908-4562-962d-2a19a7b77f25","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/External page not found":{"value":{"type":"error.list","request_id":"d41b7e92-6a03-4f8c-91e5-3c2a8b0f6d74","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"External page not found","summary":"External page not found","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/External page not found"},"paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Content import source not found":{"value":{"type":"error.list","request_id":"58c2f0b9-7e14-4a3d-a6c8-1d9b3e5f7a02","errors":[{"code":"content_import_source_not_found","message":"Content Import Source not found"}]},"key":"Content import source not found","summary":"Content import source not found","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Content import source not found"},"paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","request_id":"e9a30c47-1b6d-4d52-8f0a-7c5e2b9d1a36","errors":[{"code":"parameter_invalid","message":"audience_ids contains unknown audience IDs: 999"}]},"key":"Unknown audience IDs","summary":"Unknown audience IDs","id":"paths/~1ai~1external_pages~1{page_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"7522907"},"key":"successful","summary":"Apply a tag","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":1663597223,"applied_by":{"type":"admin","id":"1234"}},"key":"Tag applied","summary":"Tag applied","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found":{"value":{"type":"error.list","request_id":"d41b7e92-6a03-4f8c-91e5-3c2a8b0f6d74","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"External page not found","summary":"External page not found","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/External page not found"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"},"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"7a34a204-9fae-5335-b818-1da0df3b5234","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"},"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":null,"applied_by":null},"key":"Tag removed","summary":"Tag removed","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"},"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"},"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found":{"value":{"type":"error.list","request_id":"d41b7e92-6a03-4f8c-91e5-3c2a8b0f6d74","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"External page not found","summary":"External page not found","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/External page not found"},"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1ai~1external_pages~1{external_page_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1articles/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"type":"pages","page":1,"per_page":25,"total_pages":1},"total_count":1,"data":[{"id":"39","type":"article","workspace_id":"this_is_an_id64_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"61","title":"This is the article title","description":"","body":"","body_markdown":"","author_id":991267492,"state":"published","created_at":1734537283,"updated_at":1734537283,"url":"http://help-center.test/myapp-64/en/articles/39-this-is-the-article-title","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":false,"draft_updated_at":null}]},"key":"successful","summary":"successful","id":"paths/~1articles/get/responses/200/content/application~1json/examples/successful"},"paths/~1articles/get/responses/400/content/application~1json/examples/Per page too large":{"value":{"type":"error.list","request_id":"ea1a3101-3e36-5689-ada2-68bd7a32748a","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too large","summary":"Per page too large","id":"paths/~1articles/get/responses/400/content/application~1json/examples/Per page too large"},"paths/~1articles/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2e760b85-9020-471b-89dc-f579ec8a0104","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles/post/requestBody/content/application~1json/examples/article_created":{"value":{"title":"Thanks for everything","description":"Description of the Article","body":"Body of the Article","author_id":991267497,"state":"published","parent_id":145,"translated_content":{"fr":{"title":"Merci pour tout","description":"Description de l'article","body":"Corps de l'article","author_id":991267497,"state":"published"}}},"key":"article_created","summary":"article created","id":"paths/~1articles/post/requestBody/content/application~1json/examples/article_created"},"paths/~1articles/post/requestBody/content/application~1json/examples/bad_request":{"value":{"title":"Thanks for everything","description":"Description of the Article","body":"Body of the Article","state":"published"},"key":"bad_request","summary":"Bad Request","id":"paths/~1articles/post/requestBody/content/application~1json/examples/bad_request"},"paths/~1articles/post/responses/200/content/application~1json/examples/article created":{"value":{"id":"42","type":"article","workspace_id":"this_is_an_id68_that_should_be_at_least_4","parent_ids":[145],"folder_id":null,"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0,"fin_involvements":0,"fin_resolutions":0,"fin_resolution_rate":0},"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"69","title":"Thanks for everything","description":"Description of the Article","body":"<p class=\"no-margin\">Body of the Article</p>","body_markdown":"Body of the Article\n","author_id":991267497,"state":"published","created_at":1734537288,"updated_at":1734537288,"url":"http://help-center.test/myapp-68/en/articles/42-thanks-for-everything","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":false,"draft_updated_at":null},"key":"article created","summary":"article created","id":"paths/~1articles/post/responses/200/content/application~1json/examples/article created"},"paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":"e522ca8a-cd15-404e-84b3-7f7536003d4a","errors":[{"code":"parameter_not_found","message":"author_id must be in the main body or default locale translated_content object"}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request"},"paths/~1articles/post/responses/400/content/application~1json/examples/Missing title":{"value":{"type":"error.list","request_id":"b052ee5c-f602-5d9a-8356-94544cd9b12a","errors":[{"code":"parameter_not_found","message":"Title is a required parameter"}]},"key":"Missing title","summary":"Missing title","id":"paths/~1articles/post/responses/400/content/application~1json/examples/Missing title"},"paths/~1articles/post/responses/400/content/application~1json/examples/Unsupported locale":{"value":{"type":"error.list","request_id":"00e07e24-9182-5d6a-8830-4a977fd902c9","errors":[{"code":"data_invalid","message":"Locale 'xx' isn't supported."}]},"key":"Unsupported locale","summary":"Unsupported locale","id":"paths/~1articles/post/responses/400/content/application~1json/examples/Unsupported locale"},"paths/~1articles/post/responses/400/content/application~1json/examples/Collection not found":{"value":{"type":"error.list","request_id":"4c9f130d-bfb7-5cab-9a98-7c9fa6650ea9","errors":[{"code":"parameter_invalid","message":"Collection not found"}]},"key":"Collection not found","summary":"Collection not found","id":"paths/~1articles/post/responses/400/content/application~1json/examples/Collection not found"},"paths/~1articles/post/responses/400/content/application~1json/examples/Publish time in the past":{"value":{"type":"error.list","request_id":"b0015de0-8628-523f-bca1-780ed3bdcc75","errors":[{"code":"parameter_invalid","message":"scheduled_publish_at must be in the future"}]},"key":"Publish time in the past","summary":"Publish time in the past","id":"paths/~1articles/post/responses/400/content/application~1json/examples/Publish time in the past"},"paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"85e91429-72df-4e69-8a12-b55793dff59f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles/post/responses/401/content/application~1json/examples/Author not authorised":{"value":{"type":"error.list","request_id":"4be1f5b3-3590-5eb7-83df-6d852559f097","errors":[{"code":"action_forbidden","message":"author_id 991267497 is not authorised on this workspace"}]},"key":"Author not authorised","summary":"Author not authorised","id":"paths/~1articles/post/responses/401/content/application~1json/examples/Author not authorised"},"paths/~1articles/post/responses/404/content/application~1json/examples/Author not found":{"value":{"type":"error.list","request_id":"e1650d39-7d30-554f-aeb1-b4aa32837f1a","errors":[{"code":"not_found","message":"Admin not found"}]},"key":"Author not found","summary":"Author not found","id":"paths/~1articles/post/responses/404/content/application~1json/examples/Author not found"},"paths/~1articles/post/responses/422/content/application~1json/examples/Body and body_markdown both provided":{"value":{"type":"error.list","request_id":"a560a2a1-1b69-5178-8953-b3d8c982eb29","errors":[{"code":"parameter_invalid","message":"body and body_markdown are mutually exclusive - please provide only one"}]},"key":"Body and body_markdown both provided","summary":"Body and body_markdown both provided","id":"paths/~1articles/post/responses/422/content/application~1json/examples/Body and body_markdown both provided"},"paths/~1articles/post/responses/422/content/application~1json/examples/Invalid availability value":{"value":{"type":"error.list","request_id":"3a0b96f7-6f76-5b2e-899a-776192cb6235","errors":[{"code":"parameter_invalid","message":"ai_chatbot_availability must be true or false"}]},"key":"Invalid availability value","summary":"Invalid availability value","id":"paths/~1articles/post/responses/422/content/application~1json/examples/Invalid availability value"},"paths/~1articles~1{article_id}/get/responses/200/content/application~1json/examples/Article found":{"value":{"id":"45","type":"article","workspace_id":"this_is_an_id74_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0,"fin_involvements":0,"fin_resolutions":0,"fin_resolution_rate":0},"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"73","title":"This is the article title","description":"","body":"","body_markdown":"","author_id":991267502,"state":"published","created_at":1734537292,"updated_at":1734537292,"url":"http://help-center.test/myapp-74/en/articles/45-this-is-the-article-title","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":false,"draft_updated_at":null},"key":"Article found","summary":"Article found","id":"paths/~1articles~1{article_id}/get/responses/200/content/application~1json/examples/Article found"},"paths/~1articles~1{article_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2eab07fb-5092-49a4-ba74-44094f31f264","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}/get/responses/404/content/application~1json/examples/Article not found":{"value":{"type":"error.list","request_id":"79abd27a-1bfb-42ec-a404-5728c76ba773","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Article not found","summary":"Article not found","id":"paths/~1articles~1{article_id}/get/responses/404/content/application~1json/examples/Article not found"},"paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>"},"key":"successful","summary":"successful","id":"paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>"},"key":"article_not_found","summary":"Article Not Found","id":"paths/~1articles~1{article_id}/put/requestBody/content/application~1json/examples/article_not_found"},"paths/~1articles~1{article_id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"48","type":"article","workspace_id":"this_is_an_id80_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0,"fin_involvements":0,"fin_resolutions":0,"fin_resolution_rate":0},"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"79","title":"Christmas is here!","description":"","body":"<p class=\"no-margin\">New gifts in store for the jolly season</p>","body_markdown":"New gifts in store for the jolly season\n","author_id":991267508,"state":"published","created_at":1734537297,"updated_at":1734537298,"url":"http://help-center.test/myapp-80/en/articles/48-christmas-is-here","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":false,"draft_updated_at":null},"key":"successful","summary":"successful","id":"paths/~1articles~1{article_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish and unpublish in the same request":{"value":{"type":"error.list","request_id":"884b59c8-2bae-51de-b300-e9b78dfa793c","errors":[{"code":"parameter_invalid","message":"Cannot schedule a publish and unpublish in the same request"}]},"key":"Publish and unpublish in the same request","summary":"Publish and unpublish in the same request","id":"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish and unpublish in the same request"},"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish time in the past":{"value":{"type":"error.list","request_id":"9936f252-ad05-5bf2-b681-c94d83904f71","errors":[{"code":"parameter_invalid","message":"scheduled_publish_at must be in the future"}]},"key":"Publish time in the past","summary":"Publish time in the past","id":"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Publish time in the past"},"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unpublish on an article that is not published":{"value":{"type":"error.list","request_id":"4d09d60a-6f62-5b5e-b71a-92c949fad184","errors":[{"code":"parameter_invalid","message":"Cannot schedule an unpublish on an article that is not currently published"}]},"key":"Unpublish on an article that is not published","summary":"Unpublish on an article that is not published","id":"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unpublish on an article that is not published"},"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unsupported locale":{"value":{"type":"error.list","request_id":"bf534ebb-919e-5f80-91d0-35de1deffc4a","errors":[{"code":"data_invalid","message":"Locale 'xx' isn't supported."}]},"key":"Unsupported locale","summary":"Unsupported locale","id":"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Unsupported locale"},"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Collection not found":{"value":{"type":"error.list","request_id":"f1c380ad-c52e-50ba-a678-70a258799efe","errors":[{"code":"parameter_invalid","message":"Collection not found"}]},"key":"Collection not found","summary":"Collection not found","id":"paths/~1articles~1{article_id}/put/responses/400/content/application~1json/examples/Collection not found"},"paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d1ea223d-bb62-42e3-8bcf-30fdcf7dbd99","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Author not authorised":{"value":{"type":"error.list","request_id":"f62b30e2-5b2e-561d-b1e8-01a84a380ee2","errors":[{"code":"action_forbidden","message":"author_id 991267508 is not authorised on this workspace"}]},"key":"Author not authorised","summary":"Author not authorised","id":"paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Author not authorised"},"paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found":{"value":{"type":"error.list","request_id":"f9adccb2-9fca-4b87-bbb7-65f2af5e1d78","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Article Not Found","summary":"Article Not Found","id":"paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found"},"paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Author not found":{"value":{"type":"error.list","request_id":"da7836a0-95a1-5926-969c-6bc26f5a6633","errors":[{"code":"not_found","message":"Admin not found"}]},"key":"Author not found","summary":"Author not found","id":"paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Author not found"},"paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Body and body_markdown both provided":{"value":{"type":"error.list","request_id":"2ee5920d-5fd3-5adc-8a58-d3e0cf3723c1","errors":[{"code":"parameter_invalid","message":"body and body_markdown are mutually exclusive - please provide only one"}]},"key":"Body and body_markdown both provided","summary":"Body and body_markdown both provided","id":"paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Body and body_markdown both provided"},"paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Invalid availability value":{"value":{"type":"error.list","request_id":"f504af40-1675-56e1-8d06-28eae3412526","errors":[{"code":"parameter_invalid","message":"ai_chatbot_availability must be true or false"}]},"key":"Invalid availability value","summary":"Invalid availability value","id":"paths/~1articles~1{article_id}/put/responses/422/content/application~1json/examples/Invalid availability value"},"paths/~1articles~1{article_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"51","object":"article","deleted":true},"key":"successful","summary":"successful","id":"paths/~1articles~1{article_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1articles~1{article_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c6e86ce8-9402-4196-89c5-f1b2912b4bac","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}/delete/responses/404/content/application~1json/examples/Article Not Found":{"value":{"type":"error.list","request_id":"afe37506-cc48-4727-8068-ae7ff0e7b0e3","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Article Not Found","summary":"Article Not Found","id":"paths/~1articles~1{article_id}/delete/responses/404/content/application~1json/examples/Article Not Found"},"paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article has dependent procedures":{"value":{"type":"error.list","request_id":"d3212011-eabc-5be0-8011-9eb5ff048813","errors":[{"code":"content_has_procedure_dependencies","message":"Article has dependent procedures and cannot be deleted"}]},"key":"Article has dependent procedures","summary":"Article has dependent procedures","id":"paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article has dependent procedures"},"paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article is referenced elsewhere":{"value":{"type":"error.list","request_id":"ade54c49-399e-52cd-8cc7-951307c40e06","errors":[{"code":"dependent_references_blocked","message":"Can't delete this public article because it is used by \"Refund policy\" in Main Fin. Remove those references first."}]},"key":"Article is referenced elsewhere","summary":"Article is referenced elsewhere","id":"paths/~1articles~1{article_id}/delete/responses/422/content/application~1json/examples/Article is referenced elsewhere"},"paths/~1articles~1{id}~1draft/get/responses/200/content/application~1json/examples/Article draft found":{"value":{"id":"45","type":"article","workspace_id":"this_is_an_id74_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0,"fin_involvements":0,"fin_resolutions":0,"fin_resolution_rate":0},"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"73","title":"This is the draft title","description":"","body":"<p class=\"no-margin\">Unpublished changes staged as a draft</p>","body_markdown":"Unpublished changes staged as a draft\n","author_id":991267502,"state":"published","created_at":1734537292,"updated_at":1734537292,"url":"http://help-center.test/myapp-74/en/articles/45-this-is-the-article-title","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":true,"draft_updated_at":1734537292},"key":"Article draft found","summary":"Article draft found","id":"paths/~1articles~1{id}~1draft/get/responses/200/content/application~1json/examples/Article draft found"},"paths/~1articles~1{id}~1draft/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{id}~1draft/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/ObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Object not found"}]},"key":"ObjectNotFound","summary":"ObjectNotFound","id":"paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/CustomObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"CustomObjectNotFound","summary":"CustomObjectNotFound","id":"paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1articles~1{id}~1draft/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>"},"key":"Draft staged","summary":"Stage a draft","id":"paths/~1articles~1{id}~1draft/put/requestBody/content/application~1json/examples/Draft staged"},"paths/~1articles~1{id}~1draft/put/responses/200/content/application~1json/examples/Draft staged":{"value":{"id":"48","type":"article","workspace_id":"this_is_an_id80_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0,"fin_involvements":0,"fin_resolutions":0,"fin_resolution_rate":0},"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"79","title":"Christmas is here!","description":"","body":"<p class=\"no-margin\">New gifts in store for the jolly season</p>","body_markdown":"New gifts in store for the jolly season\n","author_id":991267508,"state":"published","created_at":1734537297,"updated_at":1734537298,"url":"http://help-center.test/myapp-80/en/articles/48-christmas-is-here","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":true,"draft_updated_at":1734537298},"key":"Draft staged","summary":"Draft staged","id":"paths/~1articles~1{id}~1draft/put/responses/200/content/application~1json/examples/Draft staged"},"paths/~1articles~1{id}~1draft/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{id}~1draft/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/ObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Object not found"}]},"key":"ObjectNotFound","summary":"ObjectNotFound","id":"paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/CustomObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"CustomObjectNotFound","summary":"CustomObjectNotFound","id":"paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1articles~1{id}~1draft/put/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article not published":{"value":{"errors":[{"message":"Article must be published before a draft can be staged","status":422}]},"key":"Article not published","summary":"Article not published","id":"paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article not published"},"paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Locale not published":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"Cannot stage a draft for locale(s) that are not published on the article: fr"}]},"key":"Locale not published","summary":"Locale not published","id":"paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Locale not published"},"paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales":{"value":{"locales":["en","fr"]},"key":"Publish specific locales","summary":"Publish specific locales on a multilingual workspace","id":"paths/~1articles~1{id}~1draft~1publish/post/requestBody/content/application~1json/examples/Publish specific locales"},"paths/~1articles~1{id}~1draft~1publish/post/responses/200/content/application~1json/examples/Draft published":{"value":{"id":"48","type":"article","workspace_id":"this_is_an_id80_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0,"fin_involvements":0,"fin_resolutions":0,"fin_resolution_rate":0},"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"79","title":"Christmas is here!","description":"","body":"<p class=\"no-margin\">New gifts in store for the jolly season</p>","body_markdown":"New gifts in store for the jolly season\n","author_id":991267508,"state":"published","created_at":1734537297,"updated_at":1734537299,"url":"http://help-center.test/myapp-80/en/articles/48-christmas-is-here","audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":false,"draft_updated_at":null},"key":"Draft published","summary":"Draft published","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/200/content/application~1json/examples/Draft published"},"paths/~1articles~1{id}~1draft~1publish/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/ObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Object not found"}]},"key":"ObjectNotFound","summary":"ObjectNotFound","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/CustomObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"CustomObjectNotFound","summary":"CustomObjectNotFound","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/No draft to publish":{"value":{"errors":[{"message":"Article has no draft to publish","status":422}]},"key":"No draft to publish","summary":"No draft to publish","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/No draft to publish"},"paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locales required on a multilingual workspace":{"value":{"type":"error.list","request_id":"9b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","errors":[{"code":"parameter_not_found","message":"locales must be specified to publish a draft on a multilingual workspace"}]},"key":"Locales required on a multilingual workspace","summary":"Locales required on a multilingual workspace","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locales required on a multilingual workspace"},"paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locale has no pending changes":{"value":{"type":"error.list","request_id":"0c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f","errors":[{"code":"parameter_invalid","message":"Cannot publish a draft for locale(s) without pending changes: fr"}]},"key":"Locale has no pending changes","summary":"Locale has no pending changes","id":"paths/~1articles~1{id}~1draft~1publish/post/responses/422/content/application~1json/examples/Locale has no pending changes"},"paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"7522907"},"key":"successful","summary":"Apply a tag","id":"paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":1663597223,"applied_by":{"type":"admin","id":"1234"}},"key":"Tag applied","summary":"Tag applied","id":"paths/~1articles~1{article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"},"paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1articles~1{article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"article_not_found","message":"Article not found"}]},"key":"Article not found","summary":"Article not found","id":"paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Article not found"},"paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"},"paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"7a34a204-9fae-5335-b818-1da0df3b5234","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1articles~1{article_id}~1tags/post/responses/404/content/application~1json/examples/Admin not found"},"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":null,"applied_by":null},"key":"Tag removed","summary":"Tag removed","id":"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"},"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"},"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"article_not_found","message":"Article not found"}]},"key":"Article not found","summary":"Article not found","id":"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Article not found"},"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1articles~1{article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1articles~1{article_id}~1versions/get/responses/200/content/application~1json/examples/Versions found":{"value":{"type":"list","pages":{"type":"pages","page":1,"per_page":10,"total_pages":1},"total_count":2,"data":[{"type":"article_version","id":"301","article_id":"123","title":"This is the article title","description":"","author_id":"991267502","created_by_id":"5017691","created_via":"web","from_version_id":"300","state":"published","created_at":1734537292},{"type":"article_version","id":"300","article_id":"123","title":"This was the earlier title","description":"","author_id":"991267502","created_by_id":"5017691","created_via":"api","from_version_id":null,"state":"draft","created_at":1734530000}]},"key":"Versions found","summary":"Versions found","id":"paths/~1articles~1{article_id}~1versions/get/responses/200/content/application~1json/examples/Versions found"},"paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/No content for locale":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"No content found for locale 'fr' on article 123"}]},"key":"No content for locale","summary":"No content for locale","id":"paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/No content for locale"},"paths/~1articles~1{article_id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/ObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Object not found"}]},"key":"ObjectNotFound","summary":"ObjectNotFound","id":"paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/CustomObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"CustomObjectNotFound","summary":"CustomObjectNotFound","id":"paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1articles~1{article_id}~1versions/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/200/content/application~1json/examples/Version found":{"value":{"type":"article_version","id":"301","article_id":"123","title":"This is the article title","description":"","body":"<p class=\"no-margin\">Body of this version</p>","body_markdown":"Body of this version\n","author_id":"991267502","created_by_id":"5017691","created_via":"web","from_version_id":"300","state":"published","created_at":1734537292,"updated_at":1734537292},"key":"Version found","summary":"Version found","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/200/content/application~1json/examples/Version found"},"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/No content for locale":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"No content found for locale 'fr' on article 123"}]},"key":"No content for locale","summary":"No content for locale","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/No content for locale"},"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Object not found"}]},"key":"ObjectNotFound","summary":"ObjectNotFound","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"CustomObjectNotFound","summary":"CustomObjectNotFound","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1articles~1search/get/responses/200/content/application~1json/examples/Search successful":{"value":{"type":"list","total_count":1,"data":{"articles":[{"id":"55","type":"article","workspace_id":"this_is_an_id92_that_should_be_at_least_4","parent_ids":[],"folder_id":null,"tags":{"type":"tag.list","tags":[]},"exclude_from_article_suggestions":false,"help_center_audience":"everyone","scheduled_publish_at":null,"scheduled_unpublish_at":null,"content_id":"91","title":"Title 1","description":"","body":"","body_markdown":"","author_id":991267521,"state":"draft","created_at":1734537306,"updated_at":1734537306,"url":null,"audience_ids":[],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_by_id":5017691,"updated_by_id":5017691,"has_unpublished_changes":false,"draft_updated_at":null}],"highlights":[]},"pages":{"type":"pages","page":1,"total_pages":1,"per_page":10}},"key":"Search successful","summary":"Search successful","id":"paths/~1articles~1search/get/responses/200/content/application~1json/examples/Search successful"},"paths/~1articles~1search/get/responses/200/content/application~1json/examples/No results":{"value":{"type":"list","total_count":0,"data":[],"pages":{"type":"pages","page":1,"total_pages":1,"per_page":10}},"key":"No results","summary":"No results","id":"paths/~1articles~1search/get/responses/200/content/application~1json/examples/No results"},"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Phrase too long":{"value":{"type":"error.list","request_id":"1bc9b60b-0786-5071-8f02-7a1774b9e60c","errors":[{"code":"parameter_invalid","message":"Phrase is too long"}]},"key":"Phrase too long","summary":"Phrase too long","id":"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Phrase too long"},"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid state":{"value":{"type":"error.list","request_id":"45ab1896-953a-51ff-ab2a-208ae54fd42c","errors":[{"code":"parameter_mismatch","message":"Article state must be one of published, draft, all"}]},"key":"Invalid state","summary":"Invalid state","id":"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid state"},"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid help center":{"value":{"type":"error.list","request_id":"4a19af49-61cb-5405-a03e-240ff7d4e685","errors":[{"code":"invalid_help_center_id","message":"Invalid Help Center ID"}]},"key":"Invalid help center","summary":"Invalid help center","id":"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid help center"},"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid pagination":{"value":{"type":"error.list","request_id":"a88426cc-4cdd-5084-baf4-4db7b55bd4f9","errors":[{"code":"data_invalid","message":"Pagination data must be a number greater than 0"}]},"key":"Invalid pagination","summary":"Invalid pagination","id":"paths/~1articles~1search/get/responses/400/content/application~1json/examples/Invalid pagination"},"paths/~1articles~1search/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c70746a8-a5b2-4772-afba-1a4b487ea75d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1audiences/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"audience","id":"123","name":"VIP Customers","predicates":[{"attribute":"company.name","type":"string","comparison":"contains","value":"Acme"}],"role_predicates":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}],"created_at":1717200000,"updated_at":1717200000},{"type":"audience","id":"456","name":"Enterprise Accounts","predicates":[{"attribute":"custom_attributes.plan","type":"string","comparison":"eq","value":"enterprise"}],"role_predicates":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}],"created_at":1717200000,"updated_at":1717200000}],"total_count":2,"page":1,"per_page":50,"total_pages":1},"key":"Successful response","summary":"Successful response","id":"paths/~1audiences/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b1939528-98f0-4a63-a442-2cc9203fc8c7","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1audiences/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"ca9d1103-eb54-42e8-8da4-45c95f943584","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1audiences/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created":{"value":{"name":"VIP Customers","predicates":[{"attribute":"company.name","type":"string","comparison":"contains","value":"Acme"}],"role_predicates":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}]},"key":"audience_created","summary":"Audience created","id":"paths/~1audiences/post/requestBody/content/application~1json/examples/audience_created"},"paths/~1audiences/post/responses/201/content/application~1json/examples/Audience created":{"value":{"type":"audience","id":"789","name":"VIP Customers","predicates":[{"attribute":"company.name","type":"string","comparison":"contains","value":"Acme"}],"role_predicates":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}],"created_at":1717200000,"updated_at":1717200000},"key":"Audience created","summary":"Audience created","id":"paths/~1audiences/post/responses/201/content/application~1json/examples/Audience created"},"paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1audiences/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"66178beb-eb7f-43da-b4e9-7376cb2f7df9","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1audiences/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1audiences/post/responses/422/content/application~1json/examples/Validation error":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Name is required"}]},"key":"Validation error","summary":"Validation error","id":"paths/~1audiences/post/responses/422/content/application~1json/examples/Validation error"},"paths/~1audiences~1{id}/get/responses/200/content/application~1json/examples/Audience found":{"value":{"type":"audience","id":"123","name":"VIP Customers","predicates":[{"attribute":"company.name","type":"string","comparison":"contains","value":"Acme"}],"role_predicates":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}],"created_at":1717200000,"updated_at":1717200000},"key":"Audience found","summary":"Audience found","id":"paths/~1audiences~1{id}/get/responses/200/content/application~1json/examples/Audience found"},"paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"e8cd397d-4b39-428b-b05d-5834060184e3","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1audiences~1{id}/get/responses/404/content/application~1json/examples/Audience not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Audience not found"}]},"key":"Audience not found","summary":"Audience not found","id":"paths/~1audiences~1{id}/get/responses/404/content/application~1json/examples/Audience not found"},"paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated":{"value":{"name":"Enterprise Accounts","predicates":[{"attribute":"custom_attributes.plan","type":"string","comparison":"eq","value":"enterprise"}]},"key":"audience_updated","summary":"Audience updated","id":"paths/~1audiences~1{id}/put/requestBody/content/application~1json/examples/audience_updated"},"paths/~1audiences~1{id}/put/responses/200/content/application~1json/examples/Audience updated":{"value":{"type":"audience","id":"123","name":"Enterprise Accounts","predicates":[{"attribute":"custom_attributes.plan","type":"string","comparison":"eq","value":"enterprise"}],"role_predicates":[{"attribute":"role","type":"role","comparison":"in","value":["user_role","contact_role","visitor_role"]}],"created_at":1717200000,"updated_at":1717200100},"key":"Audience updated","summary":"Audience updated","id":"paths/~1audiences~1{id}/put/responses/200/content/application~1json/examples/Audience updated"},"paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f8a9b0c1-2d3e-4f5a-6b7c-8d9e0f1a2b3c","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a97359e1-abb7-4055-9af3-f7e7554012c9","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1audiences~1{id}/put/responses/404/content/application~1json/examples/Audience not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Audience not found"}]},"key":"Audience not found","summary":"Audience not found","id":"paths/~1audiences~1{id}/put/responses/404/content/application~1json/examples/Audience not found"},"paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Name cannot be blank":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Name cannot be blank"}]},"key":"Name cannot be blank","summary":"Name cannot be blank","id":"paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Name cannot be blank"},"paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Audience has no ruleset":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Audience has no ruleset"}]},"key":"Audience has no ruleset","summary":"Audience has no ruleset","id":"paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Audience has no ruleset"},"paths/~1audiences~1{id}/delete/responses/400/content/application~1json/examples/Audience has dependent objects":{"value":{"type":"error.list","request_id":"5b5800b4-d2ef-4a6c-8b4c-ac586553b4de","errors":[{"code":"audience_has_dependent_objects","message":"Unable to delete audience with dependent objects.","data":{"dependent_count":2}}]},"key":"Audience has dependent objects","summary":"Audience has dependent objects","id":"paths/~1audiences~1{id}/delete/responses/400/content/application~1json/examples/Audience has dependent objects"},"paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a700781a-7897-4cdc-93d9-dfb1becab382","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1audiences~1{id}/delete/responses/404/content/application~1json/examples/Audience not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Audience not found"}]},"key":"Audience not found","summary":"Audience not found","id":"paths/~1audiences~1{id}/delete/responses/404/content/application~1json/examples/Audience not found"},"paths/~1auth_tokens/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"auth_token","id":"12345","name":"Fulfilment API key","description":"Used by the order status connector","token_type":"text","request_header_key":"Authorization","token_prefix":"Bearer","domain":"api.fulfilment.example.com","created_at":1763199000,"updated_at":1768918935}],"pages":{"type":"pages","per_page":20,"next":{"starting_after":"WzE3MDc1OTQ3MTUuMCwxMjM0NV0="}}},"key":"successful","summary":"successful","id":"paths/~1auth_tokens/get/responses/200/content/application~1json/examples/successful"},"paths/~1auth_tokens/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid cursor","summary":"Invalid cursor","id":"paths/~1auth_tokens/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1auth_tokens/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1auth_tokens/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful":{"value":{"name":"Fulfilment API key","token_value":"example-token-value","request_header_key":"Authorization","token_prefix":"Bearer","description":"Used by the order status connector"},"key":"successful","summary":"successful","id":"paths/~1auth_tokens/post/requestBody/content/application~1json/examples/successful"},"paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential":{"value":{"name":"Fulfilment OAuth credential","token_type":"oauth","oauth_configuration":{"token_url":"https://auth.fulfilment.example.com/oauth/token","client_id":"fulfilment-connector","client_secret":"8f6e2b1a9c4d7e05","scope":"orders.read"},"description":"Used by the order status connector"},"key":"OAuth credential","summary":"OAuth credential","id":"paths/~1auth_tokens/post/requestBody/content/application~1json/examples/OAuth credential"},"paths/~1auth_tokens/post/responses/201/content/application~1json/examples/successful":{"value":{"type":"auth_token","id":"12345","name":"Fulfilment API key","description":"Used by the order status connector","token_type":"text","request_header_key":"Authorization","token_prefix":"Bearer","domain":null,"created_at":1763199000,"updated_at":1763199000},"key":"successful","summary":"successful","id":"paths/~1auth_tokens/post/responses/201/content/application~1json/examples/successful"},"paths/~1auth_tokens/post/responses/201/content/application~1json/examples/OAuth credential":{"value":{"type":"auth_token","id":"12346","name":"Fulfilment OAuth credential","description":"Used by the order status connector","token_type":"oauth","request_header_key":"Authorization","token_prefix":"Bearer","domain":null,"created_at":1763199000,"updated_at":1763199000},"key":"OAuth credential","summary":"OAuth credential","id":"paths/~1auth_tokens/post/responses/201/content/application~1json/examples/OAuth credential"},"paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Missing required field":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_not_found","message":"name parameter is required"}]},"key":"Missing required field","summary":"Missing required field","id":"paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Missing required field"},"paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Field not accepted for token_type":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_invalid","message":"request_header_key is not accepted for oauth tokens"}]},"key":"Field not accepted for token_type","summary":"Field not accepted for token_type","id":"paths/~1auth_tokens/post/responses/400/content/application~1json/examples/Field not accepted for token_type"},"paths/~1auth_tokens/post/responses/400/content/application~1json/examples/OAuth exchange failed":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_invalid","message":"Could not obtain an access token from token_url with the given client credentials"}]},"key":"OAuth exchange failed","summary":"OAuth exchange failed","id":"paths/~1auth_tokens/post/responses/400/content/application~1json/examples/OAuth exchange failed"},"paths/~1auth_tokens/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1auth_tokens/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1auth_tokens/post/responses/403/content/application~1json/examples/No teammate associated with the access token":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"forbidden","message":"Writing an auth token requires an access token associated with a teammate"}]},"key":"No teammate associated with the access token","summary":"No teammate associated with the access token","id":"paths/~1auth_tokens/post/responses/403/content/application~1json/examples/No teammate associated with the access token"},"paths/~1auth_tokens/post/responses/429/content/application~1json/examples/Rate limited":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"rate_limit_exceeded","message":"Exceeded rate limit of 10 OAuth auth token creations per minute"}]},"key":"Rate limited","summary":"Rate limited","id":"paths/~1auth_tokens/post/responses/429/content/application~1json/examples/Rate limited"},"paths/~1auth_tokens~1{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"auth_token","id":"12345","name":"Fulfilment API key","description":"Used by the order status connector","token_type":"text","request_header_key":"Authorization","token_prefix":"Bearer","domain":"api.fulfilment.example.com","created_at":1763199000,"updated_at":1768918935},"key":"successful","summary":"successful","id":"paths/~1auth_tokens~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1auth_tokens~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1auth_tokens~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1auth_tokens~1{id}/get/responses/404/content/application~1json/examples/Auth token not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Auth token not found","summary":"Auth token not found","id":"paths/~1auth_tokens~1{id}/get/responses/404/content/application~1json/examples/Auth token not found"},"paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful":{"value":{"name":"Fulfilment API key (rotated host)","description":"Used by the order status connector"},"key":"successful","summary":"successful","id":"paths/~1auth_tokens~1{id}/patch/requestBody/content/application~1json/examples/successful"},"paths/~1auth_tokens~1{id}/patch/responses/200/content/application~1json/examples/successful":{"value":{"type":"auth_token","id":"12345","name":"Fulfilment API key (rotated host)","description":"Used by the order status connector","token_type":"text","request_header_key":"Authorization","token_prefix":"Bearer","domain":"api.fulfilment.example.com","created_at":1763199000,"updated_at":1768918935},"key":"successful","summary":"successful","id":"paths/~1auth_tokens~1{id}/patch/responses/200/content/application~1json/examples/successful"},"paths/~1auth_tokens~1{id}/patch/responses/400/content/application~1json/examples/Unsupported token type":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_invalid","message":"Only auth tokens with token_type \"text\" can be updated through the API"}]},"key":"Unsupported token type","summary":"Unsupported token type","id":"paths/~1auth_tokens~1{id}/patch/responses/400/content/application~1json/examples/Unsupported token type"},"paths/~1auth_tokens~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1auth_tokens~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1auth_tokens~1{id}/patch/responses/403/content/application~1json/examples/No teammate associated with the access token":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"forbidden","message":"Writing an auth token requires an access token associated with a teammate"}]},"key":"No teammate associated with the access token","summary":"No teammate associated with the access token","id":"paths/~1auth_tokens~1{id}/patch/responses/403/content/application~1json/examples/No teammate associated with the access token"},"paths/~1auth_tokens~1{id}/patch/responses/404/content/application~1json/examples/Auth token not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Auth token not found","summary":"Auth token not found","id":"paths/~1auth_tokens~1{id}/patch/responses/404/content/application~1json/examples/Auth token not found"},"paths/~1away_status_reasons/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1away_status_reasons/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"banner","id":"486517","view_id":"645719311","title":"Hi there","body":"<p class=\"no-margin\">Hi there!</p>","style":"inline","position":"top","show_dismiss_button":true,"action":null,"client_targeting":null,"created_at":1780580493}]},"key":"Successful response","summary":"Successful response","id":"paths/~1contacts~1{id}~1banners/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}~1banners/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"57055cde-3d0d-4c67-b5c9-b20b80340bf0","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1banners/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"banner_dismiss","view_id":"645719311","dismissed":true},"key":"Successful response","summary":"Successful response","id":"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found":{"value":{"type":"error.list","request_id":"57055cde-3d0d-4c67-b5c9-b20b80340bf0","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Banner view not found","summary":"Banner view not found","id":"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Banner view not found"},"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"8a2d6f0e-4b7c-4e19-9f3a-1c5e8b2d7f46","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1banners~1{view_id}~1dismiss/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1brands/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"brand","id":"tlkp1d91","name":"Default Brand","is_default":true,"created_at":1673778600,"updated_at":1711031100,"help_center_id":"11","default_address_settings_id":"13"},{"type":"brand","id":"3","name":"Premium Brand","is_default":false,"created_at":1686387300,"updated_at":1709229600,"help_center_id":"10","default_address_settings_id":"15"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1brands/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1brands/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1brands/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1brands/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1brands/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1brands~1{id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"brand","id":"15","name":"Premium Brand","is_default":false,"created_at":1686387300,"updated_at":1709229600,"help_center_id":"20","default_address_settings_id":"15"},"key":"Successful response","summary":"Successful response","id":"paths/~1brands~1{id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1brands~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1brands~1{id}/get/responses/404/content/application~1json/examples/Brand not found":{"value":{"type":"error.list","request_id":"req_12345","errors":[{"code":"brand_not_found","message":"Brand not found"}]},"key":"Brand not found","summary":"Brand not found","id":"paths/~1brands~1{id}/get/responses/404/content/application~1json/examples/Brand not found"},"paths/~1calls/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[],"total_count":0,"pages":{"type":"pages","page":1,"per_page":25,"total_pages":0}},"key":"successful","summary":"successful","id":"paths/~1calls/get/responses/200/content/application~1json/examples/successful"},"paths/~1calls/get/responses/400/content/application~1json/examples/Per page too large":{"value":{"type":"error.list","request_id":"5d1f7a3c-8e2b-4c64-9a0f-1b7e3c2d4f90","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too large","summary":"Per page too large","id":"paths/~1calls/get/responses/400/content/application~1json/examples/Per page too large"},"paths/~1calls/get/responses/400/content/application~1json/examples/Per page too small":{"value":{"type":"error.list","request_id":"0c9b6e41-27d3-4a85-b1f6-6e8a3d5c7b12","errors":[{"code":"parameter_invalid","message":"Per Page is too small"}]},"key":"Per page too small","summary":"Per page too small","id":"paths/~1calls/get/responses/400/content/application~1json/examples/Per page too small"},"paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1calls/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1calls/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1calls~1{call_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"call","id":"123","conversation_id":"456","admin_id":"789","contact_id":"6762f0dd1bb69f9f2193bb83","state":"ended","initiated_at":1734537437,"answered_at":1734537440,"ended_at":1734537530,"created_at":1734537437,"updated_at":1734537531,"recording_url":"https://api.intercom.io/calls/123/recording","transcription_url":"https://api.intercom.io/calls/123/transcript","call_type":"phone","direction":"outbound","ended_reason":null,"phone":"+15551234567","fin_recording_url":"https://api.intercom.io/calls/124/recording","fin_transcription_url":"https://api.intercom.io/calls/124/transcript","duration":90,"talk_time":85,"queue_time":null,"hold_time":null},"key":"successful","summary":"successful","id":"paths/~1calls~1{call_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1calls~1{call_id}/get/responses/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"9bc4fc62-7cdf-4f72-a56e-02af4836d499","errors":[{"code":"not_found","message":"Not Found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1calls~1{call_id}/get/responses/404/content/application~1json/examples/Not Found"},"paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Recording not found":{"value":{"type":"error.list","request_id":"9bc4fc62-7cdf-4f72-a56e-02af4836d499","errors":[{"code":"call_recording_not_found","message":"Recording Not Found"}]},"key":"Recording not found","summary":"Recording not found","id":"paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Recording not found"},"paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Call not found":{"value":{"type":"error.list","request_id":"4f2d8b17-6a39-4e0c-8d51-c3b7a90e1f26","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Call not found","summary":"Call not found","id":"paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Call not found"},"paths/~1calls~1{id}~1transcript/get/responses/200/content/application~1json/examples/transcript":{"value":[{"start_time":"0.0","end_time":"3.00","speaker_label":"Teammate 1","speaker":"Teammate 1","content":"Hello, thanks for calling. How can I help today?","speaker_type":"admin","speaker_id":"789"},{"start_time":"3.00","end_time":"9.00","speaker_label":"User","speaker":"User","content":"I need help recovering access to my account.","speaker_type":"user","speaker_id":"6762f0dd1bb69f9f2193bb83"}],"key":"transcript","summary":"transcript","id":"paths/~1calls~1{id}~1transcript/get/responses/200/content/application~1json/examples/transcript"},"paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1calls~1{id}~1transcript/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1calls~1{id}~1transcript/get/responses/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"9bc4fc62-7cdf-4f72-a56e-02af4836d499","errors":[{"code":"not_found","message":"Not Found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1calls~1{id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"},"paths/~1calls~1search/post/requestBody/content/application~1json/examples/example":{"value":{"conversation_ids":["64619700005694","64619700005695"]},"key":"example","summary":"example","id":"paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"},"paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"call","id":"123","conversation_id":"64619700005694","transcript":[{"start_time":"0.0","end_time":"3.00","speaker_label":"Teammate 1","speaker":"Teammate 1","content":"Hello, thanks for calling. How can I help today?","speaker_type":"admin","speaker_id":"789"}],"transcript_status":"completed"}]},"key":"successful","summary":"successful","id":"paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"},"paths/~1calls~1search/post/responses/400/content/application~1json/examples/too_many_ids":{"value":{"type":"error.list","errors":[{"code":"conversation_id_limit_exceeded","message":"A list of up to 20 conversation IDs is required"}]},"key":"too_many_ids","summary":"too_many_ids","id":"paths/~1calls~1search/post/responses/400/content/application~1json/examples/too_many_ids"},"paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1calls~1search/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1calls~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1fin_voice~1register/post/responses/200/content/application~1json/examples/registered":{"value":{"id":12345,"app_id":12345,"user_phone_number":"+1234567890","status":"registered","intercom_call_id":null,"external_call_id":"call-123-abc","vendor_internal_id":null,"intercom_conversation_id":null,"call_transcript":[{}],"call_summary":"","intent":[],"fin_call_duration":null,"data":{},"language":null},"key":"registered","summary":"registered","id":"paths/~1fin_voice~1register/post/responses/200/content/application~1json/examples/registered"},"paths/~1companies/post/requestBody/content/application~1json/examples/successful":{"value":{"company_id":"company_remote_id","name":"my company","remote_created_at":1374138000},"key":"successful","summary":"Successful","id":"paths/~1companies/post/requestBody/content/application~1json/examples/successful"},"paths/~1companies/post/requestBody/content/application~1json/examples/bad_request":{"value":{"test":"invalid"},"key":"bad_request","summary":"Bad Request","id":"paths/~1companies/post/requestBody/content/application~1json/examples/bad_request"},"paths/~1companies/post/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"company_remote_id","id":"6762f0761bb69f9f2193bae2","app_id":"this_is_an_id147_that_should_be_at_least_","name":"my company","remote_created_at":1374138000,"created_at":1734537334,"updated_at":1734537334,"monthly_spend":0,"session_count":0,"user_count":0,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{"industry":"manufacturing"},"notes":{"type":"note.list","data":[],"url":"/companies/6762f0761bb69f9f2193bae2/notes","total_count":0,"has_more":false}},"key":"Successful","summary":"Successful","id":"paths/~1companies/post/responses/200/content/application~1json/examples/Successful"},"paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"bad_request","message":"bad 'test' parameter"}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request"},"paths/~1companies/post/responses/400/content/application~1json/examples/Missing company_id":{"value":{"type":"error.list","request_id":"0c6a6de1-7f2b-4a5e-9a3c-1b2d8e4f5a60","errors":[{"code":"bad_request","message":"missing 'company_id' parameter"}]},"key":"Missing company_id","summary":"Missing company_id","id":"paths/~1companies/post/responses/400/content/application~1json/examples/Missing company_id"},"paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute does not exist":{"value":{"type":"error.list","request_id":"1d7b7ef2-8a3c-4b6f-8b4d-2c3e9f506b71","errors":[{"code":"parameter_invalid","message":"Custom attribute 'plan_tier' does not exist"}]},"key":"Custom attribute does not exist","summary":"Custom attribute does not exist","id":"paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute does not exist"},"paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute value is an object":{"value":{"type":"error.list","request_id":"2e8c8f03-9b4d-4c70-9c5e-3d4f0a617c82","errors":[{"code":"nested_custom_attributes","message":"Cannot submit an object as a custom attribute value"}]},"key":"Custom attribute value is an object","summary":"Custom attribute value is an object","id":"paths/~1companies/post/responses/400/content/application~1json/examples/Custom attribute value is an object"},"paths/~1companies/post/responses/400/content/application~1json/examples/Company is not an object":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"422","message":"invalid company data structure"}]},"key":"Company is not an object","summary":"Company is not an object","id":"paths/~1companies/post/responses/400/content/application~1json/examples/Company is not an object"},"paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8a9f415f-e9df-41e9-ba1f-739914f66551","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"3f9d9014-ac5e-4d81-ad6f-4e501b728d93","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies/post/responses/422/content/application~1json/examples/Monthly spend out of range":{"value":{"type":"error.list","request_id":"3dfc2c5e-fe80-460e-9b42-765c2835beeb","errors":[{"code":"unprocessable_entity","message":"monthly_spend has to be in range [-2147483648, 2147483647]"}]},"key":"Monthly spend out of range","summary":"Monthly spend out of range","id":"paths/~1companies/post/responses/422/content/application~1json/examples/Monthly spend out of range"},"paths/~1companies/get/responses/200/content/application~1json/examples/List of companies":{"value":{"type":"list","data":[{"type":"company","company_id":"remote_companies_scroll_2","id":"6762f07a1bb69f9f2193baea","app_id":"this_is_an_id153_that_should_be_at_least_","name":"IntercomQATest1","remote_created_at":1734537338,"created_at":1734537338,"updated_at":1734537338,"monthly_spend":0,"session_count":0,"user_count":4,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f07a1bb69f9f2193baea/notes","total_count":0,"has_more":false}}],"pages":{"type":"pages","next":null,"page":1,"per_page":15,"total_pages":1},"total_count":1},"key":"List of companies","summary":"List of companies","id":"paths/~1companies/get/responses/200/content/application~1json/examples/List of companies"},"paths/~1companies/get/responses/200/content/application~1json/examples/Single company (company_id or name)":{"value":{"type":"company","company_id":"1","id":"6762f07f1bb69f9f2193baf5","app_id":"this_is_an_id159_that_should_be_at_least_","name":"company1","remote_created_at":1734537343,"created_at":1734537343,"updated_at":1734537343,"monthly_spend":0,"session_count":0,"user_count":1,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[{"id":"17495962","type":"note","url":"/notes/17495962","body":"<p>Text for the note.</p>"}],"url":"/companies/6762f07f1bb69f9f2193baf5/notes","total_count":1,"has_more":false}},"key":"Single company (company_id or name)","summary":"Single company (company_id or name)","id":"paths/~1companies/get/responses/200/content/application~1json/examples/Single company (company_id or name)"},"paths/~1companies/get/responses/400/content/application~1json/examples/Per page too big":{"value":{"type":"error.list","request_id":"4a0e1b25-bd6f-4e92-be70-5f612c839ea4","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too big","summary":"Per page too big","id":"paths/~1companies/get/responses/400/content/application~1json/examples/Per page too big"},"paths/~1companies/get/responses/400/content/application~1json/examples/Page limit reached":{"value":{"type":"error.list","request_id":"5b1f2c36-ce70-4fa3-cf81-6a723d94afb5","errors":[{"code":"bad_request","message":"page limit reached, please use scroll API"}]},"key":"Page limit reached","summary":"Page limit reached","id":"paths/~1companies/get/responses/400/content/application~1json/examples/Page limit reached"},"paths/~1companies/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2fa563ba-f9c9-4281-a76b-10bfd777dfd7","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"9bc4fc62-7cdf-4f72-a56e-02af4836d499","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies/get/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies/get/responses/503/content/application~1json/examples/Search temporarily unavailable":{"value":{"type":"error.list","request_id":"6c2a3d47-df81-40b4-d092-7b834ea5b0c6","errors":[{"code":"service_unavailable","message":"Feature temporarily unavailable"}]},"key":"Search temporarily unavailable","summary":"Search temporarily unavailable","id":"paths/~1companies/get/responses/503/content/application~1json/examples/Search temporarily unavailable"},"paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6762f07f1bb69f9f2193baf5","app_id":"this_is_an_id159_that_should_be_at_least_","name":"company1","remote_created_at":1734537343,"created_at":1734537343,"updated_at":1734537343,"monthly_spend":0,"session_count":0,"user_count":1,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f07f1bb69f9f2193baf5/notes","total_count":0,"has_more":false}},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Per page too big":{"value":{"type":"error.list","request_id":"ebc33a9a-9163-41a5-8ac3-fde3d8098bf7","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too big","summary":"Per page too big","id":"paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Per page too big"},"paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Page limit reached":{"value":{"type":"error.list","request_id":"b739b9c2-ed4a-46f2-9fe9-3e2e7ba028fa","errors":[{"code":"bad_request","message":"page limit reached, please use scroll API"}]},"key":"Page limit reached","summary":"Page limit reached","id":"paths/~1companies~1{company_id}/get/responses/400/content/application~1json/examples/Page limit reached"},"paths/~1companies~1{company_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"caf73ce4-bda6-4f2b-bbfb-0d984d430335","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"57d57564-b5e2-4064-abfe-4653e5ac24c0","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{company_id}/get/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"name":"my company","website":"http://www.mycompany.com/"},"key":"successful","summary":"Successful","id":"paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request":{"value":{"test":"invalid"},"key":"bad_request","summary":"Bad Request","id":"paths/~1companies~1{company_id}/put/requestBody/content/application~1json/examples/bad_request"},"paths/~1companies~1{company_id}/put/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6762f0841bb69f9f2193baff","app_id":"this_is_an_id165_that_should_be_at_least_","name":"company2","remote_created_at":1734537348,"created_at":1734537348,"updated_at":1734537348,"monthly_spend":0,"session_count":0,"user_count":1,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f0841bb69f9f2193baff/notes","total_count":0,"has_more":false}},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{company_id}/put/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist":{"value":{"type":"error.list","request_id":"7d3b4e58-e092-41c5-e1a3-8c945fb6c1d7","errors":[{"code":"parameter_invalid","message":"Custom attribute 'plan_tier' does not exist"}]},"key":"Custom attribute does not exist","summary":"Custom attribute does not exist","id":"paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist"},"paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute value is an object":{"value":{"type":"error.list","request_id":"8e4c5f69-f1a3-42d6-f2b4-9da56ac7d2e8","errors":[{"code":"nested_custom_attributes","message":"Cannot submit an object as a custom attribute value"}]},"key":"Custom attribute value is an object","summary":"Custom attribute value is an object","id":"paths/~1companies~1{company_id}/put/responses/400/content/application~1json/examples/Custom attribute value is an object"},"paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"4748eb32-3261-4798-ace0-a5825edf4eb5","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"9f5d6a7a-02b4-43e7-a3c5-aeb67bd8e3f9","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1{company_id}/put/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"daa64b43-3e3c-4fc4-aef9-91eb40c7885c","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{company_id}/put/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{company_id}/put/responses/422/content/application~1json/examples/Monthly spend out of range":{"value":{"type":"error.list","request_id":"b93c392a-918e-4fdf-bf6a-73554a31106c","errors":[{"code":"unprocessable_entity","message":"monthly_spend has to be in range [-2147483648, 2147483647]"}]},"key":"Monthly spend out of range","summary":"Monthly spend out of range","id":"paths/~1companies~1{company_id}/put/responses/422/content/application~1json/examples/Monthly spend out of range"},"paths/~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful":{"value":{"id":"6762f0881bb69f9f2193bb09","object":"company","deleted":true},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7b13fd9c-31be-40de-94e1-d71f260a3458","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a06e7b8b-13c5-44f8-b4d6-bfc78ce9f40a","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"4f41d1d6-7a42-45e3-a24e-544deb62da47","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[],"total_count":0,"pages":{"type":"pages","page":1,"per_page":50,"total_pages":0}},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{company_id}~1contacts/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after":{"value":{"type":"error.list","request_id":"b17f8a9b-139c-4418-b4e6-bfd79cf9040a","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid starting_after","summary":"Invalid starting_after","id":"paths/~1companies~1{company_id}~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"},"paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f7586690-c217-47db-9042-cb9550b81260","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"c281819c-24d6-4509-c5e7-c0d89adfa51b","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"5dde0b79-8c81-4d9e-a4d4-736a44cf2f00","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{company_id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{company_id}~1segments/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[]},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{company_id}~1segments/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"91f04dce-5759-4d80-981e-f598ec989d1a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"d392920d-35e7-461a-d6f8-d1e90be0b62c","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1{company_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1{company_id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"de5d939e-77fb-46d7-a3b9-f34199d9f25a","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{company_id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"note","id":"26","created_at":1733932587,"company":{"type":"company","id":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"},"author":{"type":"admin","id":"991267581","name":"Ciaran122 Lee","email":"admin122@email.com","away_mode_enabled":false,"away_mode_reassign":false,"away_status_reason_id":null,"has_inbox_seat":true,"team_ids":[],"team_priority_level":{}},"body":"<p>This is a note.</p>"}],"total_count":1,"pages":{"type":"pages","next":null,"page":1,"per_page":50,"total_pages":1}},"key":"Successful response","summary":"Successful response","id":"paths/~1companies~1{company_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big":{"value":{"type":"error.list","request_id":"4a1f7c90-2b63-4f18-9d7a-0c5e8b41d9f2","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Page size too big","summary":"Page size too big","id":"paths/~1companies~1{company_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"},"paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7d2e5b14-8a06-4c39-bf5d-91e07c3a6b48","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"0f6c3a92-57d1-4e80-b23f-6a9d5c8e14b7","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1{company_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found":{"value":{"type":"error.list","request_id":"57055cde-3d0d-4c67-b5c9-b20b80340bf0","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company not found","summary":"Company not found","id":"paths/~1companies~1{company_id}~1notes/get/responses/404/content/application~1json/examples/Company not found"},"paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response":{"value":{"body":"Hello","admin_id":"991267583"},"key":"successful_response","summary":"Successful response","id":"paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/successful_response"},"paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found":{"value":{"body":"Hello","admin_id":"123"},"key":"admin_not_found","summary":"Admin not found","id":"paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found":{"value":{"body":"Hello"},"key":"company_not_found","summary":"Company not found","id":"paths/~1companies~1{company_id}~1notes/post/requestBody/content/application~1json/examples/company_not_found"},"paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"note","id":"31","created_at":1734537390,"company":{"type":"company","id":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"},"author":{"type":"admin","id":"991267583","name":"Ciaran124 Lee","email":"admin124@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>Hello</p>"},"key":"Successful response","summary":"Successful response","id":"paths/~1companies~1{company_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing":{"value":{"type":"error.list","request_id":"2b84c6e0-91fd-4a37-8c52-6e7d093af415","errors":[{"code":"parameter_invalid","message":"Body can't be nil"}]},"key":"Body missing","summary":"Body missing","id":"paths/~1companies~1{company_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"},"paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5e9a2d71-6c04-4bf8-93ae-1d0f74b25c69","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"8c1b70d3-4f25-49ea-a6d8-3b5f92e07a14","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1{company_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"168f1bc3-d198-4797-8422-9f93fe8af5ad","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found"},"paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found":{"value":{"type":"error.list","request_id":"6f372239-0259-428f-9943-91b8f7a92162","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company not found","summary":"Company not found","id":"paths/~1companies~1{company_id}~1notes/post/responses/404/content/application~1json/examples/Company not found"},"paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful":{"value":{"query":{"operator":"AND","value":[{"field":"name","operator":"=","value":"my-company"}]},"sort":{"field":"name","order":"ascending"},"pagination":{"per_page":5}},"key":"successful","summary":"successful","id":"paths/~1companies~1search/post/requestBody/content/application~1json/examples/successful"},"paths/~1companies~1search/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[],"total_count":0,"pages":{"type":"pages","page":1,"per_page":5,"total_pages":0}},"key":"successful","summary":"successful","id":"paths/~1companies~1search/post/responses/200/content/application~1json/examples/successful"},"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Unsupported field":{"value":{"type":"error.list","request_id":"8d6c1f0a-3b2e-4a17-9c5d-1f0e2a3b4c5d","errors":[{"code":"invalid_field","message":"segment_id is not a valid search field"}]},"key":"Unsupported field","summary":"Unsupported field","id":"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Unsupported field"},"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Invalid sort order":{"value":{"type":"error.list","request_id":"f5b4b42f-5709-433c-f81a-f30b2da2d84e","errors":[{"code":"invalid_sort_order","message":"Invalid sort order 'sideways'. Must be one of: ascending, descending"}]},"key":"Invalid sort order","summary":"Invalid sort order","id":"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Invalid sort order"},"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Sort is not an object":{"value":{"type":"error.list","request_id":"06c5c530-681a-444d-092b-041c3eb3e95f","errors":[{"code":"client_error","message":"Invalid sort parameter. Expected an object with 'field' and 'order'."}]},"key":"Sort is not an object","summary":"Sort is not an object","id":"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Sort is not an object"},"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Pagination is not an object":{"value":{"type":"error.list","request_id":"17d6d641-792b-455e-1a3c-152d4fc4fa60","errors":[{"code":"client_error","message":"Invalid pagination parameter. Expected an object."}]},"key":"Pagination is not an object","summary":"Pagination is not an object","id":"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Pagination is not an object"},"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Per page out of range":{"value":{"type":"error.list","request_id":"4a09095a-ac5e-4882-4d6f-485072f72d93","errors":[{"code":"invalid_per_page","message":"per_page must be an integer between 0 and 150"}]},"key":"Per page out of range","summary":"Per page out of range","id":"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Per page out of range"},"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Cursor does not match the sort":{"value":{"type":"error.list","request_id":"28e7e752-8a3c-4660-2b4d-263e50d50b71","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Cursor does not match the sort","summary":"Cursor does not match the sort","id":"paths/~1companies~1search/post/responses/400/content/application~1json/examples/Cursor does not match the sort"},"paths/~1companies~1search/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f0dc95f1-9e46-4e8d-8150-89365c2c5195","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1search/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1search/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"e4a3a31e-46f8-422b-e709-e2fa1cf1c73d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1search/post/responses/503/content/application~1json/examples/Search temporarily unavailable":{"value":{"type":"error.list","request_id":"39f8f863-9b4d-4771-3c5e-374f61e61c82","errors":[{"code":"service_unavailable","message":"Feature temporarily unavailable"}]},"key":"Search temporarily unavailable","summary":"Search temporarily unavailable","id":"paths/~1companies~1search/post/responses/503/content/application~1json/examples/Search temporarily unavailable"},"paths/~1companies~1list/post/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"type":"company","company_id":"remote_companies_scroll_2","id":"6762f0941bb69f9f2193bb25","app_id":"this_is_an_id189_that_should_be_at_least_","name":"IntercomQATest1","remote_created_at":1734537364,"created_at":1734537364,"updated_at":1734537364,"monthly_spend":0,"session_count":0,"user_count":4,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f0941bb69f9f2193bb25/notes","total_count":0,"has_more":false}}],"pages":{"type":"pages","next":null,"page":1,"per_page":15,"total_pages":1},"total_count":1},"key":"Successful","summary":"Successful","id":"paths/~1companies~1list/post/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1list/post/responses/400/content/application~1json/examples/Per page too big":{"value":{"type":"error.list","request_id":"5b1a1a6b-bd6f-4993-5e70-5961830833a4","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too big","summary":"Per page too big","id":"paths/~1companies~1list/post/responses/400/content/application~1json/examples/Per page too big"},"paths/~1companies~1list/post/responses/400/content/application~1json/examples/Page limit reached":{"value":{"type":"error.list","request_id":"7d3c3c8d-df81-4bb5-7092-7b83a52a55c6","errors":[{"code":"bad_request","message":"page limit reached, please use scroll API"}]},"key":"Page limit reached","summary":"Page limit reached","id":"paths/~1companies~1list/post/responses/400/content/application~1json/examples/Page limit reached"},"paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"537ccc45-2cae-4e72-ac2f-849f1422a771","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1list/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"8e4d4d9e-e092-4cc6-81a3-8c94b63b66d7","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1list/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1scroll/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"type":"company","company_id":"remote_companies_scroll_2","id":"6762f0971bb69f9f2193bb2b","app_id":"this_is_an_id193_that_should_be_at_least_","name":"IntercomQATest1","remote_created_at":1734537367,"created_at":1734537367,"updated_at":1734537367,"monthly_spend":0,"session_count":0,"user_count":4,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f0971bb69f9f2193bb2b/notes","total_count":0,"has_more":false}}],"pages":null,"total_count":null,"scroll_param":"69352cd2-ab5b-42ac-b004-a13d4e55e9b0"},"key":"Successful","summary":"Successful","id":"paths/~1companies~1scroll/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1scroll/get/responses/400/content/application~1json/examples/Scroll already open":{"value":{"type":"error.list","request_id":"9f5e5eaf-f1a3-4dd7-92b4-9da5c74c77e8","errors":[{"code":"scroll_exists","message":"scroll already exists for this workspace"}]},"key":"Scroll already open","summary":"Scroll already open","id":"paths/~1companies~1scroll/get/responses/400/content/application~1json/examples/Scroll already open"},"paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ca269b05-8c42-4615-a28d-7df0eb1687c5","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"b17a7ac1-13c5-4ff9-b4d6-bfc7e96e99fa","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1companies~1scroll/get/responses/404/content/application~1json/examples/Scroll parameter not found":{"value":{"type":"error.list","request_id":"a06f6fb0-02b4-4ee8-a3c5-aeb6d85d88f9","errors":[{"code":"not_found","message":"scroll parameter not found"}]},"key":"Scroll parameter not found","summary":"Scroll parameter not found","id":"paths/~1companies~1scroll/get/responses/404/content/application~1json/examples/Scroll parameter not found"},"paths/~1companies~1scroll/get/responses/503/content/application~1json/examples/Scroll temporarily unavailable":{"value":{"type":"error.list","request_id":"c28b8bd2-24d6-40aa-c5e7-c0d8fa7faa0b","errors":[{"code":"service_unavailable","message":"Feature temporarily unavailable"}]},"key":"Scroll temporarily unavailable","summary":"Scroll temporarily unavailable","id":"paths/~1companies~1scroll/get/responses/503/content/application~1json/examples/Scroll temporarily unavailable"},"paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"6762f09a1bb69f9f2193bb34"},"key":"successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request":{"value":null,"key":"bad_request","summary":"Bad Request","id":"paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/bad_request"},"paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found":{"value":{"id":"123"},"key":"company_not_found","summary":"Company Not Found","id":"paths/~1contacts~1{contact_id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"},"paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6762f09a1bb69f9f2193bb34","app_id":"this_is_an_id197_that_should_be_at_least_","name":"company6","remote_created_at":1734537370,"created_at":1734537370,"updated_at":1734537370,"monthly_spend":0,"session_count":0,"user_count":1,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f09a1bb69f9f2193bb34/notes","total_count":0,"has_more":false}},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":"8879ee29-ade4-4b5a-a275-ab1ac531b82a","errors":[{"code":"parameter_not_found","message":"company not specified"}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Bad Request"},"paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded":{"value":{"type":"error.list","request_id":"9a3d0816-9707-4598-977e-c009ba630148","errors":[{"code":"contact_company_limit_exceeded","message":"Contact has reached the maximum of 1000 company associations"}]},"key":"Contact Company Limit Exceeded","summary":"Contact Company Limit Exceeded","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"},"paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1f187e85-cd9a-4be4-964e-cdbb8c66334a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"1daf6d3f-99ba-59c7-86f7-5d966270f7d3","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"981799ea-f19b-432d-828c-491a3b29ad29","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"7b1f5e2c-19c8-4c7f-9f0a-6f0a6a0ad3c1","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"company","company_id":"1","id":"6762f0a61bb69f9f2193bb55","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,"monthly_spend":0,"session_count":0,"user_count":1,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f0a61bb69f9f2193bb55/notes","total_count":0,"has_more":false}}],"pages":{"type":"pages","next":null,"page":1,"per_page":50,"total_pages":1},"total_count":1},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1companies/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big":{"value":{"type":"error.list","request_id":"3f1c2b9e-6a4d-4c8e-9b7a-2d5e8f0a1c34","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too big","summary":"Per page too big","id":"paths/~1contacts~1{contact_id}~1companies/get/responses/400/content/application~1json/examples/Per page too big"},"paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"565a4f38-5fa9-451d-bcf0-32076f79517f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"32c856ba-901b-49c4-8e8d-d43fc3ee6ea5","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6762f0a01bb69f9f2193bb44","app_id":"this_is_an_id205_that_should_be_at_least_","name":"company8","remote_created_at":1734537376,"created_at":1734537376,"updated_at":1734537377,"monthly_spend":0,"session_count":0,"user_count":0,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"plan":{},"custom_attributes":{},"notes":{"type":"note.list","data":[],"url":"/companies/6762f0a01bb69f9f2193bb44/notes","total_count":0,"has_more":false}},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9bc1e0cc-5cc4-412d-8037-57e073375ab0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"11900fce-9e5c-5d21-84d5-5bcf188287fd","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"dcfc3465-8a51-4d78-b24c-2f215d48f339","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"b5a1f332-1bf1-44bd-a068-2634244b6051","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","company_ids":["acme-corp","1234"],"pages":{"type":"pages","next":null,"page":1,"per_page":50,"total_pages":1},"total_count":2},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies":{"value":{"type":"list","company_ids":[],"pages":{"type":"pages","next":null,"page":1,"per_page":50,"total_pages":0},"total_count":0},"key":"No granted companies","summary":"No granted companies","id":"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/200/content/application~1json/examples/No granted companies"},"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"32c856ba-901b-49c4-8e8d-d43fc3ee6ea5","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1contacts~1{contact_id}~1granted_companies/get/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company":{"value":{"company_ids":["acme-corp","1234","globex"]},"key":"add_a_company","summary":"Add a company, keeping the existing grants","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/add_a_company"},"paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop":{"value":{"company_ids":["globex"]},"key":"replace_and_drop","summary":"Replace the set, dropping the ids left out","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/replace_and_drop"},"paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all":{"value":{"company_ids":[]},"key":"drop_all","summary":"Drop every grant","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/requestBody/content/application~1json/examples/drop_all"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","company_ids":["acme-corp","1234","globex"],"pages":null,"total_count":3},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants":{"value":{"type":"list","company_ids":[],"pages":null,"total_count":0},"key":"Dropped all grants","summary":"Dropped all grants","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/200/content/application~1json/examples/Dropped all grants"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified":{"value":{"type":"error.list","request_id":"8879ee29-ade4-4b5a-a275-ab1ac531b82a","errors":[{"code":"parameter_not_found","message":"company_ids not specified"}]},"key":"Company Ids Not Specified","summary":"Company Ids Not Specified","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not Specified"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List":{"value":{"type":"error.list","request_id":"9a3d0816-9707-4598-977e-c009ba630148","errors":[{"code":"parameter_invalid","message":"company_ids must be a list of company ids"}]},"key":"Company Ids Not A List","summary":"Company Ids Not A List","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Company Ids Not A List"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded":{"value":{"type":"error.list","request_id":"4c1d0a5f-2b8e-4f7a-9c31-6d2e8a4b5f10","errors":[{"code":"granted_company_limit_exceeded","message":"A contact can be granted at most 100 companies"}]},"key":"Granted Company Limit Exceeded","summary":"Granted Company Limit Exceeded","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/400/content/application~1json/examples/Granted Company Limit Exceeded"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"981799ea-f19b-432d-828c-491a3b29ad29","errors":[{"code":"company_not_found","message":"Company Not Found: globex"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"b5a1f332-1bf1-44bd-a068-2634244b6051","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled":{"value":{"type":"error.list","request_id":"7e2c4a19-3f5b-4d81-b0a6-9c8e1f2d3a4b","errors":[{"code":"granted_companies_not_enabled","message":"Granted companies are not enabled for this workspace"}]},"key":"Granted Companies Not Enabled","summary":"Granted Companies Not Enabled","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/404/content/application~1json/examples/Granted Companies Not Enabled"},"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"type":"error.list","request_id":"2f8b6c30-5a4d-41e9-8b7c-0d1e2f3a4b5c","errors":[{"code":"server_unavailable_error","message":"Could not read 1 of the requested companies, please retry"}]},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1contacts~1{contact_id}~1granted_companies/put/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted":{"value":{"type":"error.list","request_id":"dcfc3465-8a51-4d78-b24c-2f215d48f339","errors":[{"code":"company_not_found","message":"Company Not Granted: acme-corp"}]},"key":"Company Not Granted","summary":"Company Not Granted","id":"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Granted"},"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"981799ea-f19b-432d-828c-491a3b29ad29","errors":[{"code":"company_not_found","message":"Company Not Found: acme-corp"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"b5a1f332-1bf1-44bd-a068-2634244b6051","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled":{"value":{"type":"error.list","request_id":"7e2c4a19-3f5b-4d81-b0a6-9c8e1f2d3a4b","errors":[{"code":"granted_companies_not_enabled","message":"Granted companies are not enabled for this workspace"}]},"key":"Granted Companies Not Enabled","summary":"Granted Companies Not Enabled","id":"paths/~1contacts~1{contact_id}~1granted_companies~1{company_id}/delete/responses/404/content/application~1json/examples/Granted Companies Not Enabled"},"paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"note","id":"26","created_at":1733932587,"contact":{"type":"contact","id":"6762f0ab1bb69f9f2193bb60"},"author":{"type":"admin","id":"991267581","name":"Ciaran122 Lee","email":"admin122@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>This is a note.</p>"},{"type":"note","id":"25","created_at":1733846187,"contact":{"type":"contact","id":"6762f0ab1bb69f9f2193bb60"},"author":{"type":"admin","id":"991267581","name":"Ciaran122 Lee","email":"admin122@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>This is a note.</p>"},{"type":"note","id":"24","created_at":1733846187,"contact":{"type":"contact","id":"6762f0ab1bb69f9f2193bb60"},"author":{"type":"admin","id":"991267581","name":"Ciaran122 Lee","email":"admin122@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>This is a note.</p>"}],"total_count":3,"pages":{"type":"pages","next":null,"page":1,"per_page":50,"total_pages":1}},"key":"Successful response","summary":"Successful response","id":"paths/~1contacts~1{contact_id}~1notes/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big":{"value":{"type":"error.list","request_id":"6f3b2d41-7ce9-4a05-91d8-2b74e0c6a93f","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Page size too big","summary":"Page size too big","id":"paths/~1contacts~1{contact_id}~1notes/get/responses/400/content/application~1json/examples/Page size too big"},"paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"3a7d90c5-14e6-4b28-bf03-85c1d6e742ab","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"9b5e41a7-0d38-4c6f-a920-7e3f85b14c6d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1notes/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"57055cde-3d0d-4c67-b5c9-b20b80340bf0","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response":{"value":{"admin_id":"991267583","body":"Hello"},"key":"successful_response","summary":"Successful response","id":"paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/successful_response"},"paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found":{"value":{"admin_id":"123","body":"Hello"},"key":"admin_not_found","summary":"Admin not found","id":"paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found":{"value":{"admin_id":"991267585","body":"Hello"},"key":"contact_not_found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"},"paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"note","id":"31","created_at":1734537390,"contact":{"type":"contact","id":"6762f0ad1bb69f9f2193bb62"},"author":{"type":"admin","id":"991267583","name":"Ciaran124 Lee","email":"admin124@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>Hello</p>"},"key":"Successful response","summary":"Successful response","id":"paths/~1contacts~1{contact_id}~1notes/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing":{"value":{"type":"error.list","request_id":"c40d9e58-1b76-4f23-85a0-7d6c2e914bf3","errors":[{"code":"parameter_invalid","message":"Body can't be nil"}]},"key":"Body missing","summary":"Body missing","id":"paths/~1contacts~1{contact_id}~1notes/post/responses/400/content/application~1json/examples/Body missing"},"paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1e68b70f-9c3d-4a51-b48e-20d9f7c536a1","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"74c0a9e3-5d81-4b62-9f07-e3a5861d2c4b","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1notes/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"168f1bc3-d198-4797-8422-9f93fe8af5ad","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Admin not found"},"paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"6f372239-0259-428f-9943-91b8f7a92162","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"segment","id":"6762f0b21bb69f9f2193bb65","name":"segment","created_at":1734537394,"updated_at":1734537394,"person_type":"user"}]},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1segments/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"0273c219-51b7-4938-95d2-19996b2e2734","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"ca383411-d6ac-5db4-9c4d-352b36f69c8d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"61c119c7-b2f0-4158-8457-fd53e83f936a","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1segments/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"type":"subscription","id":"91","state":"live","consent_type":"opt_out","default_translation":{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"},"translations":[{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"}],"content_types":["email"]},{"type":"subscription","id":"93","state":"live","consent_type":"opt_in","default_translation":{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"},"translations":[{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"}],"content_types":["sms_message"]}]},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1subscriptions/get/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7323b97b-9ba4-4c54-946c-38cecea65b3c","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"c9b793ad-ff39-436c-80c9-db6f24d0d444","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1subscriptions/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful":{"value":{"id":106,"consent_type":"opt_in"},"key":"successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found":{"value":{"id":110,"consent_type":"opt_in"},"key":"contact_not_found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/contact_not_found"},"paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found":{"value":{"id":"invalid_id","consent_type":"opt_in"},"key":"resource_not_found","summary":"Resource not found","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/requestBody/content/application~1json/examples/resource_not_found"},"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful":{"value":{"type":"subscription","id":"106","state":"live","consent_type":"opt_in","default_translation":{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"},"translations":[{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"}],"content_types":["sms_message"]},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f615465d-fd5f-4d68-8498-389130b897e4","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"82051728-b8a8-5bfd-9f10-71f9a1dc3107","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"0c2871af-abed-4bce-a5c5-77efbe721711","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found":{"value":{"type":"error.list","request_id":"2774db46-34d9-4925-a24d-8203d4a39f65","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1contacts~1{contact_id}~1subscriptions/post/responses/404/content/application~1json/examples/Resource not found"},"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful":{"value":{"type":"subscription","id":"122","state":"live","consent_type":"opt_in","default_translation":{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"},"translations":[{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"}],"content_types":["sms_message"]},"key":"Successful","summary":"Successful","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c7de741d-dc8f-49b1-8cbe-791668ade76c","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"9c562afa-93d0-53d2-bfa4-bb6463fa84ee","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"82b37940-b43f-46ee-a492-11543a317c97","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"type":"error.list","request_id":"c18422ca-5454-42af-9e1d-dd92066e6e9d","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"tag","id":"80","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}}]},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1tags/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ca3c5e6e-c743-428b-aa8a-ac371a50cc39","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1tags/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1tags/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"81"},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found":{"value":{"id":"82"},"key":"contact_not_found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/contact_not_found"},"paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found":{"value":{"id":"123"},"key":"tag_not_found","summary":"Tag not found","id":"paths/~1contacts~1{contact_id}~1tags/post/requestBody/content/application~1json/examples/tag_not_found"},"paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"81","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1tags/post/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9b1c9966-caeb-485a-8419-d707fd472c63","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"42e197b1-6bc2-5504-915d-97e9e59f6c28","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"f22a7847-ee33-449f-80c0-707efd295a53","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1contacts~1{contact_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"},"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"84","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"491beaa4-a452-4940-85e0-498c0ca5528d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"c6d0888c-4330-545c-8476-656828fed13d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"b3d41080-5b35-42b8-8584-31e4660d355f","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"02871f7a-860e-433a-8545-6a73fbbe5e22","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1contacts~1{contact_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1contacts~1deleted/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"contact","id":"5ba682d23d7cf92bef87bfd4","external_id":"70","email":"joe@example.com","role":"user","status":"archived","updated_at":1756636800},{"type":"contact","id":"5ba682d23d7cf92bef87bfd5","external_id":"71","email":"jane@example.com","role":"user","status":"merged","merged_into_id":"5ba682d23d7cf92bef87bfd9","updated_at":1756636800},{"type":"contact","id":"5ba682d23d7cf92bef87bfd6","external_id":null,"email":null,"role":"user","status":"permanently_deleted","updated_at":1756636800}],"total_count":3,"pages":{"type":"pages","page":1,"per_page":10,"total_pages":1}},"key":"successful","summary":"successful","id":"paths/~1contacts~1deleted/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":"6a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d","errors":[{"code":"invalid_page","message":"page must be a positive integer"}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Bad Request"},"paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"7b2c3d4e-5f6a-4b8c-9d0e-1f2a3b4c5d6e","errors":[{"code":"invalid_per_page","message":"per_page must be a positive integer"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1contacts~1deleted/get/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"4cd97183-4b6b-5eb9-a020-439cc6964338","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1deleted/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"email":"joebloggs@intercom.io","name":"joe bloggs"},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance":{"value":{"custom_attributes":{"order":["21"]}},"key":"update_a_contact_with_an_association_to_a_custom_object_instance","summary":"update a contact with an association to a custom object instance","id":"paths/~1contacts~1{contact_id}/put/requestBody/content/application~1json/examples/update_a_contact_with_an_association_to_a_custom_object_instance"},"paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful":{"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","email_domain":"intercom.io","email_verified":false,"phone":null,"name":"joe bloggs","avatar":null,"owner_id":null,"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":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"custom_attributes":{},"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":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/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","email_domain":"intercom.io","email_verified":false,"phone":null,"name":"joe bloggs","avatar":null,"owner_id":null,"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":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"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","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":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"update a contact with an association to a custom object instance","summary":"update a contact with an association to a custom object instance","id":"paths/~1contacts~1{contact_id}/put/responses/200/content/application~1json/examples/update a contact with an association to a custom object instance"},"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp":{"value":{"type":"error.list","request_id":"2d0c4b6e-8f1a-4c3d-9e5b-7a6f8d9c0b1e","errors":[{"code":"parameter_invalid","message":"'signed_up_at' appears to be in milliseconds. Timestamps must be Unix timestamps in seconds."}]},"key":"Invalid timestamp","summary":"Invalid timestamp","id":"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid timestamp"},"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate":{"value":{"type":"error.list","request_id":"3e1d5c7f-9a2b-4d4e-8f6c-8b7a9e0d1c2f","errors":[{"code":"parameter_invalid","message":"The owner specified is not a member of the app"}]},"key":"Owner not a teammate","summary":"Owner not a teammate","id":"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Owner not a teammate"},"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist":{"value":{"type":"error.list","request_id":"4f2e6d8a-0b3c-4e5f-9a7d-9c8b0f1e2d3a","errors":[{"code":"parameter_invalid","message":"Custom attribute 'plan_tier' does not exist"}]},"key":"Custom attribute does not exist","summary":"Custom attribute does not exist","id":"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Custom attribute does not exist"},"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes":{"value":{"type":"error.list","request_id":"5a3f7e9b-1c4d-4f6a-8b8e-0d9c1a2f3e4b","errors":[{"code":"nested_custom_attributes","message":"'custom_attributes' must be an object"}]},"key":"Invalid custom attributes","summary":"Invalid custom attributes","id":"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/Invalid custom attributes"},"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead":{"value":{"type":"error.list","request_id":"8e4c2a6f-3b7d-4e9a-a1c5-6f0d2b8e4a37","errors":[{"code":"client_error","message":"Contact with user role can't be converted to a lead"}]},"key":"User can't become a lead","summary":"User can't become a lead","id":"paths/~1contacts~1{contact_id}/put/responses/400/content/application~1json/examples/User can't become a lead"},"paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"89ce96d9-aae9-4eec-ace2-d68cc4f74879","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"186669b6-de99-567c-91ac-c5d9e513b0a6","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"6b4a8f0c-2d5e-4a7b-9c9f-1e0d2b3a4f5c","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}/put/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email":{"value":{"type":"error.list","request_id":"7c5b9a1d-3e6f-4b8c-8d0a-2f1e3c4b5a6d","errors":[{"code":"parameter_invalid","message":"'email' is not a valid email address."}]},"key":"Invalid email","summary":"Invalid email","id":"paths/~1contacts~1{contact_id}/put/responses/422/content/application~1json/examples/Invalid email"},"paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6762f0d01bb69f9f2193bb7d","workspace_id":"this_is_an_id283_that_should_be_at_least_","external_id":"70","role":"user","email":"joe@bloggs.com","email_domain":"bloggs.com","email_verified":false,"phone":null,"name":"Joe Bloggs","avatar":null,"owner_id":null,"social_profiles":{"type":"list","data":[]},"has_hard_bounced":false,"marked_email_as_spam":false,"unsubscribed_from_emails":false,"created_at":1734537424,"updated_at":1734537424,"signed_up_at":1734537424,"last_seen_at":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"custom_attributes":{},"tags":{"type":"list","data":[],"url":"/contacts/6762f0d01bb69f9f2193bb7d/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6762f0d01bb69f9f2193bb7d/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6762f0d01bb69f9f2193bb7d/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0d01bb69f9f2193bb7d/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0d01bb69f9f2193bb7d/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"45b30bd1-75d2-40cc-bb39-74ac133a2836","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"4beb09b4-d430-59c9-ad44-0708cfbc1825","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"6f4e8d0a-2b5c-4e7f-9a9d-1c0b2f3e4d5a","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}/get/responses/410/content/application~1json/examples/Contact Merged":{"value":{"type":"error.list","request_id":"45b30bd1-75d2-40cc-bb39-74ac133a2836","errors":[{"code":"contact_merged","message":"This contact has been merged. See the 'Link' header for the canonical contact."}]},"key":"Contact Merged","summary":"Contact Merged","id":"paths/~1contacts~1{contact_id}/get/responses/410/content/application~1json/examples/Contact Merged"},"paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a947b2f0-23d3-419d-9ec4-cdd191cea676","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"4631d568-2a95-5889-81c9-f779723578c9","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"8b6a0f2c-4d7e-4a9b-9c1f-3e2d4b5a6f7c","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful":{"value":{"from":"6762f0d51bb69f9f2193bb7f","into":"6762f0d51bb69f9f2193bb80"},"key":"successful","summary":"successful","id":"paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation":{"value":{"from":"6762f0d51bb69f9f2193bb7f","into":"6762f0d51bb69f9f2193bb80","skip_duplicate_validation":true},"key":"skip duplicate validation","summary":"skip duplicate validation","id":"paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/skip duplicate validation"},"paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6762f0d51bb69f9f2193bb80","workspace_id":"this_is_an_id291_that_should_be_at_least_","external_id":"70","role":"user","email":"joe@bloggs.com","email_domain":"bloggs.com","email_verified":false,"phone":null,"name":"Joe Bloggs","avatar":null,"owner_id":null,"social_profiles":{"type":"list","data":[]},"has_hard_bounced":false,"marked_email_as_spam":false,"unsubscribed_from_emails":false,"created_at":1734537429,"updated_at":1734537430,"signed_up_at":1734537429,"last_seen_at":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"custom_attributes":{},"tags":{"type":"list","data":[],"url":"/contacts/6762f0d51bb69f9f2193bb80/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6762f0d51bb69f9f2193bb80/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6762f0d51bb69f9f2193bb80/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0d51bb69f9f2193bb80/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0d51bb69f9f2193bb80/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1merge/post/responses/400/content/application~1json/examples/Not a duplicate":{"value":{"type":"error.list","errors":[{"code":"invalid_merge","message":"Contacts can only be merged when they are duplicates (matching email or phone). Pass skip_duplicate_validation=true to override this check."}]},"key":"Not a duplicate","summary":"Not a duplicate","id":"paths/~1contacts~1merge/post/responses/400/content/application~1json/examples/Not a duplicate"},"paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ff328c7c-6140-48eb-84dd-bb8960b66cd0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"3a3f8861-b1ec-52f1-856e-b1b9bb28275c","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1merge/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"9c7b1a3d-5e8f-4b0c-8d2a-4f3e5c6b7a8d","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1merge/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1merge/post/responses/409/content/application~1json/examples/Merge in progress":{"value":{"type":"error.list","request_id":"0d8c2b4e-6f9a-4c1d-9e3b-5a4f6d7c8b9e","errors":[{"code":"merge_in_progress","message":"Merge already in progress for one of these contacts. Please retry shortly."}]},"key":"Merge in progress","summary":"Merge in progress","id":"paths/~1contacts~1merge/post/responses/409/content/application~1json/examples/Merge in progress"},"paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed":{"value":{"from":"6762f0d51bb69f9f2193bb7f","into":"6762f0d51bb69f9f2193bb80"},"key":"allowed","summary":"successful","id":"paths/~1contacts~1merge~1preview/post/requestBody/content/application~1json/examples/allowed"},"paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/allowed":{"value":{"allowed":true,"summary":{"attribute_changes":{"attributes":[{"field":"name","outcome":"adopted","from_value":"Jo","new_into_value":"Jo"},{"field":"companies","outcome":"merged","from_value":["Beta"],"into_value":["Acme"],"new_into_value":["Acme","Beta"]},{"field":"phone","outcome":"discarded","from_value":"+1555","into_value":"+1999","new_into_value":"+1999"}],"total_count":3},"reassignments":{"conversations":{"from":12,"into":5},"tickets":{"from":2,"into":1},"phone_calls":{"from":1,"into":0},"tags":{"from":3,"into":4},"notes":{"from":2,"into":6}}}},"key":"allowed","summary":"Merge allowed","id":"paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/allowed"},"paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/blocked":{"value":{"allowed":false,"reasons":[{"code":"no_shared_identifier","message":"These contacts don't share a common identifier (email, phone, or external ID), so they aren't recognised as duplicates. Set skip_duplicate_validation to true to preview the merge anyway."}]},"key":"blocked","summary":"Merge not allowed","id":"paths/~1contacts~1merge~1preview/post/responses/200/content/application~1json/examples/blocked"},"paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ff328c7c-6140-48eb-84dd-bb8960b66cd0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"5216a8fb-f031-5110-b19d-30868b50e550","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1merge~1preview/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1merge~1preview/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"1e9d3c5f-7a0b-4d2e-8f4c-6b5a7e8d9c0f","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1merge~1preview/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful":{"value":{"query":{"operator":"AND","value":[{"field":"created_at","operator":">","value":"1306054154"}]},"sort":{"field":"created_at","order":"ascending"},"pagination":{"per_page":5}},"key":"successful","summary":"successful","id":"paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1search/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[],"total_count":0,"pages":{"type":"pages","page":1,"per_page":5,"total_pages":0}},"key":"successful","summary":"successful","id":"paths/~1contacts~1search/post/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order":{"value":{"type":"error.list","request_id":"8d6c1f0a-3b2e-4a17-9c5d-1f0e2a3b4c5d","errors":[{"code":"invalid_sort_order","message":"Invalid sort order 'desc'. Must be one of: ascending, descending"}]},"key":"Invalid sort order","summary":"Invalid sort order","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid field":{"value":{"type":"error.list","request_id":"3a7e2c91-5d4b-4f08-a6c3-9e1b7d2f4a60","errors":[{"code":"invalid_field","message":"custom_attributes.plan_tier is not a valid search field"}]},"key":"Invalid field","summary":"Invalid field","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid field"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid operator":{"value":{"type":"error.list","request_id":"6b2f9d14-8e3a-4c57-b1d0-2a9c5e7f3b81","errors":[{"code":"invalid_operator","message":"email does not support operator: >"}]},"key":"Invalid operator","summary":"Invalid operator","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid operator"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid value":{"value":{"type":"error.list","request_id":"9c4a1e73-2b6d-4e98-a5f2-7d3b8c1e6a24","errors":[{"code":"invalid_value","message":"Number of elements in composite query is greater than 15, please try again with a smaller list"}]},"key":"Invalid value","summary":"Invalid value","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid value"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid query":{"value":{"type":"error.list","request_id":"1d8b5f26-7c3e-4a19-b2e4-5f6a9d0c8b37","errors":[{"code":"invalid_query","message":"Query body must contain a query hash"}]},"key":"Invalid query","summary":"Invalid query","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid query"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Query nested too deeply":{"value":{"type":"error.list","request_id":"4e9c2a58-1f7b-4d36-8a0e-3b5d7c9f1e42","errors":[{"code":"invalid_values","message":"Value depth exceeds 2 items"}]},"key":"Query nested too deeply","summary":"Query nested too deeply","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Query nested too deeply"},"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"7f3d6b09-4a2c-4e85-9b1f-8c0e2d5a7b63","errors":[{"code":"invalid_per_page","message":"per_page must be an integer between 0 and 150"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f0dc95f1-9e46-4e8d-8150-89365c2c5195","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"648d4d57-2aa4-530b-909f-aad2c59197fe","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1search/post/responses/422/content/application~1json/examples/Unsupported date comparison":{"value":{"type":"error.list","request_id":"2c5e8a17-9d3f-4b60-a7c4-1e8f3b6d9a05","errors":[{"code":"data_invalid","message":"Date predicate doesn't support comparison type :ne"}]},"key":"Unsupported date comparison","summary":"Unsupported date comparison","id":"paths/~1contacts~1search/post/responses/422/content/application~1json/examples/Unsupported date comparison"},"paths/~1contacts~1activities/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"contact_activity","id":"1717000000000.0000a1","event_type":"contact.created","contact_id":"6329bd9ffe4e2e91dc5d6a1e","external_id":"user-42","role":"lead","created_at":1717000000},{"type":"contact_activity","id":"1717000100000.0000b2","event_type":"contact.role_updated","contact_id":"6329bd9ffe4e2e91dc5d6a1e","external_id":"user-42","role":"user","created_at":1717000100},{"type":"contact_activity","id":"1717000200000.0000c3","event_type":"contact.merged","contact_id":"6329bd9ffe4e2e91dc5d6a1e","external_id":"user-42","role":"user","merge_source_id":"5f7f0d217c3f2e001a4e8b12","merge_target_id":"6329bd9ffe4e2e91dc5d6a1e","created_at":1717000200},{"type":"contact_activity","id":"1717000300000.0000d4","event_type":"contact.merge_failed","contact_id":"5f7f0d217c3f2e001a4e8b12","merge_source_id":"5f7f0d217c3f2e001a4e8b12","merge_target_id":"6329bd9ffe4e2e91dc5d6a1e","failure_reason":"Merge source_user cannot have role='user_role'","created_at":1717000300},{"type":"contact_activity","id":"1717000400000.0000e5","event_type":"contact.deleted","contact_id":"6329bd9ffe4e2e91dc5d6a1e","role":"user","created_at":1717000400}],"pages":{"type":"pages","per_page":5,"next":{"starting_after":"1717000400000.0000e5"}}},"key":"successful","summary":"successful","id":"paths/~1contacts~1activities/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1activities/get/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"5a1c7e39-6b2d-4f84-9e0a-3c8d1f5b7a26","errors":[{"code":"invalid_per_page","message":"per_page must be a positive integer"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1contacts~1activities/get/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"3aa05fbd-7443-55e1-9b80-7766454b008d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1activities/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[],"total_count":0,"pages":{"type":"pages","page":1,"per_page":10,"total_pages":0}},"key":"successful","summary":"successful","id":"paths/~1contacts/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"0b6e3d82-5f1a-4c97-a2d8-6e9f4b1c3a75","errors":[{"code":"invalid_per_page","message":"per_page must be a positive integer"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after":{"value":{"type":"error.list","request_id":"8e2a4c61-3d7f-4b05-9c1e-5a8b2f6d0e94","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid starting_after","summary":"Invalid starting_after","id":"paths/~1contacts/get/responses/400/content/application~1json/examples/Invalid starting_after"},"paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"e3b9f9b0-51d9-5926-bca5-4f5b6c9a3e5c","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts/post/requestBody/content/application~1json/examples/successful":{"value":{"email":"joebloggs@intercom.io"},"key":"successful","summary":"successful","id":"paths/~1contacts/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6762f0dd1bb69f9f2193bb83","workspace_id":"this_is_an_id303_that_should_be_at_least_","external_id":null,"role":"user","email":"joebloggs@intercom.io","email_domain":"intercom.io","email_verified":false,"phone":null,"name":null,"avatar":null,"owner_id":null,"social_profiles":{"type":"list","data":[]},"has_hard_bounced":false,"marked_email_as_spam":false,"unsubscribed_from_emails":false,"created_at":1734537437,"updated_at":1734537437,"signed_up_at":null,"last_seen_at":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"custom_attributes":{},"tags":{"type":"list","data":[],"url":"/contacts/6762f0dd1bb69f9f2193bb83/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6762f0dd1bb69f9f2193bb83/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6762f0dd1bb69f9f2193bb83/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0dd1bb69f9f2193bb83/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0dd1bb69f9f2193bb83/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1contacts/post/responses/200/content/application~1json/examples/successful"},"paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid timestamp":{"value":{"type":"error.list","request_id":"9d3b7f15-2c8e-4a61-b4d9-0e5f2a7c1b38","errors":[{"code":"parameter_invalid","message":"'signed_up_at' appears to be in milliseconds. Timestamps must be Unix timestamps in seconds."}]},"key":"Invalid timestamp","summary":"Invalid timestamp","id":"paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid timestamp"},"paths/~1contacts/post/responses/400/content/application~1json/examples/Owner not a teammate":{"value":{"type":"error.list","request_id":"1e4c8a26-3d9f-4b72-a5e0-7f6a3b8d2c49","errors":[{"code":"parameter_invalid","message":"The owner specified is not a member of the app"}]},"key":"Owner not a teammate","summary":"Owner not a teammate","id":"paths/~1contacts/post/responses/400/content/application~1json/examples/Owner not a teammate"},"paths/~1contacts/post/responses/400/content/application~1json/examples/Custom attribute does not exist":{"value":{"type":"error.list","request_id":"2f5d9b37-4e0a-4c83-b6f1-8a7b4c9e3d50","errors":[{"code":"parameter_invalid","message":"Custom attribute 'plan_tier' does not exist"}]},"key":"Custom attribute does not exist","summary":"Custom attribute does not exist","id":"paths/~1contacts/post/responses/400/content/application~1json/examples/Custom attribute does not exist"},"paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid custom attributes":{"value":{"type":"error.list","request_id":"3a6e0c48-5f1b-4d94-87a2-9b8c5d0f4e61","errors":[{"code":"nested_custom_attributes","message":"'custom_attributes' must be an object"}]},"key":"Invalid custom attributes","summary":"Invalid custom attributes","id":"paths/~1contacts/post/responses/400/content/application~1json/examples/Invalid custom attributes"},"paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ff2353d3-d3d6-4f20-8268-847869d01e73","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"ae05b405-0bc7-5a7f-b519-0bcb15655216","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts/post/responses/409/content/application~1json/examples/Contact already exists":{"value":{"type":"error.list","request_id":"4b7f1d59-6a2c-4ea5-98b3-0c9d6e1a5f72","errors":[{"code":"conflict","message":"A contact matching those details already exists with id=6762f0dd1bb69f9f2193bb83"}]},"key":"Contact already exists","summary":"Contact already exists","id":"paths/~1contacts/post/responses/409/content/application~1json/examples/Contact already exists"},"paths/~1contacts/post/responses/409/content/application~1json/examples/Archived contact already exists":{"value":{"type":"error.list","request_id":"5c8a2e6a-7b3d-4fb6-89c4-1d0e7f2b6a83","errors":[{"code":"conflict","message":"An archived contact matching those details already exists with id=6762f0dd1bb69f9f2193bb83"}]},"key":"Archived contact already exists","summary":"Archived contact already exists","id":"paths/~1contacts/post/responses/409/content/application~1json/examples/Archived contact already exists"},"paths/~1contacts/post/responses/409/content/application~1json/examples/Multiple matching contacts":{"value":{"type":"error.list","request_id":"2d7b9e41-6c3a-4f08-b5d2-9a1e7c4f0b63","errors":[{"code":"conflict","message":"Multiple contacts matching those details already exists with id= email=joe@example.com"}]},"key":"Multiple matching contacts","summary":"Multiple matching contacts","id":"paths/~1contacts/post/responses/409/content/application~1json/examples/Multiple matching contacts"},"paths/~1contacts/post/responses/409/content/application~1json/examples/Contact created at the same time":{"value":{"type":"error.list","request_id":"6f1a3c8e-9d2b-4a75-8e40-b3c6d1f9a082","errors":[{"code":"conflict","message":"A contact matching those details already exists"}]},"key":"Contact created at the same time","summary":"Contact created at the same time","id":"paths/~1contacts/post/responses/409/content/application~1json/examples/Contact created at the same time"},"paths/~1contacts/post/responses/422/content/application~1json/examples/Invalid email":{"value":{"type":"error.list","request_id":"6d9b3f7b-8c4e-4ac7-9ad5-2e1f8a3c7b94","errors":[{"code":"parameter_invalid","message":"'email' is not a valid email address."}]},"key":"Invalid email","summary":"Invalid email","id":"paths/~1contacts/post/responses/422/content/application~1json/examples/Invalid email"},"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6762f0df1bb69f9f2193bb84","workspace_id":"this_is_an_id307_that_should_be_at_least_","external_id":"70","role":"user","email":"joe@bloggs.com","email_domain":"bloggs.com","email_verified":false,"phone":null,"name":"Joe Bloggs","avatar":null,"owner_id":null,"social_profiles":{"type":"list","data":[]},"has_hard_bounced":false,"marked_email_as_spam":false,"unsubscribed_from_emails":false,"created_at":1734537439,"updated_at":1734537439,"signed_up_at":1734537439,"last_seen_at":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"custom_attributes":{},"tags":{"type":"list","data":[],"url":"/contacts/6762f0df1bb69f9f2193bb84/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6762f0df1bb69f9f2193bb84/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6762f0df1bb69f9f2193bb84/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0df1bb69f9f2193bb84/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f0df1bb69f9f2193bb84/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1fb28be7-cda6-4029-b4da-447ef61cb61a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"c3ae8c73-bd9a-5a00-b68c-fc7c932d59a8","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"7a5f9e1b-3c6d-4f8a-8b0e-2d1c3a4f5e6b","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/410/content/application~1json/examples/Contact Merged":{"value":{"type":"error.list","request_id":"1fb28be7-cda6-4029-b4da-447ef61cb61a","errors":[{"code":"contact_merged","message":"This contact has been merged. See the 'Link' header for the canonical contact."}]},"key":"Contact Merged","summary":"Contact Merged","id":"paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/410/content/application~1json/examples/Contact Merged"},"paths/~1contacts~1{contact_id}~1archive/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1archive/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1archive/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"8d6c0b2e-4f7a-4c9d-9e1b-3a2f4d5c6b7e","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1archive/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Blocked contact":{"value":{"type":"error.list","request_id":"9e7d1c3f-5a8b-4d0e-8f2c-4b3a5e6d7c8f","errors":[{"code":"not_restorable","message":"User has been blocked and is not restorable. See your App blocked user list for more detail."}]},"key":"Blocked contact","summary":"Blocked contact","id":"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Blocked contact"},"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Merged contact":{"value":{"type":"error.list","request_id":"0f8e2d4a-6b9c-4e1f-9a3d-5c4b6f7e8d9a","errors":[{"code":"bad_request","message":"User has been merged and is not restorable."}]},"key":"Merged contact","summary":"Merged contact","id":"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Merged contact"},"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Pending permanent deletion":{"value":{"type":"error.list","request_id":"1a9f3e5b-7c0d-4f2a-8b4e-6d5c7a8f9e0b","errors":[{"code":"bad_request","message":"User has been marked for permanent deletion and is not restorable."}]},"key":"Pending permanent deletion","summary":"Pending permanent deletion","id":"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Pending permanent deletion"},"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Duplicate contact":{"value":{"type":"error.list","request_id":"2b0a4f6c-8d1e-4a3b-9c5f-7e6d8b9a0f1c","errors":[{"code":"unique_user_constraint","message":"This user is archived but cannot be restored because another user exists with this email or user_id."}]},"key":"Duplicate contact","summary":"Duplicate contact","id":"paths/~1contacts~1{contact_id}~1unarchive/post/responses/400/content/application~1json/examples/Duplicate contact"},"paths/~1contacts~1{contact_id}~1unarchive/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1unarchive/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1unarchive/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"3c1b5a7d-9e2f-4b4c-8d6a-8f7e9c0b1a2d","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1unarchive/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"4d2c6b8e-0f3a-4c5d-9e7b-9a8f0d1c2b3e","errors":[{"code":"parameter_invalid","message":"The user 63a07ddf05a32042dffac965 could not be found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Company email address":{"value":{"type":"error.list","request_id":"5e3d7c9f-1a4b-4d6e-8f8c-0b9a1e2d3c4f","errors":[{"code":"parameter_invalid","message":"The user 63a07ddf05a32042dffac965 has a company email address"}]},"key":"Company email address","summary":"Company email address","id":"paths/~1contacts~1{contact_id}~1block/post/responses/400/content/application~1json/examples/Company email address"},"paths/~1contacts~1{contact_id}~1block/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1block/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1merge_histories/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"merge_history","source_contact_id":"5ba682d23d7cf92bef87bfd3","source_contact_role":"lead","merged_at":1571672154}],"next_cursor":"eyJpZCI6IjYyMzQ1NiJ9","has_more":true},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"45b30bd1-75d2-40cc-bb39-74ac133a2836","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"69c5df7c-0c2b-5596-90f6-b3b636ea51c8","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"45b30bd1-75d2-40cc-bb39-74ac133a2836","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact is not a user":{"value":{"type":"error.list","errors":[{"code":"not_found","message":"Not Found"}]},"key":"Contact is not a user","summary":"Contact is not a user","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/404/content/application~1json/examples/Contact is not a user"},"paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Limit is too big"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid per_page"},"paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid cursor":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"must be a valid base64-encoded JSON cursor"}]},"key":"Invalid cursor","summary":"Invalid cursor","id":"paths/~1contacts~1{id}~1merge_histories/get/responses/422/content/application~1json/examples/Invalid cursor"},"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful":{"value":{"contacts":[{"external_id":"abc123","email":"joe@bloggs.com","name":"Joe Bloggs","role":"user","phone":"+353871234567","avatar":"https://www.example.com/avatar_image.jpg","signed_up_at":1571672154,"last_seen_at":1571672154,"owner_id":"321","unsubscribed_from_emails":false,"language_override":"fr","custom_attributes":{"plan":"pro"},"companies":[{"company_id":"6","name":"Blue Sun"}],"tags":{"add":[{"id":"123"}]}}]},"key":"successful","summary":"Successful","id":"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies":{"value":{"contacts":[{"external_id":"abc123","email":"joe@bloggs.com","companies":[{"company_id":"6","name":"Blue Sun"},{"company_id":"7","name":"Weyland-Yutani"}]}]},"key":"with_companies","summary":"Attach companies","id":"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_companies"},"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags":{"value":{"contacts":[{"name":"Contact Name","external_id":"abc123","tags":{"add":[{"id":"123"}]}}]},"key":"with_tags","summary":"Add tags","id":"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/with_tags"},"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job":{"value":{"contacts":[{"external_id":"abc123","email":"joe@bloggs.com","language_override":"de"}],"job":{"id":"job_v2_1"}},"key":"append_to_existing_job","summary":"Append to existing job","id":"paths/~1contacts~1bulk/post/requestBody/content/application~1json/examples/append_to_existing_job"},"paths/~1contacts~1bulk/post/responses/202/content/application~1json/examples/successful":{"value":{"id":"job_v2_2","type":"contacts.bulk.job","state":"running","created_at":1713360000,"updated_at":1713360060,"completed_at":null,"tasks":[{"id":"task_v2_2","item_count":2,"state":"pending","created_at":1713360000,"started_at":null,"completed_at":null}],"url":"https://api.intercom.io/contacts/bulk/job_v2_2"},"key":"successful","summary":"successful","id":"paths/~1contacts~1bulk/post/responses/202/content/application~1json/examples/successful"},"paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"941c4b1b-d76e-5cd5-a1bb-6d69ad1905ed","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1bulk/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1bulk/post/responses/403/content/application~1json/examples/job_closed":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"forbidden","message":"job job_v2_1 is closed for new task updates"}]},"key":"job_closed","summary":"job_closed","id":"paths/~1contacts~1bulk/post/responses/403/content/application~1json/examples/job_closed"},"paths/~1contacts~1bulk/post/responses/404/content/application~1json/examples/job_not_found":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"job_not_found","message":"job job_v2_1 not found"}]},"key":"job_not_found","summary":"job_not_found","id":"paths/~1contacts~1bulk/post/responses/404/content/application~1json/examples/job_not_found"},"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/missing_contacts":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"field_not_found","message":"contacts field must be supplied"}]},"key":"missing_contacts","summary":"missing_contacts","id":"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/missing_contacts"},"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/too_many_contacts":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"parameter_invalid","message":"maximum number of contacts per request is 100"}]},"key":"too_many_contacts","summary":"too_many_contacts","id":"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/too_many_contacts"},"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contacts_not_an_array":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"type_mismatch","message":"contacts must be an array"}]},"key":"contacts_not_an_array","summary":"contacts_not_an_array","id":"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contacts_not_an_array"},"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contact_not_an_object":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"type_mismatch","message":"each contact must be an object"}]},"key":"contact_not_an_object","summary":"contact_not_an_object","id":"paths/~1contacts~1bulk/post/responses/422/content/application~1json/examples/contact_not_an_object"},"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful":{"value":{"contacts":[{"id":"abc123","external_id":"ext123","email":"joe@bloggs.com","name":"Joe Bloggs","phone":"+353871234567","avatar":"https://www.example.com/avatar_image.jpg","owner_id":"321","unsubscribed_from_emails":false,"language_override":"fr","custom_attributes":{"plan":"pro"},"companies":[{"company_id":"6","name":"Blue Sun"}],"tags":{"add":[{"id":"123"}],"remove":[{"id":"987"}]}}]},"key":"successful","summary":"successful","id":"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies":{"value":{"contacts":[{"id":"abc123","companies":[{"company_id":"6","name":"Blue Sun"},{"company_id":"7","remove":true}]}]},"key":"with_companies","summary":"Attach and detach companies","id":"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_companies"},"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags":{"value":{"contacts":[{"id":"abc123","name":"Updated Name","tags":{"add":[{"id":"123"}],"remove":[{"id":"456"}]}}]},"key":"with_tags","summary":"Add and remove tags","id":"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/with_tags"},"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job":{"value":{"contacts":[{"id":"abc123","language_override":"de"}],"job":{"id":"job_v2_1"}},"key":"append_to_existing_job","summary":"Append to existing job","id":"paths/~1contacts~1bulk/put/requestBody/content/application~1json/examples/append_to_existing_job"},"paths/~1contacts~1bulk/put/responses/202/content/application~1json/examples/successful":{"value":{"id":"job_v2_1","type":"contacts.bulk.job","state":"running","created_at":1713360000,"updated_at":1713360060,"completed_at":null,"tasks":[{"id":"task_v2_1","item_count":3,"state":"pending","created_at":1713360000,"started_at":null,"completed_at":null}],"url":"https://api.intercom.io/contacts/bulk/job_v2_1"},"key":"successful","summary":"successful","id":"paths/~1contacts~1bulk/put/responses/202/content/application~1json/examples/successful"},"paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"1a6d2e20-cdad-5c98-a063-26454d9eb71d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1bulk/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1bulk/put/responses/403/content/application~1json/examples/job_closed":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"forbidden","message":"job job_v2_1 is closed for new task updates"}]},"key":"job_closed","summary":"job_closed","id":"paths/~1contacts~1bulk/put/responses/403/content/application~1json/examples/job_closed"},"paths/~1contacts~1bulk/put/responses/404/content/application~1json/examples/job_not_found":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"job_not_found","message":"job job_v2_1 not found"}]},"key":"job_not_found","summary":"job_not_found","id":"paths/~1contacts~1bulk/put/responses/404/content/application~1json/examples/job_not_found"},"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_contacts":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"field_not_found","message":"contacts field must be supplied"}]},"key":"missing_contacts","summary":"missing_contacts","id":"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_contacts"},"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_id":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"field_not_found","message":"contacts must be identified by id"}]},"key":"missing_id","summary":"missing_id","id":"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/missing_id"},"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/too_many_contacts":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"parameter_invalid","message":"maximum number of contacts per request is 100"}]},"key":"too_many_contacts","summary":"too_many_contacts","id":"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/too_many_contacts"},"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contacts_not_an_array":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"type_mismatch","message":"contacts must be an array"}]},"key":"contacts_not_an_array","summary":"contacts_not_an_array","id":"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contacts_not_an_array"},"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contact_not_an_object":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"type_mismatch","message":"each contact must be an object"}]},"key":"contact_not_an_object","summary":"contact_not_an_object","id":"paths/~1contacts~1bulk/put/responses/422/content/application~1json/examples/contact_not_an_object"},"paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful":{"value":{"contacts":[{"id":"abc123"},{"id":"def456"}]},"key":"successful","summary":"Successful","id":"paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job":{"value":{"contacts":[{"id":"abc123"}],"job":{"id":"job_v2_1"}},"key":"append_to_existing_job","summary":"Append to existing job","id":"paths/~1contacts~1bulk~1delete/post/requestBody/content/application~1json/examples/append_to_existing_job"},"paths/~1contacts~1bulk~1delete/post/responses/202/content/application~1json/examples/successful":{"value":{"id":"job_v2_3","type":"contacts.bulk.job","state":"running","created_at":1713360000,"updated_at":1713360060,"completed_at":null,"tasks":[{"id":"task_v2_3","item_count":2,"state":"pending","created_at":1713360000,"started_at":null,"completed_at":null}],"url":"https://api.intercom.io/contacts/bulk/job_v2_3"},"key":"successful","summary":"successful","id":"paths/~1contacts~1bulk~1delete/post/responses/202/content/application~1json/examples/successful"},"paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a4abbb6a-8868-585e-be5b-b068a3dd5fd0","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1bulk~1delete/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1bulk~1delete/post/responses/403/content/application~1json/examples/job_closed":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"forbidden","message":"job job_v2_1 is closed for new task updates"}]},"key":"job_closed","summary":"job_closed","id":"paths/~1contacts~1bulk~1delete/post/responses/403/content/application~1json/examples/job_closed"},"paths/~1contacts~1bulk~1delete/post/responses/404/content/application~1json/examples/job_not_found":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"job_not_found","message":"job job_v2_1 not found"}]},"key":"job_not_found","summary":"job_not_found","id":"paths/~1contacts~1bulk~1delete/post/responses/404/content/application~1json/examples/job_not_found"},"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_contacts":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"field_not_found","message":"contacts field must be supplied"}]},"key":"missing_contacts","summary":"missing_contacts","id":"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_contacts"},"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_id":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"field_not_found","message":"contacts must be identified by id"}]},"key":"missing_id","summary":"missing_id","id":"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/missing_id"},"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/too_many_contacts":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"parameter_invalid","message":"maximum number of contacts per request is 1000"}]},"key":"too_many_contacts","summary":"too_many_contacts","id":"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/too_many_contacts"},"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contacts_not_an_array":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"type_mismatch","message":"contacts must be an array"}]},"key":"contacts_not_an_array","summary":"contacts_not_an_array","id":"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contacts_not_an_array"},"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contact_not_an_object":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"type_mismatch","message":"each contact must be an object"}]},"key":"contact_not_an_object","summary":"contact_not_an_object","id":"paths/~1contacts~1bulk~1delete/post/responses/422/content/application~1json/examples/contact_not_an_object"},"paths/~1contacts~1bulk~1{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"job_v2_1","type":"contacts.bulk.job","state":"completed","created_at":1713360000,"updated_at":1713360120,"completed_at":1713360120,"tasks":[{"id":"task_v2_1","item_count":3,"state":"completed","created_at":1713360000,"started_at":1713360060,"completed_at":1713360120}],"url":"https://api.intercom.io/contacts/bulk/job_v2_1"},"key":"successful","summary":"successful","id":"paths/~1contacts~1bulk~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"e4462db2-6098-589c-b6b4-3f6c6e8f2250","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1contacts~1bulk~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1contacts~1bulk~1{id}/get/responses/404/content/application~1json/examples/Job not found":{"value":{"type":"error.list","request_id":"7e0c4a8d-9d5f-4bd8-8be6-3f2a9b4d8c05","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Job not found","summary":"Job not found","id":"paths/~1contacts~1bulk~1{id}/get/responses/404/content/application~1json/examples/Job not found"},"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish":{"value":{"action":"publish","content_ids":[{"type":"article_content","id":"12345678"},{"type":"article_content","id":"12345679"}]},"key":"publish","summary":"Publish articles","id":"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/publish"},"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish":{"value":{"action":"unpublish","content_ids":[{"type":"article_content","id":"12345678"}]},"key":"unpublish","summary":"Unpublish articles","id":"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/unpublish"},"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete":{"value":{"action":"delete","content_ids":[{"type":"article_content","id":"12345678"},{"type":"internal_article","id":"12345679"},{"type":"content_snippet","id":"12345680"}]},"key":"delete","summary":"Delete content across types","id":"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/delete"},"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability":{"value":{"action":"set_availability","content_ids":[{"type":"article_content","id":"12345678"}],"availability":{"ai_agent":true,"copilot":false}},"key":"set_availability","summary":"Toggle Fin AI Agent on, Copilot off","id":"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_availability"},"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience":{"value":{"action":"set_audience","content_ids":[{"type":"article_content","id":"12345678"}],"audience":{"add_segment_ids":[100],"remove_segment_ids":[200]}},"key":"set_audience","summary":"Add and remove segments","id":"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/set_audience"},"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags":{"value":{"action":"update_tags","content_ids":[{"type":"article","id":"12345678"}],"tags":{"add_tag_ids":[100],"remove_tag_ids":[200]}},"key":"update_tags","summary":"Apply and remove tags on an article","id":"paths/~1content~1bulk_actions/post/requestBody/content/application~1json/examples/update_tags"},"paths/~1content~1bulk_actions/post/responses/202/content/application~1json/examples/Queued":{"value":{"type":"content_bulk_action","status":"queued"},"key":"Queued","summary":"Queued","id":"paths/~1content~1bulk_actions/post/responses/202/content/application~1json/examples/Queued"},"paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content~1search/get/responses/200/content/application~1json/examples/Search successful":{"value":{"type":"list","total_count":5,"pages":{"type":"pages","page":1,"per_page":10,"total_pages":1},"data":[{"type":"content_snippet","id":"123","title":"Billing FAQ"},{"type":"external_content","id":"456","title":"How to reset your password"},{"type":"file_source_content","id":"789","title":"billing-guide.pdf"},{"type":"internal_article","id":"012","title":"Internal SOP: Refunds"},{"type":"article","id":"345","title":"Billing FAQ","contents":[{"type":"article_content","id":"678","title":"Billing FAQ","locale":"en"},{"type":"article_content","id":"910","title":"Facturation FAQ","locale":"fr"}]}]},"key":"Search successful","summary":"Search successful","id":"paths/~1content~1search/get/responses/200/content/application~1json/examples/Search successful"},"paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content~1search/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content~1search/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content~1search/get/responses/422/content/application~1json/examples/Invalid states value":{"value":{"type":"error.list","request_id":"f0c3b8a5-1d62-4e97-a4b1-8c7e2d5a9f30","errors":[{"code":"parameter_invalid","message":"invalid value for states: \"foo\"; must be one of published, draft"}]},"key":"Invalid states value","summary":"Invalid states value","id":"paths/~1content~1search/get/responses/422/content/application~1json/examples/Invalid states value"},"paths/~1content~1search/get/responses/422/content/application~1json/examples/Incomplete folder filter":{"value":{"type":"error.list","request_id":"1a5e7c9d-3b84-4f20-96d1-e2b8a4c6f503","errors":[{"code":"parameter_invalid","message":"folder_ids and folder_entity_type must be provided together"}]},"key":"Incomplete folder filter","summary":"Incomplete folder filter","id":"paths/~1content~1search/get/responses/422/content/application~1json/examples/Incomplete folder filter"},"paths/~1content_snippets/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"content_snippet","id":"123","title":"How to reset your password","locale":"en","json_blocks":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}],"body_markdown":"Navigate to Settings \\> Security \\> Reset password.\n","chatbot_availability":2,"copilot_availability":2,"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_at":1663597223,"updated_at":1663597223,"audience_ids":[1,2]}],"total_count":1,"page":1,"per_page":50,"total_pages":1},"key":"Successful response","summary":"Successful response","id":"paths/~1content_snippets/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1content_snippets/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content_snippets/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet":{"value":{"title":"How to reset your password","json_blocks":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}],"locale":"en","audience_ids":[1,2]},"key":"Create a content snippet","summary":"Create a content snippet","id":"paths/~1content_snippets/post/requestBody/content/application~1json/examples/Create a content snippet"},"paths/~1content_snippets/post/responses/201/content/application~1json/examples/Content snippet created":{"value":{"type":"content_snippet","id":"456","title":"How to reset your password","locale":"en","json_blocks":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}],"body_markdown":"Navigate to Settings \\> Security \\> Reset password.\n","chatbot_availability":2,"copilot_availability":2,"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_at":1663597223,"updated_at":1663597223,"audience_ids":[1,2]},"key":"Content snippet created","summary":"Content snippet created","id":"paths/~1content_snippets/post/responses/201/content/application~1json/examples/Content snippet created"},"paths/~1content_snippets/post/responses/400/content/application~1json/examples/Invalid availability flag":{"value":{"type":"error.list","request_id":"7c1d9e2a-3b4f-4a56-8d70-1e2f3a4b5c6d","errors":[{"code":"parameter_invalid","message":"ai_chatbot_availability must be a boolean"}]},"key":"Invalid availability flag","summary":"Invalid availability flag","id":"paths/~1content_snippets/post/responses/400/content/application~1json/examples/Invalid availability flag"},"paths/~1content_snippets/post/responses/400/content/application~1json/examples/Malformed audience_ids":{"value":{"type":"error.list","request_id":"9a8b7c6d-5e4f-4321-b0a9-8f7e6d5c4b3a","errors":[{"code":"data_invalid","message":"audience_ids must be an array"}]},"key":"Malformed audience_ids","summary":"Malformed audience_ids","id":"paths/~1content_snippets/post/responses/400/content/application~1json/examples/Malformed audience_ids"},"paths/~1content_snippets/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content_snippets/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content_snippets/post/responses/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","request_id":"2b3c4d5e-6f70-4812-93a4-b5c6d7e8f901","errors":[{"code":"parameter_invalid","message":"audience_ids contains unknown audience IDs: 999"}]},"key":"Unknown audience IDs","summary":"Unknown audience IDs","id":"paths/~1content_snippets/post/responses/404/content/application~1json/examples/Unknown audience IDs"},"paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"The language is not currently supported for Fin"}]},"key":"Validation error","summary":"Validation error","id":"paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error"},"paths/~1content_snippets/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided":{"value":{"type":"error.list","request_id":"4d5e6f70-8192-4a3b-8c4d-5e6f708192a3","errors":[{"code":"parameter_invalid","message":"body_markdown and json_blocks are mutually exclusive - please provide only one"}]},"key":"Body and JSON blocks both provided","summary":"Body and JSON blocks both provided","id":"paths/~1content_snippets/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided"},"paths/~1content_snippets~1{id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"content_snippet","id":"123","title":"How to reset your password","locale":"en","json_blocks":[{"type":"paragraph","text":"Navigate to Settings > Security > Reset password."}],"body_markdown":"Navigate to Settings \\> Security \\> Reset password.\n","chatbot_availability":2,"copilot_availability":2,"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_at":1663597223,"updated_at":1663597223,"audience_ids":[1,2]},"key":"Successful response","summary":"Successful response","id":"paths/~1content_snippets~1{id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content_snippets~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content_snippets~1{id}/get/responses/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Content snippet not found"}]},"key":"Content snippet not found","summary":"Content snippet not found","id":"paths/~1content_snippets~1{id}/get/responses/404/content/application~1json/examples/Content snippet not found"},"paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet":{"value":{"title":"How to reset your password (updated)","json_blocks":[{"type":"paragraph","text":"Go to Settings > Security > Reset password and follow the steps."}],"audience_ids":[1,2]},"key":"Update a content snippet","summary":"Update a content snippet","id":"paths/~1content_snippets~1{id}/put/requestBody/content/application~1json/examples/Update a content snippet"},"paths/~1content_snippets~1{id}/put/responses/200/content/application~1json/examples/Content snippet updated":{"value":{"type":"content_snippet","id":"123","title":"How to reset your password (updated)","locale":"en","json_blocks":[{"type":"paragraph","text":"Go to Settings > Security > Reset password and follow the steps."}],"body_markdown":"Go to Settings \\> Security \\> Reset password and follow the steps.\n","chatbot_availability":2,"copilot_availability":2,"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_at":1663597223,"updated_at":1663597300,"audience_ids":[1,2]},"key":"Content snippet updated","summary":"Content snippet updated","id":"paths/~1content_snippets~1{id}/put/responses/200/content/application~1json/examples/Content snippet updated"},"paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Invalid availability flag":{"value":{"type":"error.list","request_id":"6f708192-a3b4-4c5d-9e6f-708192a3b4c5","errors":[{"code":"parameter_invalid","message":"ai_chatbot_availability must be a boolean"}]},"key":"Invalid availability flag","summary":"Invalid availability flag","id":"paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Invalid availability flag"},"paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Malformed audience_ids":{"value":{"type":"error.list","request_id":"8192a3b4-c5d6-4e7f-8091-a2b3c4d5e6f7","errors":[{"code":"data_invalid","message":"audience_ids must be an array"}]},"key":"Malformed audience_ids","summary":"Malformed audience_ids","id":"paths/~1content_snippets~1{id}/put/responses/400/content/application~1json/examples/Malformed audience_ids"},"paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content_snippets~1{id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Content snippet not found"}]},"key":"Content snippet not found","summary":"Content snippet not found","id":"paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Content snippet not found"},"paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","request_id":"a3b4c5d6-e7f8-4091-a2b3-c4d5e6f70819","errors":[{"code":"parameter_invalid","message":"audience_ids contains unknown audience IDs: 999"}]},"key":"Unknown audience IDs","summary":"Unknown audience IDs","id":"paths/~1content_snippets~1{id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"},"paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Title is too long"}]},"key":"Validation error","summary":"Validation error","id":"paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error"},"paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided":{"value":{"type":"error.list","request_id":"c5d6e7f8-0912-4a3b-b4c5-d6e7f8091a2b","errors":[{"code":"parameter_invalid","message":"body_markdown and json_blocks are mutually exclusive - please provide only one"}]},"key":"Body and JSON blocks both provided","summary":"Body and JSON blocks both provided","id":"paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided"},"paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Release live experiment conflict":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"release_live_experiment_conflict","message":"Can't update this snippet while release \"Q3 launch\" is running a live experiment on it. Complete or stop the experiment first."}]},"key":"Release live experiment conflict","summary":"Release live experiment conflict","id":"paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"},"paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1content_snippets~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1content_snippets~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Content snippet not found"}]},"key":"Content snippet not found","summary":"Content snippet not found","id":"paths/~1content_snippets~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found"},"paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"content_has_procedure_dependencies","message":"Content snippet has dependent procedures and cannot be deleted"}]},"key":"Content snippet has procedure dependencies","summary":"Content snippet has procedure dependencies","id":"paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies"},"paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"release_live_experiment_conflict","message":"Can't delete this snippet while release \"Q3 launch\" is running a live experiment on it. Complete or stop the experiment first."}]},"key":"Release live experiment conflict","summary":"Release live experiment conflict","id":"paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"7522907"},"key":"successful","summary":"Apply a tag","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":1663597223,"applied_by":{"type":"admin","id":"1234"}},"key":"Tag applied","summary":"Tag applied","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"content_snippet_not_found","message":"Content snippet not found"}]},"key":"Content snippet not found","summary":"Content snippet not found","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Content snippet not found"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"},"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found":{"value":{"type":"error.list","request_id":"5d1f0c6e-7b7a-4c9d-8f3e-2a4b6c8d0e1f","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Teammate not found","summary":"Teammate not found","id":"paths/~1content_snippets~1{content_snippet_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"},"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":null,"applied_by":null},"key":"Tag removed","summary":"Tag removed","id":"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"},"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"},"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"content_snippet_not_found","message":"Content snippet not found"}]},"key":"Content snippet not found","summary":"Content snippet not found","id":"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Content snippet not found"},"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found":{"value":{"type":"error.list","request_id":"5d1f0c6e-7b7a-4c9d-8f3e-2a4b6c8d0e1f","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Teammate not found","summary":"Teammate not found","id":"paths/~1content_snippets~1{content_snippet_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"},"paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":86,"admin_id":991267618},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found":{"value":{"id":87,"admin_id":991267620},"key":"conversation_not_found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/conversation_not_found"},"paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"86","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1tags/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"617bb25d-4dea-4a68-ae74-2fb8f4e87b39","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found":{"value":{"type":"error.list","request_id":"c6e8c74f-a354-4dfd-a5be-6061d2d26341","errors":[{"code":"not_found","message":"Conversation not found"}]},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1tags/post/responses/404/content/application~1json/examples/Conversation not found"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful":{"value":{"admin_id":991267622},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found":{"value":{"admin_id":991267624},"key":"conversation_not_found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/conversation_not_found"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found":{"value":{"admin_id":991267625},"key":"tag_not_found","summary":"Tag not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"89","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"df73b7b4-2352-44fd-8d14-4ea8536ad138","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found":{"value":{"type":"error.list","request_id":"84db22c5-0fef-465a-a909-2643d8a22c69","errors":[{"code":"not_found","message":"Conversation not found"}]},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Conversation not found"},"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"1fe3e9ec-6a5b-4abc-b51c-a515f77d9577","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1conversations/get/responses/200/content/application~1json/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":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918320","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267628","name":"Ciaran166 Lee","email":"admin166@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f0f31bb69f9f2193bb8b","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"sales_agent_participated":false,"sales_agent":null,"company":null,"external_references":[],"channel":{"initial":"messenger","current":"messenger"}}]},"key":"successful","summary":"successful","id":"paths/~1conversations/get/responses/200/content/application~1json/examples/successful"},"paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"3b6e9d52-7a04-4c81-b5f3-0d8a2e4c1f69","errors":[{"code":"invalid_per_page","message":"per_page must be an integer between 0 and 150"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid starting_after":{"value":{"type":"error.list","request_id":"c9a5e130-6d72-4f48-8b0e-2a7c4d1f5b83","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid starting_after","summary":"Invalid starting_after","id":"paths/~1conversations/get/responses/400/content/application~1json/examples/Invalid starting_after"},"paths/~1conversations/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b14d75ab-7d26-4191-b33f-77ca0a4d4ede","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations/get/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b9","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations/get/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created":{"value":{"from":{"type":"user","id":"6762f11b1bb69f9f2193bba3"},"body":"Hello there"},"key":"conversation_created","summary":"conversation created","id":"paths/~1conversations/post/requestBody/content/application~1json/examples/conversation_created"},"paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found":{"value":{"from":{"type":"user","id":"123_doesnt_exist"},"body":"Hello there"},"key":"contact_not_found","summary":"Contact Not Found","id":"paths/~1conversations/post/requestBody/content/application~1json/examples/contact_not_found"},"paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created":{"value":{"type":"user_message","id":"403918330","created_at":1734537501,"body":"Hello there","message_type":"inapp","conversation_id":"499"},"key":"conversation created","summary":"conversation created","id":"paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"},"paths/~1conversations/post/responses/400/content/application~1json/examples/Sender missing":{"value":{"type":"error.list","request_id":"2a9c6e13-5d70-4b84-8f21-6c3e0a7d9b58","errors":[{"code":"data_invalid","message":"Field 'from' must be an object"}]},"key":"Sender missing","summary":"Sender missing","id":"paths/~1conversations/post/responses/400/content/application~1json/examples/Sender missing"},"paths/~1conversations/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"68e42c33-8220-48ea-906f-75584c3ec440","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"dcf1b373-3e66-4026-a987-98c16f00a908","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations/post/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"d7eb553e-74ae-4341-820b-5d38a94d4a99","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1conversations/post/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1conversations/post/responses/422/content/application~1json/examples/Message too long":{"value":{"type":"error.list","request_id":"f0b4d728-1e63-4a95-b7c0-8d2a5e9c3f16","errors":[{"code":"parameter_invalid","message":"Message is too long. Maximum length is 300000"}]},"key":"Message too long","summary":"Message too long","id":"paths/~1conversations/post/responses/422/content/application~1json/examples/Message too long"},"paths/~1conversations~1{conversation_id}/get/responses/200/content/application~1json/examples/conversation found":{"value":{"type":"conversation","id":"503","created_at":1734537511,"updated_at":1734537511,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918334","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267645","name":"Ciaran176 Lee","email":"admin176@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1261bb69f9f2193bba7","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"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":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"1","part_type":"comment","body":"<p>Okay!</p>","created_at":1663597223,"updated_at":1663597260,"notified_at":1663597260,"assigned_to":null,"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":null,"app_package_code":null,"translations":{"original":"en","en":"<p>Okay!</p>","es":"<p>¡Vale!</p>"}},{"type":"conversation_part","id":"2","part_type":"custom_action_started","body":null,"created_at":1740141842,"updated_at":1740141842,"notified_at":1740141842,"assigned_to":null,"author":{"type":"admin","id":"274","name":"Jamie Oliver","email":"jamie+abcd1234@intercom.io"},"attachments":[],"external_id":null,"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":null,"created_at":1740141851,"updated_at":1740141851,"notified_at":1740141851,"assigned_to":null,"author":{"type":"bot","id":"278","name":"Fin","email":"operator+abcd1234@intercom.io"},"attachments":[],"external_id":null,"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":null,"created_at":1740141857,"updated_at":1740141857,"notified_at":1740141857,"assigned_to":null,"author":{"type":"admin","id":"274","name":"Jamie Oliver","email":"jamie+abcd1234@intercom.io"},"attachments":[],"external_id":null,"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}},"key":"conversation found","summary":"conversation found","id":"paths/~1conversations~1{conversation_id}/get/responses/200/content/application~1json/examples/conversation found"},"paths/~1conversations~1{conversation_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1350c241-0f22-48ca-bab9-169080340870","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}/get/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"8b3deed3-fd8b-43d6-b6a8-428c9e17aabb","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}/get/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{conversation_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"8c288c4f-b699-4209-9de4-064398f02785","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found":{"value":{"read":true,"title":"new conversation title","custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"conversation_found","summary":"conversation found","id":"paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/conversation_found"},"paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance":{"value":{"custom_attributes":{"order":["21"]}},"key":"update_a_conversation_with_an_association_to_a_custom_object_instance","summary":"update a conversation with an association to a custom object instance","id":"paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/update_a_conversation_with_an_association_to_a_custom_object_instance"},"paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found":{"value":{"read":true,"title":"new conversation title","custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}/put/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found":{"value":{"type":"conversation","id":"507","created_at":1734537521,"updated_at":1734537523,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918338","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267653","name":"Ciaran180 Lee","email":"admin180@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1301bb69f9f2193bbab","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":true,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{"issue_type":"Billing","priority":"High"},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"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":null,"created_at":1734537523,"updated_at":1734537523,"notified_at":1734537523,"assigned_to":null,"author":{"id":"991267654","type":"bot","name":"Fin","email":"operator+this_is_an_id354_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null},{"type":"conversation_part","id":"130","part_type":"conversation_attribute_updated_by_admin","body":null,"created_at":1734537523,"updated_at":1734537523,"notified_at":1734537523,"assigned_to":null,"author":{"id":"991267654","type":"bot","name":"Fin","email":"operator+this_is_an_id354_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":2}},"key":"conversation found","summary":"conversation found","id":"paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/conversation found"},"paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance":{"value":{"type":"conversation","id":"508","created_at":1734537525,"updated_at":1734537525,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918339","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267659","name":"Ciaran185 Lee","email":"admin185@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1341bb69f9f2193bbac","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"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":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[],"total_count":0}},"key":"update a conversation with an association to a custom object instance","summary":"update a conversation with an association to a custom object instance","id":"paths/~1conversations~1{conversation_id}/put/responses/200/content/application~1json/examples/update a conversation with an association to a custom object instance"},"paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"c6a1d739-8e25-4f40-b9c7-2d5e0a3b7f19","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute":{"value":{"type":"error.list","request_id":"83b4e6f0-2d17-4a59-8c36-0e9a1b5d7c42","errors":[{"code":"parameter_invalid","message":"Conversation attribute 'Region' does not exist"}]},"key":"Unknown conversation attribute","summary":"Unknown conversation attribute","id":"paths/~1conversations~1{conversation_id}/put/responses/400/content/application~1json/examples/Unknown conversation attribute"},"paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"de63ddb2-c525-4ebf-ad38-82ed8b44c896","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"34072e07-6b70-4f59-96bf-3106a3563a24","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}/put/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"de1be01d-a0d3-48a6-9ea6-9789931a6887","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{conversation_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"512","object":"conversation","deleted":true},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}/delete/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"44656d97-2081-44b1-b5f7-c14d0bb1b894","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}/delete/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1{conversation_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}/delete/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"7a80b950-b392-499f-85db-ea7c6c424d37","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}/delete/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful":{"value":{"query":{"operator":"AND","value":[{"field":"created_at","operator":">","value":"1306054154"}]},"pagination":{"per_page":5}},"key":"successful","summary":"successful","id":"paths/~1conversations~1search/post/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1search/post/responses/200/content/application~1json/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":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918346","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267691","name":"Ciaran210 Lee","email":"admin210@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f14a1bb69f9f2193bbb3","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"sales_agent_participated":false,"sales_agent":null,"company":null,"external_references":[],"channel":{"initial":"messenger","current":"messenger"}}]},"key":"successful","summary":"successful","id":"paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid query":{"value":{"type":"error.list","request_id":"5e0a9c24-6f18-4d73-a2b5-8c1e3d7f9a60","errors":[{"code":"invalid_query","message":"Invalid query. Ensure 'field', 'operator', 'value' are present for simple queries. Ensure 'operator' and 'value' for composite queries. Ensure query is a JSON object."}]},"key":"Invalid query","summary":"Invalid query","id":"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid query"},"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid operator":{"value":{"type":"error.list","request_id":"a1c7e439-0b52-4f86-9d24-3e6a8c0b5d71","errors":[{"code":"invalid_operator","message":"Composite operators must be of type AND or OR"}]},"key":"Invalid operator","summary":"Invalid operator","id":"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid operator"},"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid field":{"value":{"type":"error.list","request_id":"2f8d6b05-9a31-4c47-b1e8-7d0c5a3e9f36","errors":[{"code":"invalid_field","message":"foo is not a valid search field"}]},"key":"Invalid field","summary":"Invalid field","id":"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid field"},"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"e9b3a728-4d60-4a15-8f7c-1c5e0d2b6a94","errors":[{"code":"invalid_per_page","message":"per_page must be an integer between 0 and 150"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid starting_after":{"value":{"type":"error.list","request_id":"74a0c5d1-8e39-4b62-a9f4-6b2d1e8c3a07","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid starting_after","summary":"Invalid starting_after","id":"paths/~1conversations~1search/post/responses/400/content/application~1json/examples/Invalid starting_after"},"paths/~1conversations~1search/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d0c4f817-3a96-4e25-8b1d-5f7a2c9e0b38","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1search/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6762f1571bb69f9f2193bbbb","body":"Thanks again :)"},"key":"user_reply","summary":"User reply","id":"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_reply"},"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply":{"value":{"message_type":"note","type":"admin","admin_id":"991267696","body":"<html> <body>  <h2>An Unordered HTML List</h2>  <ul>   <li>Coffee</li>   <li>Tea</li>   <li>Milk</li> </ul>    <h2>An Ordered HTML List</h2>  <ol>   <li>Coffee</li>   <li>Tea</li>   <li>Milk</li> </ol>   </body> </html>"},"key":"admin_note_reply","summary":"Admin Reply with a Note","id":"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"},"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/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"}]},"key":"admin_quick_reply_reply","summary":"Admin Reply to send Quick Reply Options","id":"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply"},"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply":{"value":{"message_type":"quick_reply","type":"user","intercom_user_id":"6762f1621bb69f9f2193bbbe","reply_options":[{"text":"Yes","uuid":"a5e1c524-5ddd-4c3e-9328-6bca5d6e3edb"}]},"key":"contact_quick_reply_reply","summary":"User reply with quick reply selection","id":"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/contact_quick_reply_reply"},"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6762f1661bb69f9f2193bbbf","body":"Thanks again :)"},"key":"user_last_conversation_reply","summary":"User last conversation reply","id":"paths/~1conversations~1{conversation_id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User reply":{"value":{"type":"conversation","id":"524","created_at":1734537559,"updated_at":1734537561,"waiting_since":1734537561,"snoozed_until":null,"source":{"type":"conversation","id":"403918349","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267694","name":"Ciaran212 Lee","email":"admin212@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1571bb69f9f2193bbbb","external_id":"70"}]},"first_contact_reply":{"created_at":1734537561,"type":"conversation","url":null},"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"132","part_type":"open","body":"<p>Thanks again :)</p>","created_at":1734537561,"updated_at":1734537561,"notified_at":1734537561,"assigned_to":null,"author":{"id":"6762f1571bb69f9f2193bbbb","type":"user","name":"Joe Bloggs","email":"joe@bloggs.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"User reply","summary":"User reply","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User reply"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply with a Note":{"value":{"type":"conversation","id":"525","created_at":1734537563,"updated_at":1734537565,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918350","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267696","name":"Ciaran213 Lee","email":"admin213@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f15b1bb69f9f2193bbbc","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"133","part_type":"note","body":"<h2>An Unordered HTML List</h2>\n<ul>\n<li>Coffee</li>\n<li>Tea</li>\n<li>Milk</li>\n</ul>\n<h2>An Ordered HTML List</h2>\n<ol>\n<li>Coffee</li>\n<li>Tea</li>\n<li>Milk</li>\n</ol>","created_at":1734537565,"updated_at":1734537565,"notified_at":1734537565,"assigned_to":null,"author":{"id":"991267696","type":"admin","name":"Ciaran213 Lee","email":"admin213@email.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Admin Reply with a Note","summary":"Admin Reply with a Note","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply with a Note"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply to send Quick Reply Options":{"value":{"type":"conversation","id":"526","created_at":1734537567,"updated_at":1734537568,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918351","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267698","name":"Ciaran214 Lee","email":"admin214@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f15e1bb69f9f2193bbbd","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"134","part_type":"quick_reply","body":null,"created_at":1734537568,"updated_at":1734537568,"notified_at":1734537568,"assigned_to":null,"author":{"id":"991267698","type":"admin","name":"Ciaran214 Lee","email":"admin214@email.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Admin Reply to send Quick Reply Options","summary":"Admin Reply to send Quick Reply Options","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/Admin Reply to send Quick Reply Options"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply":{"value":{"type":"conversation","id":"527","created_at":1734537571,"updated_at":1734537572,"waiting_since":1734537572,"snoozed_until":null,"source":{"type":"conversation","id":"403918352","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267700","name":"Ciaran215 Lee","email":"admin215@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1621bb69f9f2193bbbe","external_id":"70"}]},"first_contact_reply":{"created_at":1734537572,"type":"conversation","url":null},"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"135","part_type":"open","body":"<p>Thanks again :)</p>","created_at":1734537572,"updated_at":1734537572,"notified_at":1734537572,"assigned_to":null,"author":{"id":"6762f1621bb69f9f2193bbbe","type":"user","name":"Joe Bloggs","email":"joe@bloggs.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"User last conversation reply","summary":"User last conversation reply","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"b5e90d26-7c14-4a83-8f3b-1d6a2c9e4b70","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Unsupported message type":{"value":{"type":"error.list","request_id":"4c7a1e85-2f90-4d63-a5b8-9e3d0c6f1a27","errors":[{"code":"parameter_invalid","message":"Unsupported message type"}]},"key":"Unsupported message type","summary":"Unsupported message type","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/400/content/application~1json/examples/Unsupported message type"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"50f1e8d1-cf1a-450c-a7b5-87a264076241","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"48ad16d0-525c-40bf-b733-89239feb70e3","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/Admin lacks permission":{"value":{"type":"error.list","request_id":"d3a6f081-5b27-4e94-8c1d-7a0e9b2c4f68","errors":[{"code":"action_forbidden","message":"The admin doesn't have the permissions required to reply to this conversation"}]},"key":"Admin lacks permission","summary":"Admin lacks permission","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/403/content/application~1json/examples/Admin lacks permission"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"06234918-c245-4caa-a2cc-90247983c6ff","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"19e8b3c6-0a74-4f52-b6d1-3c9a5e7d2b04","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/No conversation for the contact":{"value":{"type":"error.list","request_id":"0e5c9a37-4b82-4d16-a3f7-7c1d8b6e2a49","errors":[{"code":"parameter_invalid","message":"No conversation for this user"}]},"key":"No conversation for the contact","summary":"No conversation for the contact","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/No conversation for the contact"},"paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/Message too long":{"value":{"type":"error.list","request_id":"7f2d5a98-1c46-4b03-9e7a-6b8c0d3f5a21","errors":[{"code":"parameter_invalid","message":"Message is too long. Maximum length is 300000"}]},"key":"Message too long","summary":"Message too long","id":"paths/~1conversations~1{conversation_id}~1reply/post/responses/422/content/application~1json/examples/Message too long"},"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation":{"value":{"message_type":"close","type":"admin","admin_id":"991267708","body":"Goodbye :)"},"key":"close_a_conversation","summary":"Close a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation":{"value":{"message_type":"snoozed","admin_id":"991267710","snoozed_until":1734541187},"key":"snooze_a_conversation","summary":"Snooze a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation":{"value":{"message_type":"open","admin_id":"991267712"},"key":"open_a_conversation","summary":"Open a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation":{"value":{"message_type":"assignment","type":"admin","admin_id":"991267715","assignee_id":"991267715"},"key":"assign_a_conversation","summary":"Assign a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found":{"value":{"message_type":"close","type":"admin","admin_id":"991267717","body":"Goodbye :)"},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}~1parts/post/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation":{"value":{"type":"conversation","id":"531","created_at":1734537582,"updated_at":1734537584,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918356","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267708","name":"Ciaran219 Lee","email":"admin219@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f16e1bb69f9f2193bbc2","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"136","part_type":"close","body":"<p>Goodbye :)</p>","created_at":1734537584,"updated_at":1734537584,"notified_at":1734537584,"assigned_to":null,"author":{"id":"991267708","type":"admin","name":"Ciaran219 Lee","email":"admin219@email.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null,"translations":{"original":"en","en":"<p>Goodbye :)</p>","es":"<p>¡Adiós! :)</p>"}}],"total_count":1}},"key":"Close a conversation","summary":"Close a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation":{"value":{"type":"conversation","id":"532","created_at":1734537586,"updated_at":1734537587,"waiting_since":null,"snoozed_until":1734541187,"source":{"type":"conversation","id":"403918357","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267710","name":"Ciaran220 Lee","email":"admin220@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1711bb69f9f2193bbc3","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"snoozed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"137","part_type":"snoozed","body":null,"created_at":1734537587,"updated_at":1734537587,"notified_at":1734537587,"assigned_to":null,"author":{"id":"991267710","type":"admin","name":"Ciaran220 Lee","email":"admin220@email.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Snooze a conversation","summary":"Snooze a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation":{"value":{"type":"conversation","id":"537","created_at":1734537587,"updated_at":1734537601,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918358","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267712","name":"Ciaran221 Lee","email":"admin221@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1781bb69f9f2193bbc8","external_id":"74"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":true,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":"","custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"139","part_type":"open","body":null,"created_at":1734537601,"updated_at":1734537601,"notified_at":1734537601,"assigned_to":null,"author":{"id":"991267712","type":"admin","name":"Ciaran221 Lee","email":"admin221@email.com"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Open a conversation","summary":"Open a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation":{"value":{"type":"conversation","id":"542","created_at":1734537603,"updated_at":1734537605,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918361","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267715","name":"Ciaran223 Lee","email":"admin223@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1831bb69f9f2193bbcc","external_id":"70"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"140","part_type":"assign_and_reopen","body":null,"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":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Assign a conversation","summary":"Assign a conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"b5e90d26-7c14-4a83-8f3b-1d6a2c9e4b70","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Unsupported message type":{"value":{"type":"error.list","request_id":"4c7a1e85-2f90-4d63-a5b8-9e3d0c6f1a27","errors":[{"code":"parameter_invalid","message":"Unsupported message type"}]},"key":"Unsupported message type","summary":"Unsupported message type","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/400/content/application~1json/examples/Unsupported message type"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"623bbbb8-f6fb-45f3-a2e2-4106ff3a4349","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"a57737d0-63a7-42bd-aa65-8380ef828124","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/Admin lacks permission":{"value":{"type":"error.list","request_id":"d3a6f081-5b27-4e94-8c1d-7a0e9b2c4f68","errors":[{"code":"action_forbidden","message":"The admin doesn't have the permissions required to reply to this conversation"}]},"key":"Admin lacks permission","summary":"Admin lacks permission","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/403/content/application~1json/examples/Admin lacks permission"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"e056b3c3-fae3-4a3c-9bcf-836b84efa331","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"19e8b3c6-0a74-4f52-b6d1-3c9a5e7d2b04","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Snooze time not in the future":{"value":{"type":"error.list","request_id":"6d1a8f40-9c37-4e25-b0d8-2f7a4c5e8b93","errors":[{"code":"parameter_invalid","message":"snoozed_until must be in the future"}]},"key":"Snooze time not in the future","summary":"Snooze time not in the future","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Snooze time not in the future"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Already assigned":{"value":{"type":"error.list","request_id":"a8f2c514-3e69-4b07-9d1a-5e0c7b3d6f82","errors":[{"code":"conversation_already_assigned_to_assignee","message":"The conversation is already assigned to the specified assignee"}]},"key":"Already assigned","summary":"Already assigned","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Already assigned"},"paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Message too long":{"value":{"type":"error.list","request_id":"7f2d5a98-1c46-4b03-9e7a-6b8c0d3f5a21","errors":[{"code":"parameter_invalid","message":"Message is too long. Maximum length is 300000"}]},"key":"Message too long","summary":"Message too long","id":"paths/~1conversations~1{conversation_id}~1parts/post/responses/422/content/application~1json/examples/Message too long"},"paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation":{"value":{"admin_id":991267731,"customer":{"intercom_user_id":"6762f19b1bb69f9f2193bbd4"}},"key":"attach_a_contact_to_a_conversation","summary":"Attach a contact to a conversation","id":"paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation"},"paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found":{"value":{"admin_id":991267733,"customer":{"intercom_user_id":"6762f19e1bb69f9f2193bbd5"}},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}~1customers/post/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation":{"value":{"customers":[{"type":"user","id":"6762f19b1bb69f9f2193bbd4"}]},"key":"Attach a contact to a conversation","summary":"Attach a contact to a conversation","id":"paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"},"paths/~1conversations~1{conversation_id}~1customers/post/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"af2cd450-2764-402c-a0e0-cae08a72647b","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}~1customers/post/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1{conversation_id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9dc7c1a0-b818-472c-adf6-3e327f22f541","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"99f72599-ac98-4b1e-af96-808654b6383e","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{conversation_id}~1customers/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"86fd8b2e-7048-4fbd-9fb0-d73085d7210b","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{conversation_id}~1customers/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation":{"value":{"admin_id":991267739},"key":"detach_a_contact_from_a_group_conversation","summary":"Detach a contact from a group conversation","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/detach_a_contact_from_a_group_conversation"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found":{"value":{"admin_id":991267742},"key":"conversation_not_found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/conversation_not_found"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found":{"value":{"admin_id":991267745},"key":"contact_not_found","summary":"Contact not found","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/contact_not_found"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer":{"value":{"admin_id":991267748},"key":"last_customer","summary":"Last customer","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/requestBody/content/application~1json/examples/last_customer"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/200/content/application~1json/examples/Detach a contact from a group conversation":{"value":{"customers":[{"type":"user","id":"6762f1b41bb69f9f2193bbe0"}]},"key":"Detach a contact from a group conversation","summary":"Detach a contact from a group conversation","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/200/content/application~1json/examples/Detach a contact from a group conversation"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"83b5ee5b-1971-4594-a6fd-581ee7c56adb","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"89ef64b2-d1f9-40c3-89e9-d39175d3d647","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"6fe4106b-967a-46ba-b1c9-9996aff6e8c3","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Conversation not found":{"value":{"type":"error.list","request_id":"89835b60-6756-4d2a-b148-26ca0cb49f9f","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Conversation not found"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"ab1b9371-3185-417f-a53a-dcae35892980","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/404/content/application~1json/examples/Contact not found"},"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/422/content/application~1json/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"}]},"key":"Last customer","summary":"Last customer","id":"paths/~1conversations~1{conversation_id}~1customers~1{contact_id}/delete/responses/422/content/application~1json/examples/Last customer"},"paths/~1conversations~1{id}~1handling_events/get/responses/200/content/application~1json/examples/Successful response":{"value":{"handling_events":[{"teammate":{"type":"admin","id":123,"name":"Jane Example","email":"jane@example.com"},"type":"paused","timestamp":"2026-01-09T09:00:00Z","reason":"Paused"},{"teammate":{"type":"admin","id":123,"name":"Jane Example","email":"jane@example.com"},"type":"resumed","timestamp":"2026-01-09T09:10:00Z"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1{id}~1handling_events/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1{id}~1hitl_events/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"hitl_cycle_id":"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80","event_type":"fin_consultation_started","conversation_part_id":"4471002","rule_id":"88","rule_name":"Refunds over $100","created_at":1767225600,"data":{"channel":"email","rule_threshold_percent":60,"confidence_percent":42,"sharp_ask":"How long do refunds take?","ask_rationale":"No article covers refund timelines.","issue_summary":"Customer chasing a refund.","customer_question":"Where is my refund?"}},{"hitl_cycle_id":"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80","event_type":"fin_draft_proposed","conversation_part_id":"4471008","rule_id":"88","rule_name":"Refunds over $100","created_at":1767225600,"data":{"draft":"Refunds are processed within 30 days."}},{"hitl_cycle_id":"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80","event_type":"fin_teammate_input_received","conversation_part_id":null,"rule_id":"88","rule_name":"Refunds over $100","created_at":1767225701,"data":{"round_index":1,"teammate_input":"Tell them 5 business days.","reviewer_admin_id":"4001","regeneration_outcome":"answer"}},{"hitl_cycle_id":"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80","event_type":"fin_draft_revised","conversation_part_id":null,"rule_id":"88","rule_name":"Refunds over $100","created_at":1767225760,"data":{"round_index":1,"revised_draft":"Refunds take 5 business days.","regeneration_outcome":"answer"}},{"hitl_cycle_id":"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80","event_type":"fin_consultation_finished","conversation_part_id":"4471029","rule_id":"88","rule_name":"Refunds over $100","created_at":1767225780,"data":{"outcome":"approved","approved_draft_type":"revised","final_draft":"Refunds take 5 business days.","sent_text":"Refunds take 5 business days.","reviewer_admin_id":"4001","duration_seconds":180,"rounds_count":1,"payload_truncated":false}}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1{id}~1hitl_events/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1{id}~1side_conversations/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"side_conversation.list","side_conversations":[{"side_conversation_id":"456","conversation_parts":[{"type":"conversation_part","id":"789","part_type":"comment","body":"<p>Internal note about this issue</p>","author":{"type":"admin","id":"123","name":"Jane Example","email":"jane@example.com"},"created_at":1663597223,"updated_at":1663597223}],"total_count":1}],"total_count":1,"pages":{"type":"pages","page":1,"per_page":25,"total_pages":1}},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1{id}~1side_conversations/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful":{"value":{"intercom_user_id":"6541f0a2c3d4e5f607182930","rating":4,"remark":"Fast and friendly"},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1rating/post/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"conversation_rating","conversation_id":"215471234567890","rating":4,"remark":"Fast and friendly","created_at":1793664000,"updated_at":1793664120,"customer":{"type":"user","id":"6541f0a2c3d4e5f607182930"},"teammate":{"type":"admin","id":"12345"}},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Resource not available":{"value":{"type":"error.list","request_id":"7a80b950-b392-499f-85db-ea7c6c424d37","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Resource not available","summary":"Resource not available","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Resource not available"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Missing parameter":{"value":{"type":"error.list","request_id":"5f0c2a8e-3d71-4b96-a1e4-9c6b7d2f8e13","errors":[{"code":"parameter_not_found","message":"rating parameter is required"}]},"key":"Missing parameter","summary":"Missing parameter","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Missing parameter"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Invalid parameter type":{"value":{"type":"error.list","request_id":"0e4b9d1c-6a85-4f32-b7d0-2c8e5a1f9b64","errors":[{"code":"parameter_invalid","message":"rating must be a integer"}]},"key":"Invalid parameter type","summary":"Invalid parameter type","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Invalid parameter type"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Rating out of range":{"value":{"type":"error.list","request_id":"c3a1e7f5-82d4-4b09-9e6a-1d5b0f7c2a48","errors":[{"code":"parameter_invalid","message":"rating must be an integer from 1 to 5"}]},"key":"Rating out of range","summary":"Rating out of range","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/400/content/application~1json/examples/Rating out of range"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7d3e1f0a-5b2c-4a96-8c41-0e9f6b2d7a35","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Different contact":{"value":{"type":"error.list","request_id":"9b1c2d3e-4f50-4a61-8b72-c3d4e5f60718","errors":[{"code":"forbidden","message":"The rating request for this conversation was sent to a different contact"}]},"key":"Different contact","summary":"Different contact","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Different contact"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Conversation access restricted":{"value":{"type":"error.list","request_id":"2c8a4e6b-9f1d-4b73-a5e0-6d1c3f8b9a47","errors":[{"code":"token_unauthorized","message":"Not authorized to access this conversation"}]},"key":"Conversation access restricted","summary":"Conversation access restricted","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/403/content/application~1json/examples/Conversation access restricted"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/404/content/application~1json/examples/Conversation not found":{"value":{"type":"error.list","request_id":"4a5b6c7d-8e9f-4a0b-9c1d-2e3f4a5b6c7d","errors":[{"code":"conversation_not_found","message":"Conversation not found"}]},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/404/content/application~1json/examples/Conversation not found"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/No rating request":{"value":{"type":"error.list","request_id":"6e2f8a1b-0c47-4d93-8b5a-7f1e3c9d0a26","errors":[{"code":"rating_request_not_found","message":"No rating request has been sent for this conversation"}]},"key":"No rating request","summary":"No rating request","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/No rating request"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating window closed":{"value":{"type":"error.list","request_id":"1d7c4b9a-5e30-4f68-a2b1-8c0e6d3f7a95","errors":[{"code":"rating_window_closed","message":"The rating window for this conversation has closed"}]},"key":"Rating window closed","summary":"Rating window closed","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating window closed"},"paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating locked":{"value":{"type":"error.list","request_id":"8f3a6c2d-1b94-4e07-9d5c-0a7b2e4f1c63","errors":[{"code":"rating_locked","message":"This rating can no longer be changed because a remark has already been submitted"}]},"key":"Rating locked","summary":"Rating locked","id":"paths/~1conversations~1{conversation_id}~1rating/post/responses/422/content/application~1json/examples/Rating locked"},"paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part":{"value":{"type":"conversation_part","conversation_id":"608","conversation_part_id":"149"},"key":"redact_a_conversation_part","summary":"Redact a conversation part","id":"paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part"},"paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found":{"value":{"type":"conversation_part","conversation_id":"really_123_doesnt_exist","conversation_part_id":"really_123_doesnt_exist"},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1redact/post/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1redact/post/responses/200/content/application~1json/examples/Redact a conversation part":{"value":{"type":"conversation","id":"608","created_at":1734537721,"updated_at":1734537724,"waiting_since":1734537722,"snoozed_until":null,"source":{"type":"conversation","id":"403918391","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267757","name":"Ciaran247 Lee","email":"admin247@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1f81bb69f9f2193bc09","external_id":"70"}]},"first_contact_reply":{"created_at":1734537722,"type":"conversation","url":null},"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":true,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"149","part_type":"open","body":"<p><i>This message was deleted</i></p>","created_at":1734537722,"updated_at":1734537724,"notified_at":1734537722,"assigned_to":null,"author":{"id":"6762f1f81bb69f9f2193bc09","type":"user","name":"Joe Bloggs","email":"joe@bloggs.com"},"attachments":[],"external_id":null,"redacted":true,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Redact a conversation part","summary":"Redact a conversation part","id":"paths/~1conversations~1redact/post/responses/200/content/application~1json/examples/Redact a conversation part"},"paths/~1conversations~1redact/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"4814668f-5d31-4bf7-8f66-b426aac054db","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1redact/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1redact/post/responses/404/content/application~1json/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"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1redact/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation":{"value":{"merge_into_conversation_id":456},"key":"merge_a_conversation","summary":"Merge a conversation","id":"paths/~1conversations~1{id}~1merge/post/requestBody/content/application~1json/examples/merge_a_conversation"},"paths/~1conversations~1{id}~1merge/post/responses/200/content/application~1json/examples/Conversation merged":{"value":{"type":"conversation","id":"456","created_at":1734537559,"updated_at":1734537561,"waiting_since":1734537561,"snoozed_until":null,"source":{"type":"conversation","id":"403918349","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267694","name":"Ciaran212 Lee","email":"admin212@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1571bb69f9f2193bbbb","external_id":"70"}]},"first_contact_reply":{"created_at":1734537561,"type":"conversation","url":null},"admin_assignee_id":0,"team_assignee_id":0,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"none","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"custom_attributes":{},"topics":{},"ticket":null,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"ai_agent":null,"ai_agent_participated":false,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"133","part_type":"merged_primary_conversation","body":null,"created_at":1734537561,"updated_at":1734537561,"notified_at":1734537561,"assigned_to":null,"author":{"id":"991267694","type":"bot","name":"Operator","email":"operator@intercom.io"},"attachments":[],"external_id":null,"redacted":false,"metadata":{},"email_message_metadata":null,"app_package_code":null}],"total_count":1}},"key":"Conversation merged","summary":"Conversation merged","id":"paths/~1conversations~1{id}~1merge/post/responses/200/content/application~1json/examples/Conversation merged"},"paths/~1conversations~1{id}~1merge/post/responses/400/content/application~1json/examples/Bad request":{"value":{"type":"error.list","request_id":"450e0b22-ccc2-40dd-bf54-bc0faaa28f57","errors":[{"code":"parameter_invalid","message":"merge_into_conversation_id must be a valid integer conversation ID"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1conversations~1{id}~1merge/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1conversations~1{id}~1merge/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}~1merge/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}~1merge/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"b4f6c9d3-2345-6789-abcd-ef0123456789","errors":[{"code":"action_forbidden","message":"The admin doesn't have the permissions required to merge conversations"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1conversations~1{id}~1merge/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Primary not found":{"value":{"type":"error.list","request_id":"c5a7d0e4-3456-789a-bcde-f01234567890","errors":[{"code":"merge_failed","message":"Primary conversation not found"}]},"key":"Primary not found","summary":"Primary not found","id":"paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Primary not found"},"paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Already merged":{"value":{"type":"error.list","request_id":"d6b8e1f5-4567-890b-cdef-012345678901","errors":[{"code":"merge_failed","message":"Secondary conversation has already been merged"}]},"key":"Already merged","summary":"Already merged","id":"paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Already merged"},"paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Self-merge":{"value":{"type":"error.list","request_id":"e7c9f2a6-5678-901c-def0-123456789012","errors":[{"code":"merge_failed","message":"Cannot merge a conversation into itself"}]},"key":"Self-merge","summary":"Self-merge","id":"paths/~1conversations~1{id}~1merge/post/responses/422/content/application~1json/examples/Self-merge"},"paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful":{"value":{"ticket_type_id":"53"},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request":{"value":{"ticket_type_id":"54"},"key":"bad_request","summary":"Bad request","id":"paths/~1conversations~1{conversation_id}~1convert/post/requestBody/content/application~1json/examples/bad_request"},"paths/~1conversations~1{conversation_id}~1convert/post/responses/200/content/application~1json/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":"🦁","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":"<p>Comment for message</p>","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},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1convert/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/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"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Side conversation":{"value":{"type":"error.list","request_id":"2c105a05-72f9-4b5d-a01b-4b0c84f6e466","errors":[{"code":"side_conversation","message":"action can not be performed on a side conversation"}]},"key":"Side conversation","summary":"Side conversation","id":"paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Side conversation"},"paths/~1conversations~1deleted/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"conversations.list","total_count":4,"pages":{"type":"pages","next":"https://api.intercom.io/conversations/deleted?per_page=2&order=desc&page=2","page":1,"per_page":2,"total_pages":2},"conversations":[{"type":"conversation","id":"512","metrics_retained":false,"deleted_at":1734537460},{"type":"conversation","id":"513","metrics_retained":true,"deleted_at":1734537400}]},"key":"successful","summary":"successful","id":"paths/~1conversations~1deleted/get/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1deleted/get/responses/400/content/application~1json/examples/Resource not available":{"value":{"type":"error.list","request_id":"7a80b950-b392-499f-85db-ea7c6c424d37","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Resource not available","summary":"Resource not available","id":"paths/~1conversations~1deleted/get/responses/400/content/application~1json/examples/Resource not available"},"paths/~1conversations~1deleted/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1deleted/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1deleted/get/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"58d2b7e4-1f93-4a60-9c05-4e8b3a6d0c17","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1deleted/get/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful":{"value":{"external_id":"contact-1234"},"key":"successful","summary":"successful","id":"paths/~1conversations~1stream~1token/post/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1stream~1token/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"conversation_stream_token","expires_at":1731241200,"stream":{"provider":"ably","url":"main.realtime.ably.net","channel":"conversation_stream:abc123:6710a1b2c3d4e5f6a7b8c9d0","token":"<stream token>"},"links":{"self":{"href":"https://api.intercom.io/conversations/stream/token","method":"POST"},"revoke":{"href":"https://api.intercom.io/conversations/stream/token?external_id=contact-1234","method":"DELETE"}}},"key":"successful","summary":"successful","id":"paths/~1conversations~1stream~1token/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1stream~1token/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7d3e1f0a-5b2c-4a96-8c41-0e9f6b2d7a35","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1stream~1token/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1stream~1token/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2c8a4e6b-9f1d-4b73-a5e0-6d1c3f8b9a47","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1stream~1token/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}~1team_handling_segments/get/responses/200/content/application~1json/examples/Successful response":{"value":{"team_handling_segments":[{"team":{"type":"team","id":"111","name":"Billing"},"started_at":"2026-01-20T13:10:05Z","ended_at":"2026-01-20T13:20:00Z","start_reason":null,"end_reason":"assignment"},{"team":{"type":"team","id":"113","name":"Refunds"},"started_at":"2026-01-20T13:24:30Z","ended_at":"2026-01-20T13:31:44Z","start_reason":null,"end_reason":"close"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1{id}~1team_handling_segments/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1{id}~1team_handling_segments/get/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1conversations~1{id}~1team_handling_segments/get/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1conversations~1attributes/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"conversation_attribute","id":3,"name":"test 2","description":"","data_type":"string","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777473061,"updated_at":1777473061,"admin_id":"16","multiline":false},{"type":"conversation_attribute","id":2,"name":"test list","description":"","data_type":"list","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777472538,"updated_at":1777537799,"admin_id":"16","options":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","label":"1","archived":false},{"id":"b2c3d4e5-f6a7-8901-bcde-f01234567891","label":"2","archived":false},{"id":"c3d4e5f6-a7b8-9012-cdef-012345678912","label":"3","archived":false}]},{"type":"conversation_attribute","id":6,"name":"Ref to Test","description":"","data_type":"relationship","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777547482,"updated_at":1777547482,"admin_id":"16","reference":{"type":"many","object_type_id":"Test_Object"}}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute":{"value":{"name":"api_test_attr","data_type":"string","description":"Created via API test"},"key":"Create string attribute","summary":"Create a string attribute","id":"paths/~1conversations~1attributes/post/requestBody/content/application~1json/examples/Create string attribute"},"paths/~1conversations~1attributes/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":8,"name":"api_test_attr","description":"Created via API test","data_type":"string","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1778239701,"updated_at":1778239701,"admin_id":"16","multiline":false},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type":{"value":{"type":"error.list","request_id":"4be81317-ba5a-455a-a80d-862fe4ad888b","errors":[{"code":"parameter_invalid","message":"data_type 'invalid_type' is not valid. Allowed types: string, integer, list, decimal, boolean, datetime, relationship, files"}]},"key":"Invalid data_type","summary":"Invalid data_type","id":"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type"},"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List without options":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Data type is list but no list options were given"}]},"key":"List without options","summary":"List without options","id":"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List without options"},"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List with too few options":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"options requires a minimum of 2 items for list type attributes"}]},"key":"List with too few options","summary":"List with too few options","id":"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/List with too few options"},"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Relationship without object_type_id":{"value":{"type":"error.list","request_id":"5e2f311a-16ce-4192-a29e-c0ffeed62316","errors":[{"code":"parameter_invalid","message":"reference.object_type_id is required"}]},"key":"Relationship without object_type_id","summary":"Relationship without object_type_id","id":"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Relationship without object_type_id"},"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Name already exists":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"An attribute with that name already exists"}]},"key":"Name already exists","summary":"Name already exists","id":"paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Name already exists"},"paths/~1conversations~1attributes~1{id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":3,"name":"test 2","description":"","data_type":"string","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777473061,"updated_at":1777473061,"admin_id":"16","multiline":false},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes~1{id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes~1{id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"Conversation attribute not found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1attributes~1{id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name":{"value":{"name":"api_test_renamed","description":"Updated via API"},"key":"Update name","summary":"Update name and description","id":"paths/~1conversations~1attributes~1{id}/put/requestBody/content/application~1json/examples/Update name"},"paths/~1conversations~1attributes~1{id}/put/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":8,"name":"api_test_renamed","description":"Updated via API","data_type":"string","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1778239701,"updated_at":1778239718,"admin_id":"16","multiline":false},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes~1{id}/put/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes~1{id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"Conversation attribute not found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1attributes~1{id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Options not allowed on update":{"value":{"type":"error.list","request_id":"5e2f6ef8-16e8-4198-a2a8-c0ffeed95548","errors":[{"code":"parameter_invalid","message":"options is not allowed on update. Use /conversations/attributes/:id/options to manage list options"}]},"key":"Options not allowed on update","summary":"Options not allowed on update","id":"paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Options not allowed on update"},"paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name already exists":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"An attribute with that name already exists"}]},"key":"Name already exists","summary":"Name already exists","id":"paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name already exists"},"paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name too long":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"name exceeds the maximum length of 191 characters"}]},"key":"Name too long","summary":"Name too long","id":"paths/~1conversations~1attributes~1{id}/put/responses/422/content/application~1json/examples/Name too long"},"paths/~1conversations~1attributes~1{id}/delete/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":8,"name":"api_test_renamed","description":"Updated via API","data_type":"string","required":false,"visible_to_team_ids":[],"archived":true,"created_at":1778239701,"updated_at":1778239721,"admin_id":"16","multiline":false},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes~1{id}/delete/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes~1{id}/delete/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"Conversation attribute not found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1attributes~1{id}/delete/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1attributes~1{id}/delete/responses/422/content/application~1json/examples/Dependent objects":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"data_invalid","message":"The attribute you are trying to archive has dependent objects"}]},"key":"Dependent objects","summary":"Dependent objects","id":"paths/~1conversations~1attributes~1{id}/delete/responses/422/content/application~1json/examples/Dependent objects"},"paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option":{"value":{"label":"High"},"key":"Add option","summary":"Add a new list option","id":"paths/~1conversations~1attributes~1{id}~1options/post/requestBody/content/application~1json/examples/Add option"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":2,"name":"test list","description":"","data_type":"list","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777472538,"updated_at":1778240000,"admin_id":"16","options":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","label":"1","archived":false},{"id":"b2c3d4e5-f6a7-8901-bcde-f01234567891","label":"2","archived":false},{"id":"c3d4e5f6-a7b8-9012-cdef-012345678912","label":"3","archived":false},{"id":"d4e5f6a7-b8c9-0123-defa-123456789023","label":"High","archived":false}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"Conversation attribute not found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Not a list type":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Options can only be managed on list attributes"}]},"key":"Not a list type","summary":"Not a list type","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Not a list type"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label required":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"label is required"}]},"key":"Label required","summary":"Label required","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label required"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label not a string":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"label must be a string"}]},"key":"Label not a string","summary":"Label not a string","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Label not a string"},"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Unexpected key in body":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"only 'label' is accepted"}]},"key":"Unexpected key in body","summary":"Unexpected key in body","id":"paths/~1conversations~1attributes~1{id}~1options/post/responses/422/content/application~1json/examples/Unexpected key in body"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option":{"value":{"label":"Renamed"},"key":"Rename option","summary":"Rename an existing option","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/requestBody/content/application~1json/examples/Rename option"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":2,"name":"test list","description":"","data_type":"list","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777472538,"updated_at":1778240001,"admin_id":"16","options":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","label":"Renamed","archived":false},{"id":"b2c3d4e5-f6a7-8901-bcde-f01234567891","label":"2","archived":false},{"id":"c3d4e5f6-a7b8-9012-cdef-012345678912","label":"3","archived":false}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Attribute not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"Conversation attribute not found"}]},"key":"Attribute not found","summary":"Attribute not found","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Attribute not found"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Option not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"List option not found"}]},"key":"Option not found","summary":"Option not found","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/404/content/application~1json/examples/Option not found"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Not a list type":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Options can only be managed on list attributes"}]},"key":"Not a list type","summary":"Not a list type","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Not a list type"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label required":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"label is required"}]},"key":"Label required","summary":"Label required","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label required"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label not a string":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"label must be a string"}]},"key":"Label not a string","summary":"Label not a string","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Label not a string"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Unexpected key in body":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"only 'label' is accepted"}]},"key":"Unexpected key in body","summary":"Unexpected key in body","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/put/responses/422/content/application~1json/examples/Unexpected key in body"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"conversation_attribute","id":2,"name":"test list","description":"","data_type":"list","required":false,"visible_to_team_ids":[],"archived":false,"created_at":1777472538,"updated_at":1778240002,"admin_id":"16","options":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","label":"1","archived":true},{"id":"b2c3d4e5-f6a7-8901-bcde-f01234567891","label":"2","archived":false},{"id":"c3d4e5f6-a7b8-9012-cdef-012345678912","label":"3","archived":false}]},"key":"Successful response","summary":"Successful response","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/200/content/application~1json/examples/Successful response"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"310f55b0-2660-43e8-bed4-7e82b2f40920","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Attribute not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"Conversation attribute not found"}]},"key":"Attribute not found","summary":"Attribute not found","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Attribute not found"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Option not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"conversation_attribute_not_found","message":"List option not found"}]},"key":"Option not found","summary":"Option not found","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/404/content/application~1json/examples/Option not found"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Not a list type":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Options can only be managed on list attributes"}]},"key":"Not a list type","summary":"Not a list type","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Not a list type"},"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Minimum options":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"You must have at least 2 options on a list type data attribute"}]},"key":"Minimum options","summary":"Minimum options","id":"paths/~1conversations~1attributes~1{id}~1options~1{option_id}/delete/responses/422/content/application~1json/examples/Minimum options"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful":{"value":{"external_id":"123","external_created_at":1392036272,"external_updated_at":1392036272,"custom_attributes":{"order_number":"ORDER-12345","total_amount":99.99}},"key":"successful","summary":"successful","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/requestBody/content/application~1json/examples/successful"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/200/content/application~1json/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},"key":"successful","summary":"successful","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/200/content/application~1json/examples/successful"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Reserved external_id":{"value":{"type":"error.list","request_id":"3f1a6d2b-9c47-4e58-8a01-6b7d2e4f9c13","errors":[{"code":"bad_request","message":"Invalid external_id value"}]},"key":"Reserved external_id","summary":"Reserved external_id","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Reserved external_id"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Value does not match the attribute type":{"value":{"type":"error.list","request_id":"5c8e4b17-2a6d-49f3-b0e5-71c9a3d82f46","errors":[{"code":"parameter_invalid","message":"Invalid value 'yesterday' for attribute 'ordered_at'"}]},"key":"Value does not match the attribute type","summary":"Value does not match the attribute type","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/400/content/application~1json/examples/Value does not match the attribute type"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/404/content/application~1json/examples/TypeNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object type `undefined` not found"}]},"key":"TypeNotFound","summary":"TypeNotFound","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/post/responses/404/content/application~1json/examples/TypeNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"type":"pages","page":1,"per_page":20,"total_pages":1},"total_count":2,"data":[{"id":"2","type":"Order","custom_attributes":{"order_number":"ORDER-98765","total_amount":149.99},"external_id":"order_002","external_created_at":null,"external_updated_at":null,"created_at":1734537800,"updated_at":1734537800},{"id":"1","type":"Order","custom_attributes":{"order_number":"ORDER-12345","total_amount":99.99},"external_id":"order_001","external_created_at":1734537100,"external_updated_at":1734537100,"created_at":1734537100,"updated_at":1734537100}]},"key":"successful","summary":"successful","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/400/content/application~1json/examples/Both reference filters given":{"value":{"type":"error.list","request_id":"7d2b9e54-6c13-4a87-95f0-2e8b4c71d9a3","errors":[{"code":"bad_request","message":"Cannot provide both references_contact_id and references_conversation_id"}]},"key":"Both reference filters given","summary":"Both reference filters given","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/400/content/application~1json/examples/Both reference filters given"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/404/content/application~1json/examples/TypeNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object type `undefined` not found"}]},"key":"TypeNotFound","summary":"TypeNotFound","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/404/content/application~1json/examples/TypeNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"26","object":"Order","deleted":true},"key":"successful","summary":"successful","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Instance not found":{"value":{"type":"error.list","request_id":"9e4c1a86-3d75-42b9-8c60-5f1a7b93e2d4","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"Instance not found","summary":"Instance not found","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Instance not found"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Type not found":{"value":{"type":"error.list","request_id":"2a7f5c93-8b14-46e0-97d2-3c6e1b85a07f","errors":[{"code":"not_found","message":"Custom object type `undefined` not found"}]},"key":"Type not found","summary":"Type not found","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/Type not found"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"25","type":"Order","custom_attributes":{"order_number":"ORDER-12345","total_amount":99.99},"external_id":"123","external_created_at":null,"external_updated_at":null,"created_at":1734537750,"updated_at":1734537750},"key":"successful","summary":"successful","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/not_found_instance":{"value":{"id":"999999","type":"Order","custom_attributes":{},"external_id":null,"external_created_at":null,"external_updated_at":null,"created_at":null,"updated_at":null,"found":false},"key":"not_found_instance","summary":"Instance not found","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/not_found_instance"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/TypeNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"not_found","message":"Custom object type `undefined` not found"}]},"key":"TypeNotFound","summary":"TypeNotFound","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/TypeNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"26","object":"Order","deleted":true},"key":"successful","summary":"successful","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Instance not found":{"value":{"type":"error.list","request_id":"4b6d8e01-7f29-4c53-a1b8-9d3e5c270f84","errors":[{"code":"not_found","message":"Custom object instance not found"}]},"key":"Instance not found","summary":"Instance not found","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Instance not found"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Type not found":{"value":{"type":"error.list","request_id":"6e9a3c47-1b58-4d02-83f7-c5214a9e6b30","errors":[{"code":"not_found","message":"Custom object type `undefined` not found"}]},"key":"Type not found","summary":"Type not found","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/Type not found"},"paths/~1data_attributes/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"data_attribute","name":"name","full_name":"name","label":"Company name","description":"The name of a company","data_type":"string","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"company_id","full_name":"company_id","label":"Company ID","description":"A number identifying a company","data_type":"string","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"last_request_at","full_name":"last_request_at","label":"Company last seen","description":"The last day anyone from a company visited your site or app","data_type":"date","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"remote_created_at","full_name":"remote_created_at","label":"Company created at","description":"The day a company was added to Intercom","data_type":"date","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"user_count","full_name":"user_count","label":"People","description":"The number of people in a company","data_type":"integer","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"session_count","full_name":"session_count","label":"Company web sessions","description":"All visits from anyone in a company to your product's site or app","data_type":"integer","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"name","full_name":"plan.name","label":"Plan","description":"A specific plan or level within your product that companies have signed up to","data_type":"string","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"monthly_spend","full_name":"monthly_spend","label":"Monthly Spend","description":"The monthly revenue you receive from a company","data_type":"float","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"size","full_name":"size","label":"Company size","description":"The number of people employed in this company, expressed as a single number","data_type":"integer","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"industry","full_name":"industry","label":"Company industry","description":"The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'","data_type":"string","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"website","full_name":"website","label":"Company website","description":"The web address for the company's primary marketing site","data_type":"string","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"id":34,"type":"data_attribute","name":"The One Ring","full_name":"custom_attributes.The One Ring","label":"The One Ring","description":"One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.","data_type":"string","api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":true,"archived":false,"admin_id":"991267784","created_at":1734537753,"updated_at":1734537753,"model":"company"},{"type":"data_attribute","name":"id","full_name":"id","label":"ID","description":"The Intercom defined id representing the company","data_type":"string","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"created_at","full_name":"created_at","label":"Created at","description":"The time the company was added to Intercom","data_type":"date","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"updated_at","full_name":"updated_at","label":"Updated at","description":"The last time the company was updated","data_type":"date","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"id","full_name":"plan.id","label":"Plan ID","description":"The Intercom defined id representing the plan","data_type":"string","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"},{"type":"data_attribute","name":"app_id","full_name":"app_id","label":"App ID","description":"The Intercom defined id representing the app","data_type":"string","api_writable":false,"ui_writable":false,"messenger_writable":true,"custom":false,"archived":false,"model":"company"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1data_attributes/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"6d231766-b44b-4e78-bc9e-9c268ff19671","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_attributes/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"2f0c1e7a-5a3d-43a1-9f61-6b2d1c4e8a90","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_attributes/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_attributes/get/responses/422/content/application~1json/examples/Deprecated conversation model":{"value":{"type":"error.list","request_id":"b7912266-b12e-4d12-b2ce-9cd44d33f0c0","errors":[{"code":"parameter_invalid","message":"model=conversation is no longer supported. Use GET /conversations/attributes instead"}]},"key":"Deprecated conversation model","summary":"Deprecated conversation model","id":"paths/~1data_attributes/get/responses/422/content/application~1json/examples/Deprecated conversation model"},"paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful":{"value":{"name":"Mithril Shirt","model":"company","data_type":"string"},"key":"successful","summary":"Successful","id":"paths/~1data_attributes/post/requestBody/content/application~1json/examples/successful"},"paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists":{"value":{"name":"The One Ring","model":"contact","data_type":"integer"},"key":"same_name_already_exists","summary":"Same name already exists","id":"paths/~1data_attributes/post/requestBody/content/application~1json/examples/same_name_already_exists"},"paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name":{"value":{"name":"!nv@l!d n@me","model":"company","data_type":"string"},"key":"invalid_name","summary":"Invalid name","id":"paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_name"},"paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists":{"value":{"name":"The One Ring","model":"company","data_type":"string"},"key":"attribute_already_exists","summary":"Attribute already exists","id":"paths/~1data_attributes/post/requestBody/content/application~1json/examples/attribute_already_exists"},"paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type":{"value":{"name":"The Second Ring","model":"company","data_type":"mithril"},"key":"invalid_data_type","summary":"Invalid Data Type","id":"paths/~1data_attributes/post/requestBody/content/application~1json/examples/invalid_data_type"},"paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list":{"value":{"description":"Just a plain old ring","options":[{"value":"1-10"}],"archived":false},"key":"too_few_options_for_list","summary":"Too few options for list","id":"paths/~1data_attributes/post/requestBody/content/application~1json/examples/too_few_options_for_list"},"paths/~1data_attributes/post/responses/200/content/application~1json/examples/Successful":{"value":{"id":37,"type":"data_attribute","name":"Mithril Shirt","full_name":"custom_attributes.Mithril Shirt","label":"Mithril Shirt","data_type":"string","api_writable":true,"ui_writable":false,"messenger_writable":false,"custom":true,"archived":false,"admin_id":"991267786","created_at":1734537756,"updated_at":1734537756,"model":"company"},"key":"Successful","summary":"Successful","id":"paths/~1data_attributes/post/responses/200/content/application~1json/examples/Successful"},"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Same name already exists":{"value":{"type":"error.list","request_id":"da2a7037-11f4-4fcc-8d19-27da3b3a4336","errors":[{"code":"parameter_invalid","message":"You already have 'The One Ring' in your company data. To save this as new people data, use a different name."}]},"key":"Same name already exists","summary":"Same name already exists","id":"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Same name already exists"},"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid name":{"value":{"type":"error.list","request_id":"1c45cfd9-ffd1-4e3e-9f7a-2ac99abdf03d","errors":[{"code":"parameter_invalid","message":"Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens"}]},"key":"Invalid name","summary":"Invalid name","id":"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid name"},"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Attribute already exists":{"value":{"type":"error.list","request_id":"55999605-a170-4894-a3d0-090c4fee8d11","errors":[{"code":"parameter_invalid","message":"You already have 'The One Ring' in your company data. To save this as new company data, use a different name."}]},"key":"Attribute already exists","summary":"Attribute already exists","id":"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Attribute already exists"},"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid Data Type":{"value":{"type":"error.list","request_id":"e0a9ccc7-a540-4ef0-8ffc-28ab86658b04","errors":[{"code":"parameter_invalid","message":"Data Type isn't an option"}]},"key":"Invalid Data Type","summary":"Invalid Data Type","id":"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Invalid Data Type"},"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Too few options for list":{"value":{"type":"error.list","request_id":"6544ccf8-435d-49e1-91ed-e49356f14255","errors":[{"code":"parameter_invalid","message":"The Data Attribute model field must be either contact or company"}]},"key":"Too few options for list","summary":"Too few options for list","id":"paths/~1data_attributes/post/responses/400/content/application~1json/examples/Too few options for list"},"paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"fa71b91c-4a25-4fe6-88a9-884f6950860e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_attributes/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"8d0a4f23-0b7e-4c2e-9a68-1d5f3c7b2e41","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_attributes/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_attributes/post/responses/422/content/application~1json/examples/Relationship data type":{"value":{"type":"error.list","request_id":"3a6b9c14-7e52-4d08-b1f3-c8a0e5d27b36","errors":[{"code":"parameter_invalid","message":"Data Type isn't an option"}]},"key":"Relationship data type","summary":"Relationship data type","id":"paths/~1data_attributes/post/responses/422/content/application~1json/examples/Relationship data type"},"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"description":"Just a plain old ring","options":[{"value":"1-10"},{"value":"11-20"}],"archived":false},"key":"successful","summary":"Successful","id":"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list":{"value":{"description":"Too few options","options":{"value":"1-10"},"archived":false},"key":"too_few_options_in_list","summary":"Too few options in list","id":"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/too_few_options_in_list"},"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found":{"value":{"description":"Just a plain old ring","options":[{"value":"1-10"},{"value":"11-20"}],"archived":false},"key":"attribute_not_found","summary":"Attribute Not Found","id":"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/attribute_not_found"},"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object":{"value":{"description":"Trying to archieve","archived":true},"key":"has_dependant_object","summary":"Has Dependant Object","id":"paths/~1data_attributes~1{data_attribute_id}/put/requestBody/content/application~1json/examples/has_dependant_object"},"paths/~1data_attributes~1{data_attribute_id}/put/responses/200/content/application~1json/examples/Successful":{"value":{"id":44,"type":"data_attribute","name":"The One Ring","full_name":"custom_attributes.The One Ring","label":"The One Ring","description":"Just a plain old ring","data_type":"string","options":["1-10","11-20"],"api_writable":true,"ui_writable":false,"messenger_writable":true,"custom":true,"archived":false,"admin_id":"991267793","created_at":1734537762,"updated_at":1734537763,"model":"company"},"key":"Successful","summary":"Successful","id":"paths/~1data_attributes~1{data_attribute_id}/put/responses/200/content/application~1json/examples/Successful"},"paths/~1data_attributes~1{data_attribute_id}/put/responses/400/content/application~1json/examples/Too few options in list":{"value":{"type":"error.list","request_id":"37cff4c5-5e1a-4958-a2ba-149b09d1915c","errors":[{"code":"parameter_invalid","message":"Options isn't an array"}]},"key":"Too few options in list","summary":"Too few options in list","id":"paths/~1data_attributes~1{data_attribute_id}/put/responses/400/content/application~1json/examples/Too few options in list"},"paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c60ce63d-1c74-4fe2-8e21-31d1f817a0c2","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"5c71e2d8-9a04-4b36-8e57-f2b6c3a91d4e","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_attributes~1{data_attribute_id}/put/responses/404/content/application~1json/examples/Attribute Not Found":{"value":{"type":"error.list","request_id":"eee16d31-0b0a-4b5f-b95a-25d37528c80f","errors":[{"code":"field_not_found","message":"We couldn't find that data attribute to update"}]},"key":"Attribute Not Found","summary":"Attribute Not Found","id":"paths/~1data_attributes~1{data_attribute_id}/put/responses/404/content/application~1json/examples/Attribute Not Found"},"paths/~1data_attributes~1{data_attribute_id}/put/responses/422/content/application~1json/examples/Has Dependant Object":{"value":{"type":"error.list","request_id":"f04b6b14-1c5b-46e1-9c95-4a914557062c","errors":[{"code":"data_invalid","message":"The Data Attribute you are trying to archive has a dependant object"}]},"key":"Has Dependant Object","summary":"Has Dependant Object","id":"paths/~1data_attributes~1{data_attribute_id}/put/responses/422/content/application~1json/examples/Has Dependant Object"},"paths/~1data_connectors/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"data_connector","id":"12345","name":"Order Status Service","description":"Fetches order status from external fulfillment API","state":"live","http_method":"post","enforce_auth":true,"direct_fin_usage":false,"created_by_admin_id":"128","updated_by_admin_id":"128","created_at":"2025-11-15T09:30:00Z","updated_at":"2026-01-20T14:22:15Z","execution_results_url":"/data_connectors/12345/execution_results"}],"pages":{"type":"pages","per_page":1,"next":{"starting_after":"WzE3Njg5MTg5MzUuMCwxMjM0NSxudWxsXQ=="}}},"key":"successful","summary":"successful","id":"paths/~1data_connectors/get/responses/200/content/application~1json/examples/successful"},"paths/~1data_connectors/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid cursor","summary":"Invalid cursor","id":"paths/~1data_connectors/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created":{"value":{"name":"Get Order Status","description":"Looks up order status from an external service","http_method":"get","url":"https://api.example.com/orders/{{order_id}}/status","direct_fin_usage":true,"audiences":["leads","visitors"],"headers":[{"name":"Content-Type","value":"application/json"}],"data_inputs":[{"name":"order_id","type":"string","description":"The order ID to look up","required":true,"default_value":""}],"customer_authentication":true,"bypass_authentication":false,"validate_missing_attributes":true},"key":"data_connector_created","summary":"Data connector created","id":"paths/~1data_connectors/post/requestBody/content/application~1json/examples/data_connector_created"},"paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal":{"value":{"name":"My Connector"},"key":"minimal","summary":"Minimal - name only","id":"paths/~1data_connectors/post/requestBody/content/application~1json/examples/minimal"},"paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response":{"value":{"name":"Order Lookup","mock_response":{"order":{"id":12345,"status":"shipped"}}},"key":"with_mock_response","summary":"With mock response","id":"paths/~1data_connectors/post/requestBody/content/application~1json/examples/with_mock_response"},"paths/~1data_connectors/post/responses/201/content/application~1json/examples/Data connector created":{"value":{"type":"data_connector","id":"125","name":"Get Order Status","description":"Looks up order status from an external service","internal_description":"","state":"draft","url":"https://api.example.com/orders/{{order_id}}/status","headers":[{"name":"Content-Type","value":"****"}],"http_method":"get","direct_fin_usage":true,"audiences":["leads","visitors"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":"full_access","client_function_timeout_ms":30000,"data_inputs":[{"name":"order_id","type":"string","description":"The order ID to look up","required":true,"default_value":""}],"response_fields":[],"object_mappings":[],"token_ids":[],"customer_authentication":true,"bypass_authentication":false,"enforce_auth":true,"validate_missing_attributes":true,"created_by_admin_id":"128","updated_by_admin_id":"128","created_at":"2026-03-19T11:27:36Z","updated_at":"2026-03-19T11:27:36Z","execution_results_url":"/data_connectors/125/execution_results"},"key":"Data connector created","summary":"Data connector created","id":"paths/~1data_connectors/post/responses/201/content/application~1json/examples/Data connector created"},"paths/~1data_connectors/post/responses/400/content/application~1json/examples/Unpermitted property in headers":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :description"}]},"key":"Unpermitted property in headers","summary":"Unpermitted property in headers","id":"paths/~1data_connectors/post/responses/400/content/application~1json/examples/Unpermitted property in headers"},"paths/~1data_connectors/post/responses/400/content/application~1json/examples/Audiences is not an array":{"value":{"type":"error.list","request_id":"f1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :audiences"}]},"key":"Audiences is not an array","summary":"Audiences is not an array","id":"paths/~1data_connectors/post/responses/400/content/application~1json/examples/Audiences is not an array"},"paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors/post/responses/422/content/application~1json/examples/Missing name":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"parameter_not_found","message":"Name is required"}]},"key":"Missing name","summary":"Missing name","id":"paths/~1data_connectors/post/responses/422/content/application~1json/examples/Missing name"},"paths/~1data_connectors/post/responses/422/content/application~1json/examples/Invalid audiences":{"value":{"type":"error.list","request_id":"c5b56f3d-8b9e-5g4f-0d2b-3e6f9g8b7c4d","errors":[{"code":"parameter_invalid","message":"Invalid audiences. Must be a subset of: leads, users, visitors"}]},"key":"Invalid audiences","summary":"Invalid audiences","id":"paths/~1data_connectors/post/responses/422/content/application~1json/examples/Invalid audiences"},"paths/~1data_connectors~1{id}/get/responses/200/content/application~1json/examples/Data connector found":{"value":{"type":"data_connector","id":"12345","name":"Order Status Service","description":"Fetches order status from external fulfillment API","state":"live","headers":[],"http_method":"post","direct_fin_usage":false,"audiences":["users","leads"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":"full_access","client_function_timeout_ms":30000,"data_inputs":[{"name":"conversation_id","type":"string","description":"The Intercom conversation ID","required":true,"default_value":""}],"response_fields":[{"path":"status","type":"string","example_value":"ok","redacted":false}],"object_mappings":[],"token_ids":[],"customer_authentication":false,"bypass_authentication":false,"enforce_auth":true,"validate_missing_attributes":true,"created_by_admin_id":"456","updated_by_admin_id":"456","created_at":"2025-11-15T09:30:00Z","updated_at":"2026-01-20T14:22:15Z","execution_results_url":"/data_connectors/12345/execution_results"},"key":"Data connector found","summary":"Data connector found","id":"paths/~1data_connectors~1{id}/get/responses/200/content/application~1json/examples/Data connector found"},"paths/~1data_connectors~1{id}/get/responses/400/content/application~1json/examples/Invalid state_version":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"parameter_invalid","message":"Invalid state_version. Must be one of: draft, live"}]},"key":"Invalid state_version","summary":"Invalid state_version","id":"paths/~1data_connectors~1{id}/get/responses/400/content/application~1json/examples/Invalid state_version"},"paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{id}/get/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{id}/get/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{id}/delete/responses/200/content/application~1json/examples/Data connector deleted":{"value":{"id":"125","object":"data_connector","deleted":true},"key":"Data connector deleted","summary":"Data connector deleted","id":"paths/~1data_connectors~1{id}/delete/responses/200/content/application~1json/examples/Data connector deleted"},"paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{id}/delete/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{id}/delete/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector in use":{"value":{"type":"error.list","request_id":"d6c78e4f-1a2b-3c4d-5e6f-7a8b9c0d1e2f","errors":[{"code":"data_connector_in_use","message":"Data connector is in use by other resources and cannot be deleted"}]},"key":"Data connector in use","summary":"Data connector in use","id":"paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector in use"},"paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector not in draft":{"value":{"type":"error.list","request_id":"e7d89f5g-2b3c-4d5e-6f7g-8a9b0c1d2e3f","errors":[{"code":"conflict","message":"Data connector must be in draft state to be deleted"}]},"key":"Data connector not in draft","summary":"Data connector not in draft","id":"paths/~1data_connectors~1{id}/delete/responses/409/content/application~1json/examples/Data connector not in draft"},"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description":{"value":{"name":"Updated Connector Name","description":"Updated description"},"key":"Update name and description","summary":"Update basic fields","id":"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Update name and description"},"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live":{"value":{"state":"live"},"key":"Set state to live","summary":"Set a connector to live","id":"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to live"},"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft":{"value":{"state":"draft"},"key":"Set state to draft","summary":"Set a connector to draft","id":"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/Set state to draft"},"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response":{"value":{"mock_response":{"user":{"name":"Alice","email":"alice@example.com"}}},"key":"with_mock_response","summary":"Update with mock response","id":"paths/~1data_connectors~1{id}/patch/requestBody/content/application~1json/examples/with_mock_response"},"paths/~1data_connectors~1{id}/patch/responses/200/content/application~1json/examples/Data connector updated":{"value":{"type":"data_connector","id":"12345","name":"Updated Connector Name","description":"Updated description","state":"draft","headers":[],"http_method":"post","direct_fin_usage":false,"audiences":["users","leads"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":"full_access","client_function_timeout_ms":30000,"data_inputs":[{"name":"conversation_id","type":"string","description":"The Intercom conversation ID","required":true,"default_value":""}],"response_fields":[],"object_mappings":[],"token_ids":[],"customer_authentication":false,"bypass_authentication":false,"enforce_auth":true,"validate_missing_attributes":false,"created_by_admin_id":"456","updated_by_admin_id":"456","created_at":"2025-11-15T09:30:00Z","updated_at":"2026-03-24T14:22:15Z","execution_results_url":"/data_connectors/12345/execution_results"},"key":"Data connector updated","summary":"Data connector updated","id":"paths/~1data_connectors~1{id}/patch/responses/200/content/application~1json/examples/Data connector updated"},"paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Unpermitted property in headers":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :description"}]},"key":"Unpermitted property in headers","summary":"Unpermitted property in headers","id":"paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Unpermitted property in headers"},"paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Audiences is not an array":{"value":{"type":"error.list","request_id":"f1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :audiences"}]},"key":"Audiences is not an array","summary":"Audiences is not an array","id":"paths/~1data_connectors~1{id}/patch/responses/400/content/application~1json/examples/Audiences is not an array"},"paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{id}/patch/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"b4a45e2c-7a8d-4f3e-9c1a-2d5e8f7a6b3c","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{id}/patch/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{id}/patch/responses/409/content/application~1json/examples/Data connector in use":{"value":{"type":"error.list","request_id":"d6c78e4f-1a2b-3c4d-5e6f-7a8b9c0d1e2f","errors":[{"code":"data_connector_in_use","message":"Data connector is in use by other resources and cannot be set to draft"}]},"key":"Data connector in use","summary":"Data connector in use","id":"paths/~1data_connectors~1{id}/patch/responses/409/content/application~1json/examples/Data connector in use"},"paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid audiences":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","errors":[{"code":"parameter_invalid","message":"Invalid audiences. Must be a subset of: leads, users, visitors"}]},"key":"Invalid audiences","summary":"Invalid audiences","id":"paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid audiences"},"paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid field value":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","errors":[{"code":"parameter_invalid","message":"Http Method isn't an option"}]},"key":"Invalid field value","summary":"Invalid field value","id":"paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid field value"},"paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid state":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","errors":[{"code":"parameter_invalid","message":"Invalid state. Must be one of: draft, live"}]},"key":"Invalid state","summary":"Invalid state","id":"paths/~1data_connectors~1{id}/patch/responses/422/content/application~1json/examples/Invalid state"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"data_connector.execution","id":"99001","data_connector_id":"12345","success":true,"http_status":200,"http_method":"post","request_url":"https://api.vendor.com/webhook","execution_time_ms":150,"source_type":"workflow","source_id":"5001","conversation_id":"8001","created_at":"2026-02-10T18:15:32Z"},{"type":"data_connector.execution","id":"99000","data_connector_id":"12345","success":false,"http_method":"post","error_type":"3rd_party_error","error_message":"Connection refused","source_type":"inbox","created_at":"2026-02-10T17:45:15Z"}],"pages":{"type":"pages","per_page":2,"next":{"starting_after":"WzE3NzA3NDU1MTUuMCw5OTAwMCxudWxsXQ=="}}},"key":"successful","summary":"successful","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/200/content/application~1json/examples/successful"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid error_type":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_invalid","message":"Invalid error_type. Must be one of: request_configuration_error, faraday_error, 3rd_party_error, response_mapping_error, token_refresh_error, fin_action_response_formatting_error, fin_action_identity_verification_error, email_verification_error, non_fin_standalone_action_identity_verification_error, request_validation_error, client_side_action_error, code_block_transformation_error, otp_preview_not_supported_error"}]},"key":"Invalid error_type","summary":"Invalid error_type","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid error_type"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid timestamp":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_invalid","message":"start_ts must be a Unix timestamp (integer)"}]},"key":"Invalid timestamp","summary":"Invalid timestamp","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid timestamp"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid cursor","summary":"Invalid cursor","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"data_connector.execution","id":"99001","data_connector_id":"12345","success":true,"http_status":200,"http_method":"post","execution_time_ms":150,"source_type":"workflow","source_id":"5001","conversation_id":"8001","created_at":"2026-02-10T18:15:32Z","request_url":"https://api.example.com/webhook","request_body":"{\"channel\": \"#alerts\", \"text\": \"Conversation updated\"}","response_body":"{\"ok\": true}","raw_response_body":"{\"ok\": true}"},"key":"successful","summary":"successful","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Execution result not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"execution_result_not_found","message":"Execution result not found"}]},"key":"Execution result not found","summary":"Execution result not found","id":"paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/404/content/application~1json/examples/Execution result not found"},"paths/~1data_connectors~1{id}~1versions/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"data_connector_version","status":"live","note":"Switched to the v2 orders endpoint","author":{"id":456,"name":"Alice Admin"},"created_at":"2026-09-14T10:02:11Z","entity_version_id":9821,"definition":{"name":"Order Status Service","description":"Fetches order status from external fulfillment API","internal_description":"Fetches order status from external fulfillment API","state":"live","url":"https://api.example.com/v2/orders/{{order_id}}/status","body":"","headers":[{"name":"Authorization","value":"****"}],"http_method":"get","direct_fin_usage":false,"audiences":["users"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":"full_access","client_function_name":null,"client_function_timeout_ms":null,"data_inputs":[{"name":"order_id","type":"string","description":"The order to look up","required":true,"default_value":null}],"response_fields":[{"path":"status","type":"string","example_value":"shipped","redacted":false}],"object_mappings":[],"token_ids":[],"customer_authentication":false,"bypass_authentication":false,"enforce_auth":false,"validate_missing_attributes":false}},{"type":"data_connector_version","status":"previously_live","note":null,"author":{"id":456,"name":"Alice Admin"},"created_at":"2026-08-02T08:40:05Z","entity_version_id":9710,"definition":null}],"pages":{"type":"pages","per_page":20,"next":{"starting_after":"WzQ0MDksNDQwOSxudWxsXQ=="}}},"key":"successful","summary":"successful","id":"paths/~1data_connectors~1{id}~1versions/get/responses/200/content/application~1json/examples/successful"},"paths/~1data_connectors~1{id}~1versions/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"client_error","message":"Invalid starting_after param. Please try again using a starting_after value from a paginated response"}]},"key":"Invalid cursor","summary":"Invalid cursor","id":"paths/~1data_connectors~1{id}~1versions/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{id}~1versions/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{id}~1versions/get/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{id}~1versions/get/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"data_connector_version","status":"live","note":"Switched to the v2 orders endpoint","author":{"id":456,"name":"Alice Admin"},"created_at":"2026-09-14T10:02:11Z","entity_version_id":9821,"definition":{"name":"Order Status Service","description":"Fetches order status from external fulfillment API","internal_description":"Fetches order status from external fulfillment API","state":"live","url":"https://api.example.com/v2/orders/{{order_id}}/status","body":"","headers":[{"name":"Authorization","value":"****"}],"http_method":"get","direct_fin_usage":false,"audiences":["users"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":"full_access","client_function_name":null,"client_function_timeout_ms":null,"data_inputs":[{"name":"order_id","type":"string","description":"The order to look up","required":true,"default_value":null}],"response_fields":[{"path":"status","type":"string","example_value":"shipped","redacted":false}],"object_mappings":[],"token_ids":[],"customer_authentication":false,"bypass_authentication":false,"enforce_auth":false,"validate_missing_attributes":false}},"key":"successful","summary":"successful","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Version not found":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Version not found","summary":"Version not found","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/get/responses/404/content/application~1json/examples/Version not found"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note":{"value":{"note":"Switched to the v2 orders endpoint"},"key":"Set a note","summary":"Annotate a version","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/requestBody/content/application~1json/examples/Set a note"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/200/content/application~1json/examples/successful":{"value":{"type":"data_connector_version","status":"live","note":"Switched to the v2 orders endpoint","author":{"id":456,"name":"Alice Admin"},"created_at":"2026-09-14T10:02:11Z","entity_version_id":9821,"definition":{"name":"Order Status Service","description":"Fetches order status from external fulfillment API","internal_description":"Fetches order status from external fulfillment API","state":"live","url":"https://api.example.com/v2/orders/{{order_id}}/status","body":"","headers":[{"name":"Authorization","value":"****"}],"http_method":"get","direct_fin_usage":false,"audiences":["users"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":"full_access","client_function_name":null,"client_function_timeout_ms":null,"data_inputs":[{"name":"order_id","type":"string","description":"The order to look up","required":true,"default_value":null}],"response_fields":[{"path":"status","type":"string","example_value":"shipped","redacted":false}],"object_mappings":[],"token_ids":[],"customer_authentication":false,"bypass_authentication":false,"enforce_auth":false,"validate_missing_attributes":false}},"key":"successful","summary":"successful","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/200/content/application~1json/examples/successful"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note missing":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_not_found","message":"note parameter is required"}]},"key":"Note missing","summary":"Note missing","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note missing"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note has the wrong type":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"note must be a string"}]},"key":"Note has the wrong type","summary":"Note has the wrong type","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/400/content/application~1json/examples/Note has the wrong type"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Data connector not found":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"data_connector_not_found","message":"Data connector not found"}]},"key":"Data connector not found","summary":"Data connector not found","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Data connector not found"},"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Version not found":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Version not found","summary":"Version not found","id":"paths/~1data_connectors~1{id}~1versions~1{version_id}/patch/responses/404/content/application~1json/examples/Version not found"},"paths/~1events/post/responses/400/content/application~1json/examples/Missing a required field":{"value":{"type":"error.list","request_id":"5d0c8e27-3a91-4f6b-b2d4-7e18c9a06f53","errors":[{"code":"parameter_not_found","message":"missing data parameter"}]},"key":"Missing a required field","summary":"Missing a required field","id":"paths/~1events/post/responses/400/content/application~1json/examples/Missing a required field"},"paths/~1events/post/responses/400/content/application~1json/examples/Null event name":{"value":{"type":"error.list","request_id":"9b1f3c40-5d2a-4e7b-8c16-a3d9e0f51b24","errors":[{"code":"parameter_not_found","message":"missing event_name parameter"}]},"key":"Null event name","summary":"Null event name","id":"paths/~1events/post/responses/400/content/application~1json/examples/Null event name"},"paths/~1events/post/responses/400/content/application~1json/examples/Metadata is not an object":{"value":{"type":"error.list","request_id":"c4e07a19-62b8-4d35-91fa-70e2b6c38d5f","errors":[{"code":"type_mismatch","message":"event metadata must be an object"}]},"key":"Metadata is not an object","summary":"Metadata is not an object","id":"paths/~1events/post/responses/400/content/application~1json/examples/Metadata is not an object"},"paths/~1events/post/responses/400/content/application~1json/examples/Bad type parameter":{"value":{"type":"error.list","request_id":"71d3b8e5-0c46-4a92-bf27-5e8a1d60c93b","errors":[{"code":"parameter_invalid","message":"bad type parameter"}]},"key":"Bad type parameter","summary":"Bad type parameter","id":"paths/~1events/post/responses/400/content/application~1json/examples/Bad type parameter"},"paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"212c8206-e7a6-44c8-8f27-5f0ad7f1d243","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1events/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"0e5a9c62-3b71-4f84-ad19-6c7e2b05f4a8","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1events/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1events/post/responses/404/content/application~1json/examples/User not found":{"value":{"type":"error.list","request_id":"2b8f6d13-47ca-4e09-9d52-f1a63c0e78b5","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"User not found","summary":"User not found","id":"paths/~1events/post/responses/404/content/application~1json/examples/User not found"},"paths/~1events/post/responses/404/content/application~1json/examples/Lead not found":{"value":{"type":"error.list","request_id":"6a2c91e7-8d40-4b15-a3f6-9e0b72d5c814","errors":[{"code":"not_found","message":"Lead Not Found"}]},"key":"Lead not found","summary":"Lead not found","id":"paths/~1events/post/responses/404/content/application~1json/examples/Lead not found"},"paths/~1events/post/responses/422/content/application~1json/examples/Event name too long":{"value":{"type":"error.list","request_id":"4f1e7b03-9c25-4d6a-82be-13a0c5d9e672","errors":[{"code":"parameter_invalid","message":"invalid event name length; use up to 100 characters"}]},"key":"Event name too long","summary":"Event name too long","id":"paths/~1events/post/responses/422/content/application~1json/examples/Event name too long"},"paths/~1events/post/responses/422/content/application~1json/examples/Metadata too long":{"value":{"type":"error.list","request_id":"8c40a5f2-1e69-4730-b8d4-27f5e1c06a93","errors":[{"code":"parameter_invalid","message":"invalid event metadata length; use up to 65535 characters"}]},"key":"Metadata too long","summary":"Metadata too long","id":"paths/~1events/post/responses/422/content/application~1json/examples/Metadata too long"},"paths/~1events/post/responses/422/content/application~1json/examples/Invalid timestamp":{"value":{"type":"error.list","request_id":"d57b2e91-6043-4c8f-a12d-3b9e07f45c68","errors":[{"code":"parameter_invalid","message":"invalid timestamp format; please use seconds since epoch"}]},"key":"Invalid timestamp","summary":"Invalid timestamp","id":"paths/~1events/post/responses/422/content/application~1json/examples/Invalid timestamp"},"paths/~1events/get/responses/200/content/application~1json/examples/Summary (summary=true)":{"value":{"type":"event.summary","events":[],"email":"user26@email.com","intercom_user_id":"6762f22b1bb69f9f2193bc12","user_id":"3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"},"key":"Summary (summary=true)","summary":"Summary (summary=true)","id":"paths/~1events/get/responses/200/content/application~1json/examples/Summary (summary=true)"},"paths/~1events/get/responses/200/content/application~1json/examples/Event list (default)":{"value":{"type":"event.list","events":[{"type":"event","id":"2fc69404-91a6-11e7-be05-4fc6091e296e","created_at":1389913941,"event_name":"invited-friend","user_id":"314159","email":"frodo.baggins@example.com","intercom_user_id":"63a0979a5eeebeaf28dd56ba","metadata":{}}],"pages":{"next":"https://api.intercom.io/events?per_page=1&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user","since":"https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065"}},"key":"Event list (default)","summary":"Event list (default)","id":"paths/~1events/get/responses/200/content/application~1json/examples/Event list (default)"},"paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e6f50446-be4a-40ac-8c8d-6fb91e1040fd","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1events/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"b3a71f58-2c09-4e6d-91b7-4f8c5e2a0d63","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1events/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1events/get/responses/404/content/application~1json/examples/User not found":{"value":{"type":"error.list","request_id":"5e9c0b24-71f3-4a86-bd50-2c7a1e638f49","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"User not found","summary":"User not found","id":"paths/~1events/get/responses/404/content/application~1json/examples/User not found"},"paths/~1events/get/responses/404/content/application~1json/examples/Lead not found":{"value":{"type":"error.list","request_id":"93f6d205-4b18-47ea-8c31-6d0b5a7e2f14","errors":[{"code":"not_found","message":"Lead Not Found"}]},"key":"Lead not found","summary":"Lead not found","id":"paths/~1events/get/responses/404/content/application~1json/examples/Lead not found"},"paths/~1events/get/responses/422/content/application~1json/examples/Unsupported type":{"value":{"type":"error.list","request_id":"1d4e8a07-5f62-4390-b7c8-0a2e9b16d35f","errors":[{"code":"parameter_invalid","message":"unsupported type [company]"}]},"key":"Unsupported type","summary":"Unsupported type","id":"paths/~1events/get/responses/422/content/application~1json/examples/Unsupported type"},"paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No user identifier":{"value":{"type":"error.list","request_id":"7c1b93a6-0d52-4e87-96f4-2a8e5c0b7d31","errors":[{"code":"missing_parameter","message":"No user identifier found"}]},"key":"No user identifier","summary":"No user identifier","id":"paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No user identifier"},"paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No summaries":{"value":{"type":"error.list","request_id":"a04f6e82-3c97-4b15-8d26-f1b7093c5e48","errors":[{"code":"missing_parameter","message":"No summaries found"}]},"key":"No summaries","summary":"No summaries","id":"paths/~1events~1summaries/post/responses/400/content/application~1json/examples/No summaries"},"paths/~1events~1summaries/post/responses/400/content/application~1json/examples/Summary field has the wrong type":{"value":{"type":"error.list","request_id":"e82d47b1-6a09-4c35-b7f1-305c9e2a6d70","errors":[{"code":"parameter_invalid","message":"Value: many not of type Integer"}]},"key":"Summary field has the wrong type","summary":"Summary field has the wrong type","id":"paths/~1events~1summaries/post/responses/400/content/application~1json/examples/Summary field has the wrong type"},"paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7a7d8425-2c1b-46ab-8133-c043fc1e5711","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"36b0e95c-7d41-4a28-83ef-9c5a1b204e76","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1events~1summaries/post/responses/404/content/application~1json/examples/User not found":{"value":{"type":"error.list","request_id":"58c7a230-9e16-4b74-a0d3-7f2e6c1b9d45","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"User not found","summary":"User not found","id":"paths/~1events~1summaries/post/responses/404/content/application~1json/examples/User not found"},"paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful":{"value":{"created_at_after":1734519776,"created_at_before":1734537776},"key":"successful","summary":"successful","id":"paths/~1export~1content~1data/post/requestBody/content/application~1json/examples/successful"},"paths/~1export~1content~1data/post/responses/200/content/application~1json/examples/successful":{"value":{"job_identifier":"al9w983lwu88w1fd","status":"pending","download_url":"","download_expires_at":""},"key":"successful","summary":"successful","id":"paths/~1export~1content~1data/post/responses/200/content/application~1json/examples/successful"},"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Missing date":{"value":{"type":"error.list","request_id":"1a7c0e36-b249-4d85-96f1-5c03e7a2b48d","errors":[{"code":"bad_request","message":"'created_at_after' is a required parameter"}]},"key":"Missing date","summary":"Missing date","id":"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Missing date"},"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Date is not an integer":{"value":{"type":"error.list","request_id":"62e9b0a4-38c7-4f51-bd96-07a1c4e5f283","errors":[{"code":"bad_request","message":"'created_at_before: yesterday' must be of type Integer"}]},"key":"Date is not an integer","summary":"Date is not an integer","id":"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Date is not an integer"},"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Dates out of order":{"value":{"type":"error.list","request_id":"f3081b57-4c2a-49e6-85d0-2b7a6e91c340","errors":[{"code":"bad_request","message":"created_at_after is greater than created_at_before"}]},"key":"Dates out of order","summary":"Dates out of order","id":"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Dates out of order"},"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Unknown parameter":{"value":{"type":"error.list","request_id":"9d2f4c81-706b-4e39-a5c7-13e08b6d2f95","errors":[{"code":"bad_request","message":"bad 'created_at' parameter"}]},"key":"Unknown parameter","summary":"Unknown parameter","id":"paths/~1export~1content~1data/post/responses/400/content/application~1json/examples/Unknown parameter"},"paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"4b6e1d09-85f2-4a37-9c60-d1a37e204b58","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"0c93a7e5-1f48-4b62-83da-6e5c702f194b","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1export~1content~1data/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1export~1content~1data/post/responses/422/content/application~1json/examples/Range too long":{"value":{"type":"error.list","request_id":"7e50c938-2a61-4df7-b084-c9f2e63a51d7","errors":[{"code":"parameter_invalid","message":"The export period is longer than 90 days"}]},"key":"Range too long","summary":"Range too long","id":"paths/~1export~1content~1data/post/responses/422/content/application~1json/examples/Range too long"},"paths/~1export~1content~1data/post/responses/429/content/application~1json/examples/Concurrent job limit reached":{"value":{"type":"error.list","request_id":"83b4f027-5d19-4ce6-a27f-b05e19c63d4a","errors":[{"code":"rate_limit_exceeded","message":"Exceeded rate limit of 2 pending content data export jobs"}]},"key":"Concurrent job limit reached","summary":"Concurrent job limit reached","id":"paths/~1export~1content~1data/post/responses/429/content/application~1json/examples/Concurrent job limit reached"},"paths/~1export~1content~1data/post/responses/500/content/application~1json/examples/Export disabled":{"value":{"type":"error.list","request_id":"a5c6e239-0b74-41f8-9d13-7e2b840c5f61","errors":[{"code":"server_error","message":"Content data export is currently disabled"}]},"key":"Export disabled","summary":"Export disabled","id":"paths/~1export~1content~1data/post/responses/500/content/application~1json/examples/Export disabled"},"paths/~1export~1content~1data~1{job_identifier}/get/responses/200/content/application~1json/examples/successful":{"value":{"job_identifier":"braxwk3j039t6txy","status":"pending","download_url":"","download_expires_at":""},"key":"successful","summary":"successful","id":"paths/~1export~1content~1data~1{job_identifier}/get/responses/200/content/application~1json/examples/successful"},"paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"6ea2c705-84b3-4f19-bd68-013c7e5a2f84","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"1f73b08e-5a26-4c93-87d1-902e4b6c35fa","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1export~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1export~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found":{"value":{"type":"error.list","request_id":"50a9e14c-6d82-4b37-9f05-c83e712a6d49","errors":[{"code":"not_found","message":"Export job not found for identifier: braxwk3j039t6txy"}]},"key":"Job not found","summary":"Job not found","id":"paths/~1export~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"},"paths/~1export~1content~1data~1{job_identifier}/get/responses/504/content/application~1json/examples/Failed job":{"value":{"job_identifier":"braxwk3j039t6txy","status":"failed","download_url":"","download_expires_at":""},"key":"Failed job","summary":"Failed job","id":"paths/~1export~1content~1data~1{job_identifier}/get/responses/504/content/application~1json/examples/Failed job"},"paths/~1export~1cancel~1{job_identifier}/post/responses/200/content/application~1json/examples/successful":{"value":{"job_identifier":"v134nyc2bku9hj91","status":"canceled","download_url":"","download_expires_at":""},"key":"successful","summary":"successful","id":"paths/~1export~1cancel~1{job_identifier}/post/responses/200/content/application~1json/examples/successful"},"paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7d41c093-2eb6-4a58-8f27-c590b31e6472","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"3e8b5f27-91c4-40da-b163-8f0c27a4e95d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1export~1cancel~1{job_identifier}/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1export~1cancel~1{job_identifier}/post/responses/404/content/application~1json/examples/Job not found":{"value":{"type":"error.list","request_id":"b24f7e51-0a93-4c86-95d7-1e6038b2c74f","errors":[{"code":"not_found","message":"Export job not found for identifier: v134nyc2bku9hj91"}]},"key":"Job not found","summary":"Job not found","id":"paths/~1export~1cancel~1{job_identifier}/post/responses/404/content/application~1json/examples/Job not found"},"paths/~1export~1cancel~1{job_identifier}/post/responses/500/content/application~1json/examples/Export disabled":{"value":{"type":"error.list","request_id":"c6017af3-4958-42be-a0d1-72f3e8b5c096","errors":[{"code":"server_error","message":"Content data export is currently disabled"}]},"key":"Export disabled","summary":"Export disabled","id":"paths/~1export~1cancel~1{job_identifier}/post/responses/500/content/application~1json/examples/Export disabled"},"paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9a3c6d08-f714-4b25-8e60-37bc1f9a2e58","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"4812fa6b-7d05-49c3-96e1-5a0b3c7d84f2","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1download~1content~1data~1{job_identifier}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1download~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found":{"value":{"type":"error.list","request_id":"d709e38a-1c64-4257-bf90-6e23a85c107b","errors":[{"code":"not_found","message":"Export job not found for identifier: xyz1234"}]},"key":"Job not found","summary":"Job not found","id":"paths/~1download~1content~1data~1{job_identifier}/get/responses/404/content/application~1json/examples/Job not found"},"paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Download failed":{"value":{"type":"error.list","request_id":"5b96c021-83e7-4d4a-a715-0f26e3b8d94c","errors":[{"code":"server_error","message":"Request failed due to an internal error. Please reach out to support with the job_identifier of this job"}]},"key":"Download failed","summary":"Download failed","id":"paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Download failed"},"paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Export disabled":{"value":{"type":"error.list","request_id":"e13a7c59-204b-468f-82d6-71c5b09e3a47","errors":[{"code":"server_error","message":"Content data export is currently disabled"}]},"key":"Export disabled","summary":"Export disabled","id":"paths/~1download~1content~1data~1{job_identifier}/get/responses/500/content/application~1json/examples/Export disabled"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload":{"value":{"catalog":"@products.json"},"key":"single_file_upload","summary":"Single-file upload","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/single_file_upload"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part":{"value":{"catalog":"@products_part1.json","finalize":"false"},"key":"multipart_first_part","summary":"Multipart — Step 1: First part","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_first_part"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part":{"value":{"catalog":"@products_part2.json","finalize":"false","import_job_id":"job_01abc123","part_number":2},"key":"multipart_append_part","summary":"Multipart — Step 2: Append part","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_append_part"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize":{"value":{"finalize":"true","import_job_id":"job_01abc123"},"key":"multipart_finalize","summary":"Multipart — Step 3: Finalize","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/requestBody/content/multipart~1form-data/examples/multipart_finalize"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/200/content/application~1json/examples/Part uploaded":{"value":{"import_job_id":"job_01abc123","next_part_number":2},"key":"Part uploaded","summary":"Part uploaded","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/200/content/application~1json/examples/Part uploaded"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/202/content/application~1json/examples/Sync started":{"value":{"import_job_id":"job_01abc123","status":"processing","message":"Catalog received. Sync has started."},"key":"Sync started","summary":"Sync started","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/202/content/application~1json/examples/Sync started"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Missing catalog file":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_not_found","message":"catalog file is required"}]},"key":"Missing catalog file","summary":"Missing catalog file","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Missing catalog file"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Catalog is not a file":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"parameter_not_found","message":"catalog must be an uploaded file"}]},"key":"Catalog is not a file","summary":"Catalog is not a file","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/400/content/application~1json/examples/Catalog is not a file"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Connector not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"import_source_not_found","message":"No connector found with the provided id."}]},"key":"Connector not found","summary":"Connector not found","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Connector not found"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Feature not available":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"not_found","message":"The catalog API is not available for this workspace."}]},"key":"Feature not available","summary":"Feature not available","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Feature not available"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Upload session not found":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"upload_session_not_found","message":"No active upload session found for the provided import_job_id."}]},"key":"Upload session not found","summary":"Upload session not found","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/404/content/application~1json/examples/Upload session not found"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Sync already in progress":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"sync_in_progress","message":"A catalog upload is already in progress. Please wait for it to complete."}]},"key":"Sync already in progress","summary":"Sync already in progress","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Sync already in progress"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Multipart session already exists":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"sync_in_progress","message":"A multipart upload is already in progress. Use import_job_id to continue."}]},"key":"Multipart session already exists","summary":"Multipart session already exists","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Multipart session already exists"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Session cannot be finalized":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"upload_session_not_finalizable","message":"Upload session cannot be finalized in its current state."}]},"key":"Session cannot be finalized","summary":"Session cannot be finalized","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/409/content/application~1json/examples/Session cannot be finalized"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog is not a JSON array":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"invalid_catalog_format","message":"catalog must be a JSON array"}]},"key":"Catalog is not a JSON array","summary":"Catalog is not a JSON array","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog is not a JSON array"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog items are not objects":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"invalid_catalog_format","message":"each item in the catalog array must be a JSON object"}]},"key":"Catalog items are not objects","summary":"Catalog items are not objects","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Catalog items are not objects"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Part number is not a positive integer":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"invalid_part_number","message":"part_number must be a positive integer"}]},"key":"Part number is not a positive integer","summary":"Part number is not a positive integer","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Part number is not a positive integer"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Out-of-sequence part number":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"invalid_part_number","message":"Expected part 2, got 3"}]},"key":"Out-of-sequence part number","summary":"Out-of-sequence part number","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/Out-of-sequence part number"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/File exceeds size limit":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"payload_too_large","message":"catalog file exceeds 99MB limit"}]},"key":"File exceeds size limit","summary":"File exceeds size limit","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/File exceeds size limit"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/import_job_id required for multipart":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"import_job_id_required","message":"Include import_job_id to continue an existing upload session."}]},"key":"import_job_id required for multipart","summary":"import_job_id required for multipart","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/422/content/application~1json/examples/import_job_id required for multipart"},"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/503/content/application~1json/examples/Storage error":{"value":{"type":"error.list","request_id":"test-uuid-replacement","errors":[{"code":"internal_error","message":"Failed to store catalog"}]},"key":"Storage error","summary":"Storage error","id":"paths/~1ecommerce~1connectors~1{id}~1catalog/post/responses/503/content/application~1json/examples/Storage error"},"paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created":{"value":{"type":"product.created","occurred_at":"2026-10-14T09:30:00Z","data":{"product":{"id":"tent-2p-ultralight","title":"Ridgeline 2-Person Ultralight Tent","url":"https://example.com/products/ridgeline-2p-tent","description":"A freestanding two-person backpacking tent that weighs under 1.5 kg.","featured_image_url":"https://cdn.example.com/images/ridgeline-2p.jpg","price_min":349,"price_max":379,"currency":"USD","in_stock":true,"category_path":["Camping","Tents"],"collections":["Backpacking"],"tags":["ultralight","freestanding"],"available_options":[{"name":"Color","values":["Green","Orange"]}],"variants":[{"id":"tent-2p-ultralight-green","title":"Green","price":349,"in_stock":true,"selected_options":[{"name":"Color","value":"Green"}]},{"id":"tent-2p-ultralight-orange","title":"Orange","price":379,"in_stock":true,"selected_options":[{"name":"Color","value":"Orange"}]}],"created_at":"2026-10-14T09:30:00Z","updated_at":"2026-10-14T09:30:00Z"}}},"key":"product_created","summary":"Product created","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_created"},"paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated":{"value":{"type":"product.updated","occurred_at":"2026-10-15T14:05:00Z","data":{"product":{"id":"tent-2p-ultralight","title":"Ridgeline 2-Person Ultralight Tent","url":"https://example.com/products/ridgeline-2p-tent","description":"A freestanding two-person backpacking tent that weighs under 1.5 kg.","featured_image_url":"https://cdn.example.com/images/ridgeline-2p.jpg","price_min":299,"price_max":379,"currency":"USD","in_stock":true,"category_path":["Camping","Tents"],"collections":["Backpacking","Sale"],"tags":["ultralight","freestanding"],"available_options":[{"name":"Color","values":["Green","Orange"]}],"variants":[{"id":"tent-2p-ultralight-green","title":"Green","price":299,"compare_at_price":349,"in_stock":true,"selected_options":[{"name":"Color","value":"Green"}]},{"id":"tent-2p-ultralight-orange","title":"Orange","price":379,"in_stock":false,"selected_options":[{"name":"Color","value":"Orange"}]}],"created_at":"2026-10-14T09:30:00Z","updated_at":"2026-10-15T14:05:00Z"}}},"key":"product_updated","summary":"Product updated","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_updated"},"paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted":{"value":{"type":"product.deleted","occurred_at":"2026-10-20T08:00:00Z","data":{"product_id":"tent-2p-ultralight"}},"key":"product_deleted","summary":"Product deleted","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/requestBody/content/application~1json/examples/product_deleted"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/202/content/application~1json/examples/Event accepted":{"value":{"event_id":81273},"key":"Event accepted","summary":"Event accepted","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/202/content/application~1json/examples/Event accepted"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid type":{"value":{"type":"invalid_event","message":"type must be one of product.created, product.updated, product.deleted"},"key":"Invalid type","summary":"Invalid type","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid type"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid product":{"value":{"type":"invalid_event","message":"data.product.title is required; data.product.updated_at must be an ISO 8601 timestamp"},"key":"Invalid product","summary":"Invalid product","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Invalid product"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Missing product id on delete":{"value":{"type":"invalid_event","message":"data.product_id is required"},"key":"Missing product id on delete","summary":"Missing product id on delete","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Missing product id on delete"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Product too large":{"value":{"type":"invalid_event","message":"data.product exceeds 60KB"},"key":"Product too large","summary":"Product too large","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/400/content/application~1json/examples/Product too large"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Connector not found":{"value":{"type":"import_source_not_found","message":"No connector found with the provided import_source_id."},"key":"Connector not found","summary":"Connector not found","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Connector not found"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Feature not available":{"value":{"type":"not_found","message":"The events API is not available for this workspace."},"key":"Feature not available","summary":"Feature not available","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/404/content/application~1json/examples/Feature not available"},"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/409/content/application~1json/examples/Catalog not uploaded":{"value":{"type":"catalog_not_uploaded","message":"Upload a full catalog before sending product events."},"key":"Catalog not uploaded","summary":"Catalog not uploaded","id":"paths/~1ecommerce~1connectors~1{id}~1events/post/responses/409/content/application~1json/examples/Catalog not uploaded"},"paths/~1dynamic_contents/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"dynamic_content","id":"123","name":"Support phone number","key":"support-phone-number","content_type":"inline","default_locale":"en","variations":[{"type":"dynamic_content_variation","id":"456","locale":"en","brand_id":null,"text_content":"+1-555-0100","json_blocks":null,"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597223}],"created_at":1663597223,"updated_at":1663597223}],"total_count":1,"page":1,"per_page":50,"total_pages":1},"key":"Successful response","summary":"Successful response","id":"paths/~1dynamic_contents/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1dynamic_contents/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1dynamic_contents/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1dynamic_contents/get/responses/403/content/application~1json/examples/Dynamic content is not enabled":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b9","errors":[{"code":"api_plan_restricted","message":"Dynamic content is not enabled for this workspace"}]},"key":"Dynamic content is not enabled","summary":"Dynamic content is not enabled","id":"paths/~1dynamic_contents/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"},"paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content":{"value":{"name":"Support phone number","content_type":"inline","default_locale":"en","variations":[{"locale":"en","text_content":"+1-555-0100"},{"locale":"fr","text_content":"+33 1 23 45 67 89"}]},"key":"Create inline dynamic content","summary":"Create inline dynamic content","id":"paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content"},"paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override":{"value":{"name":"Support phone number","content_type":"inline","default_locale":"en","variations":[{"locale":"en","text_content":"+1-555-0100"},{"locale":"en","brand_id":"42","text_content":"+44 20 7946 0000"}]},"key":"Create inline dynamic content with a brand override","summary":"Create inline dynamic content with a brand override","id":"paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create inline dynamic content with a brand override"},"paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content":{"value":{"name":"Refund policy","content_type":"block","default_locale":"en","variations":[{"locale":"en","body":"<p>You can request a refund within 30 days of purchase.</p>"}]},"key":"Create block dynamic content","summary":"Create block dynamic content","id":"paths/~1dynamic_contents/post/requestBody/content/application~1json/examples/Create block dynamic content"},"paths/~1dynamic_contents/post/responses/201/content/application~1json/examples/Dynamic content created":{"value":{"type":"dynamic_content","id":"123","name":"Support phone number","key":"support-phone-number","content_type":"inline","default_locale":"en","variations":[{"type":"dynamic_content_variation","id":"456","locale":"en","brand_id":null,"text_content":"+1-555-0100","json_blocks":null,"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597223},{"type":"dynamic_content_variation","id":"457","locale":"fr","brand_id":null,"text_content":"+33 1 23 45 67 89","json_blocks":null,"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597223}],"created_at":1663597223,"updated_at":1663597223},"key":"Dynamic content created","summary":"Dynamic content created","id":"paths/~1dynamic_contents/post/responses/201/content/application~1json/examples/Dynamic content created"},"paths/~1dynamic_contents/post/responses/400/content/application~1json/examples/Unknown field":{"value":{"type":"error.list","request_id":"c9369cf1-9610-4a1a-91b9-bc3dfde9df4f","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :key"}]},"key":"Unknown field","summary":"Unknown field","id":"paths/~1dynamic_contents/post/responses/400/content/application~1json/examples/Unknown field"},"paths/~1dynamic_contents/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1dynamic_contents/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1dynamic_contents/post/responses/403/content/application~1json/examples/Dynamic content is not enabled":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b9","errors":[{"code":"api_plan_restricted","message":"Dynamic content is not enabled for this workspace"}]},"key":"Dynamic content is not enabled","summary":"Dynamic content is not enabled","id":"paths/~1dynamic_contents/post/responses/403/content/application~1json/examples/Dynamic content is not enabled"},"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Name already in use":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"A dynamic content named 'Support phone number' already exists"}]},"key":"Name already in use","summary":"Name already in use","id":"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Name already in use"},"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing default locale variation":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Variations must include a brand-agnostic variation for the default locale 'en'"}]},"key":"Missing default locale variation","summary":"Missing default locale variation","id":"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing default locale variation"},"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing text content":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Inline-type variations require text_content"}]},"key":"Missing text content","summary":"Missing text content","id":"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Missing text content"},"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Unknown brand":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Variations must reference a brand in the same workspace"}]},"key":"Unknown brand","summary":"Unknown brand","id":"paths/~1dynamic_contents/post/responses/422/content/application~1json/examples/Unknown brand"},"paths/~1dynamic_contents~1{id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"dynamic_content","id":"124","name":"Refund policy","key":"refund-policy","content_type":"block","default_locale":"en","variations":[{"type":"dynamic_content_variation","id":"458","locale":"en","brand_id":null,"text_content":null,"json_blocks":[{"type":"paragraph","text":"You can request a refund within 30 days of purchase."}],"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597223},{"type":"dynamic_content_variation","id":"459","locale":"en","brand_id":"42","text_content":null,"json_blocks":[{"type":"paragraph","text":"You can request a refund within 60 days of purchase."}],"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597223}],"created_at":1663597223,"updated_at":1663597223},"key":"Successful response","summary":"Successful response","id":"paths/~1dynamic_contents~1{id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1dynamic_contents~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1dynamic_contents~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1dynamic_contents~1{id}/get/responses/403/content/application~1json/examples/Dynamic content is not enabled":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b9","errors":[{"code":"api_plan_restricted","message":"Dynamic content is not enabled for this workspace"}]},"key":"Dynamic content is not enabled","summary":"Dynamic content is not enabled","id":"paths/~1dynamic_contents~1{id}/get/responses/403/content/application~1json/examples/Dynamic content is not enabled"},"paths/~1dynamic_contents~1{id}/get/responses/404/content/application~1json/examples/Dynamic content not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Dynamic content not found"}]},"key":"Dynamic content not found","summary":"Dynamic content not found","id":"paths/~1dynamic_contents~1{id}/get/responses/404/content/application~1json/examples/Dynamic content not found"},"paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content":{"value":{"variations":[{"locale":"en","text_content":"+1-555-0199"},{"locale":"fr","text_content":"+33 1 23 45 67 89"}]},"key":"Update dynamic content","summary":"Update dynamic content","id":"paths/~1dynamic_contents~1{id}/put/requestBody/content/application~1json/examples/Update dynamic content"},"paths/~1dynamic_contents~1{id}/put/responses/200/content/application~1json/examples/Dynamic content updated":{"value":{"type":"dynamic_content","id":"123","name":"Support phone number","key":"support-phone-number","content_type":"inline","default_locale":"en","variations":[{"type":"dynamic_content_variation","id":"456","locale":"en","brand_id":null,"text_content":"+1-555-0199","json_blocks":null,"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597300},{"type":"dynamic_content_variation","id":"457","locale":"fr","brand_id":null,"text_content":"+33 1 23 45 67 89","json_blocks":null,"intentionally_empty":false,"created_at":1663597223,"updated_at":1663597223}],"created_at":1663597223,"updated_at":1663597300},"key":"Dynamic content updated","summary":"Dynamic content updated","id":"paths/~1dynamic_contents~1{id}/put/responses/200/content/application~1json/examples/Dynamic content updated"},"paths/~1dynamic_contents~1{id}/put/responses/400/content/application~1json/examples/Unknown field":{"value":{"type":"error.list","request_id":"c3bf536d-e972-4310-86c4-f0c3503284ce","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :type"}]},"key":"Unknown field","summary":"Unknown field","id":"paths/~1dynamic_contents~1{id}/put/responses/400/content/application~1json/examples/Unknown field"},"paths/~1dynamic_contents~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1dynamic_contents~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1dynamic_contents~1{id}/put/responses/403/content/application~1json/examples/Dynamic content is not enabled":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b9","errors":[{"code":"api_plan_restricted","message":"Dynamic content is not enabled for this workspace"}]},"key":"Dynamic content is not enabled","summary":"Dynamic content is not enabled","id":"paths/~1dynamic_contents~1{id}/put/responses/403/content/application~1json/examples/Dynamic content is not enabled"},"paths/~1dynamic_contents~1{id}/put/responses/404/content/application~1json/examples/Dynamic content not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Dynamic content not found"}]},"key":"Dynamic content not found","summary":"Dynamic content not found","id":"paths/~1dynamic_contents~1{id}/put/responses/404/content/application~1json/examples/Dynamic content not found"},"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Content type cannot change":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"content_type is immutable after creation"}]},"key":"Content type cannot change","summary":"Content type cannot change","id":"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Content type cannot change"},"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Key cannot change":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"key is immutable after creation"}]},"key":"Key cannot change","summary":"Key cannot change","id":"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Key cannot change"},"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Empty variations":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"At least one variation is required"}]},"key":"Empty variations","summary":"Empty variations","id":"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Empty variations"},"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Missing default locale variation":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Variations must include a brand-agnostic variation for the default locale 'en'"}]},"key":"Missing default locale variation","summary":"Missing default locale variation","id":"paths/~1dynamic_contents~1{id}/put/responses/422/content/application~1json/examples/Missing default locale variation"},"paths/~1dynamic_contents~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1dynamic_contents~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1dynamic_contents~1{id}/delete/responses/403/content/application~1json/examples/Dynamic content is not enabled":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b9","errors":[{"code":"api_plan_restricted","message":"Dynamic content is not enabled for this workspace"}]},"key":"Dynamic content is not enabled","summary":"Dynamic content is not enabled","id":"paths/~1dynamic_contents~1{id}/delete/responses/403/content/application~1json/examples/Dynamic content is not enabled"},"paths/~1dynamic_contents~1{id}/delete/responses/404/content/application~1json/examples/Dynamic content not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Dynamic content not found"}]},"key":"Dynamic content not found","summary":"Dynamic content not found","id":"paths/~1dynamic_contents~1{id}/delete/responses/404/content/application~1json/examples/Dynamic content not found"},"paths/~1dynamic_contents~1{id}/delete/responses/422/content/application~1json/examples/Dynamic content is still in use":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"validation_error","message":"Cannot delete 'Support phone number' because it is still used in 2 articles"}]},"key":"Dynamic content is still in use","summary":"Dynamic content is still in use","id":"paths/~1dynamic_contents~1{id}/delete/responses/422/content/application~1json/examples/Dynamic content is still in use"},"paths/~1emails/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"email_setting","id":"1","email":"support@company.com","verified":true,"domain":"company.com","brand_id":"9","forwarding_enabled":true,"forwarded_email_last_received_at":1710498600,"created_at":1692530400,"updated_at":1710498600},{"type":"email_setting","id":"2","email":"hello@company.com","verified":true,"domain":"company.com","brand_id":"10","forwarding_enabled":false,"forwarded_email_last_received_at":null,"created_at":1683729000,"updated_at":1701424500}]},"key":"Successful response","summary":"Successful response","id":"paths/~1emails/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1emails/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1emails/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1emails/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1emails/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1emails~1{id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"email_setting","id":"10","email":"support@company.com","verified":true,"domain":"company.com","brand_id":"15","forwarding_enabled":true,"forwarded_email_last_received_at":1710498600,"created_at":1692530400,"updated_at":1710498600},"key":"Successful response","summary":"Successful response","id":"paths/~1emails~1{id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1emails~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1emails~1{id}/get/responses/404/content/application~1json/examples/Email setting not found":{"value":{"type":"error.list","request_id":"req_12345","errors":[{"code":"not_found","message":"Email setting not found"}]},"key":"Email setting not found","summary":"Email setting not found","id":"paths/~1emails~1{id}/get/responses/404/content/application~1json/examples/Email setting not found"},"paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request":{"value":{"conversation_id":"ext-123","message":{"author":"user","body":"How can I see my account details?","timestamp":"2025-01-24T10:01:20.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"}},"key":"Basic request","summary":"Basic request","id":"paths/~1fin~1start/post/requestBody/content/application~1json/examples/Basic request"},"paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history":{"value":{"conversation_id":"ext-123","message":{"author":"user","body":"How can I see my account details?","timestamp":"2025-01-24T10:01:20.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com","attributes":{"plan_type":"Pro","subscription_status":"active"}},"conversation_metadata":{"history":[{"author":"user","body":"I need help","timestamp":"2025-01-24T10:00:01Z"},{"author":"agent","body":"What do you need help with?","timestamp":"2025-01-24T10:01:00Z"}],"attributes":{"priority_level":"high","department":"sales"}}},"key":"Request with conversation history","summary":"Request with conversation history","id":"paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with conversation history"},"paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments":{"value":{"conversation_id":"ext-123","message":{"author":"user","body":"Here is a screenshot of the issue","timestamp":"2025-01-24T10:01:20.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"},"attachments":[{"type":"url","url":"https://example.com/document.pdf"},{"type":"file","name":"screenshot.png","content_type":"image/png","data":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk..."}]},"key":"Request with attachments","summary":"Request with attachments","id":"paths/~1fin~1start/post/requestBody/content/application~1json/examples/Request with attachments"},"paths/~1fin~1start/post/responses/200/content/application~1json/examples/Successful response":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z"},"key":"Successful response","summary":"Successful response","id":"paths/~1fin~1start/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1fin~1start/post/responses/200/content/application~1json/examples/Response with attribute errors":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","errors":{"user":{"attributes":{"invalid_attr":"User attribute 'invalid_attr' does not exist"}},"conversation":{"attributes":{"bad_attr":"Conversation attribute 'bad_attr' does not exist"}}}},"key":"Response with attribute errors","summary":"Response with attribute errors","id":"paths/~1fin~1start/post/responses/200/content/application~1json/examples/Response with attribute errors"},"paths/~1fin~1start/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1fin~1start/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1start/post/responses/401/content/application~1json/examples/Token not authorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token not authorized","summary":"Token not authorized","id":"paths/~1fin~1start/post/responses/401/content/application~1json/examples/Token not authorized"},"paths/~1fin~1start/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1start/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1start/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1start/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1start/post/responses/403/content/application~1json/examples/Response format not available":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"The requested response format is not available."}]},"key":"Response format not available","summary":"Response format not available","id":"paths/~1fin~1start/post/responses/403/content/application~1json/examples/Response format not available"},"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation ID missing":{"value":{"errors":{"conversation_id":"Conversation ID is required"}},"key":"Conversation ID missing","summary":"Conversation ID missing","id":"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation ID missing"},"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation already exists":{"value":{"errors":{"conversation_id":"Fin session already exists for this conversation. Please use /reply to continue the conversation."}},"key":"Conversation already exists","summary":"Conversation already exists","id":"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Conversation already exists"},"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Message timestamp missing":{"value":{"errors":{"message":"timestamp_ms is required"}},"key":"Message timestamp missing","summary":"Message timestamp missing","id":"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Message timestamp missing"},"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many user attributes":{"value":{"errors":{"user":"Cannot update more than 10 attributes at once. Received 11 attributes."}},"key":"Too many user attributes","summary":"Too many user attributes","id":"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many user attributes"},"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many history items":{"value":{"errors":{"conversation_metadata":"Conversation history cannot contain more than 10 items"}},"key":"Too many history items","summary":"Too many history items","id":"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Too many history items"},"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace":{"value":{"errors":{"environment":"Invalid environment"}},"key":"Invalid environment on a Fin for Platforms workspace","summary":"Invalid environment on a Fin for Platforms workspace","id":"paths/~1fin~1start/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"},"paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply":{"value":{"conversation_id":"123456","message":{"author":"user","body":"Here's the information you requested.","timestamp":"2025-01-24T09:01:00.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"}},"key":"Basic reply","summary":"Basic reply","id":"paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Basic reply"},"paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments":{"value":{"conversation_id":"123456","message":{"author":"user","body":"Here's the invoice you asked for.","timestamp":"2025-01-24T09:01:00.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"},"attachments":[{"type":"url","url":"https://example.com/invoice.pdf"}]},"key":"Reply with attachments","summary":"Reply with attachments","id":"paths/~1fin~1reply/post/requestBody/content/application~1json/examples/Reply with attachments"},"paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Successful response":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z"},"key":"Successful response","summary":"Successful response","id":"paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Response with attribute errors":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","errors":{"user":{"attributes":{"invalid_attr":"User attribute 'invalid_attr' does not exist"}}}},"key":"Response with attribute errors","summary":"Response with attribute errors","id":"paths/~1fin~1reply/post/responses/200/content/application~1json/examples/Response with attribute errors"},"paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Token not authorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token not authorized","summary":"Token not authorized","id":"paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Token not authorized"},"paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Response format not available":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"The requested response format is not available."}]},"key":"Response format not available","summary":"Response format not available","id":"paths/~1fin~1reply/post/responses/403/content/application~1json/examples/Response format not available"},"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation ID missing":{"value":{"errors":{"conversation_id":"Conversation ID is required"}},"key":"Conversation ID missing","summary":"Conversation ID missing","id":"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation ID missing"},"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation not found":{"value":{"errors":{"conversation_id":"Conversation not found for the given conversation_id"}},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Conversation not found"},"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Message timestamp missing":{"value":{"errors":{"message":"timestamp_ms is required"}},"key":"Message timestamp missing","summary":"Message timestamp missing","id":"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Message timestamp missing"},"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Too many user attributes":{"value":{"errors":{"user":"Cannot update more than 10 attributes at once. Received 11 attributes."}},"key":"Too many user attributes","summary":"Too many user attributes","id":"paths/~1fin~1reply/post/responses/422/content/application~1json/examples/Too many user attributes"},"paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating":{"value":{"conversation_id":"ext-123","rating":"amazing"},"key":"Submit a rating","summary":"Submit a rating","id":"paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating"},"paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark":{"value":{"conversation_id":"ext-123","rating":"amazing","remark":"Fin solved my problem in seconds."},"key":"Submit a rating with a remark","summary":"Submit a rating with a remark","id":"paths/~1fin~1csat/post/requestBody/content/application~1json/examples/Submit a rating with a remark"},"paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response":{"value":{"conversation_id":"ext-123","rating":"amazing","status":"rated"},"key":"Successful response","summary":"Successful response","id":"paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1fin~1csat/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1csat/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1csat/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Conversation not found":{"value":{"errors":{"conversation_id":"Conversation not found for the given conversation_id"}},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Conversation not found"},"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/No rating requested":{"value":{"errors":{"base":"No rating survey found for this conversation"}},"key":"No rating requested","summary":"No rating requested","id":"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/No rating requested"},"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating window closed":{"value":{"errors":{"base":"The rating window for this conversation has closed"}},"key":"Rating window closed","summary":"Rating window closed","id":"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating window closed"},"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating locked by a remark":{"value":{"errors":{"base":"This rating can no longer be changed because a remark has already been submitted"}},"key":"Rating locked by a remark","summary":"Rating locked by a remark","id":"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Rating locked by a remark"},"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Invalid rating":{"value":{"errors":{"rating":"Rating isn't an option"}},"key":"Invalid rating","summary":"Invalid rating","id":"paths/~1fin~1csat/post/responses/422/content/application~1json/examples/Invalid rating"},"paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user":{"value":{"user":{"id":"123456"}},"key":"Capabilities for a user","summary":"Capabilities for a user","id":"paths/~1fin~1capabilities/post/requestBody/content/application~1json/examples/Capabilities for a user"},"paths/~1fin~1capabilities/post/responses/200/content/application~1json/examples/Successful response":{"value":{"version":"2.17","capabilities":[{"name":"run_procedure_reset_password_12345","description":"<untrusted-content>\nWalk the user through resetting their password.\n</untrusted-content>","inputSchema":{"type":"object","properties":{"conversation_id":{"type":"string","description":"A unique external ID for the new conversation. Must not already exist for this workspace."},"user":{"type":"object","description":"The end user the action is performed for.","properties":{"id":{"type":"string","description":"The user's external ID."},"name":{"type":"string"},"email":{"type":"string"},"attributes":{"type":"object","description":"Custom user attributes (max 10)."}},"required":["id"]},"message":{"type":"object","description":"Optional trigger message posted before the procedure runs.","properties":{"body":{"type":"string"},"author":{"type":"string","enum":["user","agent","fin"]}},"required":["body"]},"conversation_metadata":{"type":"object","properties":{"attributes":{"type":"object"}}}},"required":["conversation_id","user"]},"endpoint":"/fin/procedures/12345/run","method":"POST"},{"name":"reply","description":"Send a user reply into an existing Fin conversation and get Fin's next turn. Use this to continue any ongoing conversation — including one opened by a procedure run — whenever its status is `awaiting_user_reply`.","inputSchema":{"type":"object","properties":{"conversation_id":{"type":"string","description":"External ID of the existing conversation to reply to."},"message":{"type":"object","properties":{"author":{"type":"string","enum":["user","agent","fin"]},"body":{"type":"string"},"timestamp":{"type":"string"},"timestamp_ms":{"type":"string"}},"required":["author","body"]},"user":{"type":"object","description":"The end user the action is performed for.","properties":{"id":{"type":"string","description":"The user's external ID."},"name":{"type":"string"},"email":{"type":"string"},"attributes":{"type":"object","description":"Custom user attributes (max 10)."}},"required":["id"]},"attachments":{"type":"array","description":"Optional attachments to include with the message."},"response_format":{"type":"string","enum":["html","markdown"],"description":"Response body format. Defaults to html."}},"required":["conversation_id","message","user"]},"endpoint":"/fin/reply","method":"POST"},{"name":"ask","description":"Ask Fin a single question and get one informational answer. Fin does not decide to hand over to a human, disambiguate, or ask follow-up questions, although escalation rules can still apply. Use for one-shot informational lookups.","inputSchema":{"type":"object","properties":{"conversation_id":{"type":"string","description":"External ID for the conversation."},"message":{"type":"object","properties":{"author":{"type":"string","enum":["user","agent","fin"]},"body":{"type":"string"},"timestamp":{"type":"string"},"timestamp_ms":{"type":"string"}},"required":["author","body"]},"user":{"type":"object","description":"The end user the action is performed for.","properties":{"id":{"type":"string","description":"The user's external ID."},"name":{"type":"string"},"email":{"type":"string"},"attributes":{"type":"object","description":"Custom user attributes (max 10)."}},"required":["id"]},"conversation_metadata":{"type":"object","properties":{"history":{"type":"array"},"attributes":{"type":"object"}}},"attachments":{"type":"array","description":"Optional attachments to include with the message."},"response_format":{"type":"string","enum":["html","markdown"],"description":"Response body format. Defaults to html."}},"required":["conversation_id","message","user"]},"endpoint":"/fin/ask","method":"POST"},{"name":"escalate","description":"Hand off to a human team. Summarises the conversation into a new human-facing support conversation routed to the inbox, leaving this one untouched, and notifies you when the handoff completes. Use when the user asks for a human or when you decide Fin can't resolve the request.","inputSchema":{"type":"object","description":"Escalate an existing conversation (conversation_id) or a new one (user) — not both.","oneOf":[{"properties":{"conversation_id":{"type":"string","description":"External ID of the conversation to escalate."},"context":{"type":"string","maxLength":10000,"description":"Background for the teammate who picks up the handoff. Never shown to the end user."}},"required":["conversation_id"],"additionalProperties":false},{"properties":{"user":{"type":"object","description":"The end user the action is performed for.","properties":{"id":{"type":"string","description":"The user's external ID."},"name":{"type":"string"},"email":{"type":"string"},"attributes":{"type":"object","description":"Custom user attributes (max 10)."}},"required":["id"]},"context":{"type":"string","maxLength":10000,"description":"Background for the teammate who picks up the handoff. Never shown to the end user."}},"required":["user"],"additionalProperties":false}]},"endpoint":"/fin/escalate","method":"POST"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1fin~1capabilities/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1fin~1capabilities/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1fin~1capabilities/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Token not authorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token not authorized","summary":"Token not authorized","id":"paths/~1fin~1capabilities/post/responses/401/content/application~1json/examples/Token not authorized"},"paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1capabilities/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1capabilities/post/responses/422/content/application~1json/examples/Too many user attributes":{"value":{"errors":{"user":"Cannot update more than 10 attributes at once. Received 11 attributes."}},"key":"Too many user attributes","summary":"Too many user attributes","id":"paths/~1fin~1capabilities/post/responses/422/content/application~1json/examples/Too many user attributes"},"paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question":{"value":{"conversation_id":"ext-123","message":{"author":"user","body":"How do I reset my password?","timestamp":"2025-01-24T10:01:20.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"}},"key":"Basic question","summary":"Basic question","id":"paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Basic question"},"paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes":{"value":{"conversation_id":"ext-123","message":{"author":"user","body":"And how long does that take to apply?","timestamp":"2025-01-24T10:02:00.000Z"},"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com","attributes":{"plan_type":"Pro"}},"conversation_metadata":{"history":[{"author":"user","body":"How do I reset my password?","timestamp":"2025-01-24T10:01:20.000Z"}],"attributes":{"order_id":"98765"}}},"key":"Question with history and attributes","summary":"Question with history and attributes","id":"paths/~1fin~1ask/post/requestBody/content/application~1json/examples/Question with history and attributes"},"paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Successful response":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z"},"key":"Successful response","summary":"Successful response","id":"paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Response with attribute errors":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","errors":{"user":{"attributes":{"invalid_attr":"User attribute 'invalid_attr' does not exist"}}}},"key":"Response with attribute errors","summary":"Response with attribute errors","id":"paths/~1fin~1ask/post/responses/200/content/application~1json/examples/Response with attribute errors"},"paths/~1fin~1ask/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1fin~1ask/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Token not authorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token not authorized","summary":"Token not authorized","id":"paths/~1fin~1ask/post/responses/401/content/application~1json/examples/Token not authorized"},"paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Response format not available":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"The requested response format is not available."}]},"key":"Response format not available","summary":"Response format not available","id":"paths/~1fin~1ask/post/responses/403/content/application~1json/examples/Response format not available"},"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation ID missing":{"value":{"errors":{"conversation_id":"Conversation ID is required"}},"key":"Conversation ID missing","summary":"Conversation ID missing","id":"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation ID missing"},"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation already exists":{"value":{"errors":{"conversation_id":"Fin session already exists for this conversation. Please use /reply to continue the conversation."}},"key":"Conversation already exists","summary":"Conversation already exists","id":"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Conversation already exists"},"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Message timestamp missing":{"value":{"errors":{"message":"timestamp_ms is required"}},"key":"Message timestamp missing","summary":"Message timestamp missing","id":"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Message timestamp missing"},"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many user attributes":{"value":{"errors":{"user":"Cannot update more than 10 attributes at once. Received 11 attributes."}},"key":"Too many user attributes","summary":"Too many user attributes","id":"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many user attributes"},"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many history items":{"value":{"errors":{"conversation_metadata":"Conversation history cannot contain more than 10 items"}},"key":"Too many history items","summary":"Too many history items","id":"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Too many history items"},"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace":{"value":{"errors":{"environment":"Invalid environment"}},"key":"Invalid environment on a Fin for Platforms workspace","summary":"Invalid environment on a Fin for Platforms workspace","id":"paths/~1fin~1ask/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run":{"value":{"conversation_id":"ext-123","user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"}},"key":"Basic procedure run","summary":"Basic procedure run","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Basic procedure run"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes":{"value":{"conversation_id":"ext-123","user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"},"message":{"author":"agent","body":"Starting your refund request."},"conversation_metadata":{"attributes":{"order_id":"98765"}}},"key":"Procedure run with trigger message and attributes","summary":"Procedure run with trigger message and attributes","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/requestBody/content/application~1json/examples/Procedure run with trigger message and attributes"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Successful response":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","procedure_id":"12345","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z"},"key":"Successful response","summary":"Successful response","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Response with attribute errors":{"value":{"conversation_id":"ext-123","intercom_conversation_id":"192837465","user_id":"user-456","procedure_id":"12345","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","errors":{"user":{"attributes":{"invalid_attr":"User attribute 'invalid_attr' does not exist"}}}},"key":"Response with attribute errors","summary":"Response with attribute errors","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/200/content/application~1json/examples/Response with attribute errors"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Token not authorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token not authorized","summary":"Token not authorized","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/401/content/application~1json/examples/Token not authorized"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation ID missing":{"value":{"errors":{"conversation_id":"Conversation ID is required"}},"key":"Conversation ID missing","summary":"Conversation ID missing","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation ID missing"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not found":{"value":{"errors":{"procedure_id":"Procedure not found"}},"key":"Procedure not found","summary":"Procedure not found","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not found"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not live":{"value":{"errors":{"procedure_id":"Procedure is not live"}},"key":"Procedure not live","summary":"Procedure not live","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not live"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available on the Fin Agent API channel":{"value":{"errors":{"procedure_id":"Procedure is not available on the Fin Agent API channel"}},"key":"Procedure not available on the Fin Agent API channel","summary":"Procedure not available on the Fin Agent API channel","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available on the Fin Agent API channel"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available for this user":{"value":{"errors":{"procedure_id":"Procedure is not available for this user"}},"key":"Procedure not available for this user","summary":"Procedure not available for this user","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Procedure not available for this user"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/No Fin profile":{"value":{"errors":{"base":"No Fin profile is configured to handle this conversation. Configure a Fin profile and retry."}},"key":"No Fin profile","summary":"No Fin profile","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/No Fin profile"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation already exists":{"value":{"errors":{"conversation_id":"Fin session already exists for this conversation. Please use /reply to continue the conversation."}},"key":"Conversation already exists","summary":"Conversation already exists","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Conversation already exists"},"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace":{"value":{"errors":{"environment":"Invalid environment"}},"key":"Invalid environment on a Fin for Platforms workspace","summary":"Invalid environment on a Fin for Platforms workspace","id":"paths/~1fin~1procedures~1{procedure_id}~1run/post/responses/422/content/application~1json/examples/Invalid environment on a Fin for Platforms workspace"},"paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation":{"value":{"conversation_id":"ext-123","context":"Customer is requesting a refund and is frustrated."},"key":"Escalate an existing conversation","summary":"Escalate an existing conversation","id":"paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate an existing conversation"},"paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user":{"value":{"user":{"id":"123456","name":"John Doe","email":"john.doe@example.com"},"context":"I need help with my billing issue"},"key":"Escalate on behalf of a user","summary":"Escalate on behalf of a user","id":"paths/~1fin~1escalate/post/requestBody/content/application~1json/examples/Escalate on behalf of a user"},"paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/Existing conversation":{"value":{"conversation_id":"ext-123","status":"escalated"},"key":"Existing conversation","summary":"Existing conversation","id":"paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/Existing conversation"},"paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/New conversation":{"value":{"conversation_id":"escalate-1a2b3c4d5e6f7a8b","intercom_conversation_id":"987654321","status":"escalated"},"key":"New conversation","summary":"New conversation","id":"paths/~1fin~1escalate/post/responses/200/content/application~1json/examples/New conversation"},"paths/~1fin~1escalate/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1fin~1escalate/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Token not authorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token not authorized","summary":"Token not authorized","id":"paths/~1fin~1escalate/post/responses/401/content/application~1json/examples/Token not authorized"},"paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Fin Agent API not enabled":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"api_plan_restricted","message":"Fin Agent API is not enabled for your app."}]},"key":"Fin Agent API not enabled","summary":"Fin Agent API not enabled","id":"paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Fin Agent API not enabled"},"paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"forbidden","message":"Use your workspace's Fin Agent API key to call the Fin Agent API"}]},"key":"Wrong credentials for the Fin Agent API","summary":"Wrong credentials for the Fin Agent API","id":"paths/~1fin~1escalate/post/responses/403/content/application~1json/examples/Wrong credentials for the Fin Agent API"},"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Neither identifier provided":{"value":{"errors":{"base":"Either conversation_id or user must be provided"}},"key":"Neither identifier provided","summary":"Neither identifier provided","id":"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Neither identifier provided"},"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Both identifiers provided":{"value":{"errors":{"base":"Provide either conversation_id or user, not both"}},"key":"Both identifiers provided","summary":"Both identifiers provided","id":"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Both identifiers provided"},"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Conversation not found":{"value":{"errors":{"conversation_id":"Conversation not found for the given conversation_id"}},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Conversation not found"},"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/User not supported on Fin for Platforms":{"value":{"errors":{"user":"user is not supported for Fin for platforms; only escalating an existing conversation with conversation_id is."}},"key":"User not supported on Fin for Platforms","summary":"User not supported on Fin for Platforms","id":"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/User not supported on Fin for Platforms"},"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Context too long":{"value":{"errors":{"context":"context must be 10000 characters or fewer"}},"key":"Context too long","summary":"Context too long","id":"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Context too long"},"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Deprecated message field":{"value":{"errors":{"message":"message is no longer supported; provide context instead"}},"key":"Deprecated message field","summary":"Deprecated message field","id":"paths/~1fin~1escalate/post/responses/422/content/application~1json/examples/Deprecated message field"},"paths/~1folders/get/responses/200/content/application~1json/example":{"value":{"type":"list","data":[{"id":6,"name":"Product Documentation","description":"Internal product docs","emoji":"📚","content_count":5,"created_at":1672928359,"updated_at":1672928610}],"total_count":1,"pages":{"type":"pages","page":1,"per_page":50,"total_pages":1}},"id":"paths/~1folders/get/responses/200/content/application~1json/example"},"paths/~1folders/post/requestBody/content/application~1json/example":{"value":{"folder":{"name":"Product Documentation","description":"Internal product docs","emoji":"📚"}},"id":"paths/~1folders/post/requestBody/content/application~1json/example"},"paths/~1folders/post/responses/200/content/application~1json/example":{"value":{"id":6,"name":"Product Documentation","description":"Internal product docs","emoji":"📚","parent_folder_id":null,"content_count":0,"created_at":1672928359,"updated_at":1672928359},"id":"paths/~1folders/post/responses/200/content/application~1json/example"},"paths/~1folders~1{id}/get/responses/200/content/application~1json/example":{"value":{"id":6,"name":"Product Documentation","description":"Internal product docs","emoji":"📚","parent_folder_id":null,"content_count":5,"created_at":1672928359,"updated_at":1672928610},"id":"paths/~1folders~1{id}/get/responses/200/content/application~1json/example"},"paths/~1folders~1{id}/get/responses/400/content/application~1json/examples/Invalid folder ID":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"id must be an integer"}]},"key":"Invalid folder ID","summary":"Invalid folder ID","id":"paths/~1folders~1{id}/get/responses/400/content/application~1json/examples/Invalid folder ID"},"paths/~1folders~1{id}/put/requestBody/content/application~1json/example":{"value":{"folder":{"name":"Updated Product Documentation","emoji":"📖"}},"id":"paths/~1folders~1{id}/put/requestBody/content/application~1json/example"},"paths/~1folders~1{id}/put/responses/200/content/application~1json/example":{"value":{"id":6,"name":"Updated Product Documentation","description":"Internal product docs","emoji":"📖","parent_folder_id":null,"content_count":5,"created_at":1672928359,"updated_at":1672928900},"id":"paths/~1folders~1{id}/put/responses/200/content/application~1json/example"},"paths/~1folders~1{id}/put/responses/400/content/application~1json/examples/Invalid folder ID":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"id must be an integer"}]},"key":"Invalid folder ID","summary":"Invalid folder ID","id":"paths/~1folders~1{id}/put/responses/400/content/application~1json/examples/Invalid folder ID"},"paths/~1folders~1{id}/delete/responses/200/content/application~1json/example":{"value":{"id":"6","object":"folder","deleted":true},"id":"paths/~1folders~1{id}/delete/responses/200/content/application~1json/example"},"paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Invalid folder ID":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"id must be an integer"}]},"key":"Invalid folder ID","summary":"Invalid folder ID","id":"paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Invalid folder ID"},"paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Synced folder":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Cannot delete synced folders"}]},"key":"Synced folder","summary":"Synced folder","id":"paths/~1folders~1{id}/delete/responses/400/content/application~1json/examples/Synced folder"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"id":"26","type":"help_center_redirect","from_url":"http://help-center.test/lovelyhelpcenter/legacy-page","locale":"en","help_center_id":"7","target_type":"article","target_id":"11","created_at":1781619405,"updated_at":1781619405}],"total_count":1,"pages":{"type":"pages","page":1,"per_page":50,"total_pages":1}},"key":"Successful","summary":"Successful","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/200/content/application~1json/examples/Successful"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12c2d3a0-77ef-462e-a5ed-e67ddff50b6e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"6c2d3a0a-77ef-462e-a5ed-e67ddff50b6e","errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/get/responses/404/content/application~1json/examples/Not Found"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created":{"value":{"from_url":"http://help-center.test/lovelyhelpcenter/old-page","locale":"en","target_type":"article","target_id":"11"},"key":"redirect_created","summary":"redirect created","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/requestBody/content/application~1json/examples/redirect_created"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/200/content/application~1json/examples/redirect created":{"value":{"id":"26","type":"help_center_redirect","from_url":"http://help-center.test/lovelyhelpcenter/old-page","locale":"en","help_center_id":"7","target_type":"article","target_id":"11","created_at":1781619405,"updated_at":1781619405},"key":"redirect created","summary":"redirect created","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/200/content/application~1json/examples/redirect created"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Missing parameter":{"value":{"type":"error.list","request_id":"816186b3-3187-4b47-adf8-e201bea32208","errors":[{"code":"parameter_not_found","message":"from_url is required"}]},"key":"Missing parameter","summary":"Missing parameter","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Missing parameter"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Invalid target_type":{"value":{"type":"error.list","request_id":"816186b3-3187-4b47-adf8-e201bea32209","errors":[{"code":"parameter_invalid","message":"target_type must be 'article', 'collection' or 'help_center'"}]},"key":"Invalid target_type","summary":"Invalid target_type","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/400/content/application~1json/examples/Invalid target_type"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"25d96ec2-641f-4354-b24e-83a85d33bd30","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"55d96ec2-641f-4354-b24e-83a85d33bd33","errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/404/content/application~1json/examples/Not Found"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/409/content/application~1json/examples/Conflict":{"value":{"type":"error.list","request_id":"35d96ec2-641f-4354-b24e-83a85d33bd31","errors":[{"code":"resource_conflict","message":"A redirect with that URL already exists"}]},"key":"Conflict","summary":"Conflict","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/409/content/application~1json/examples/Conflict"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data":{"value":{"type":"error.list","request_id":"45d96ec2-641f-4354-b24e-83a85d33bd32","errors":[{"code":"data_invalid","message":"from_url must be an absolute URL within this help center's URL space"}]},"key":"Invalid data","summary":"Invalid data","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Help center target mismatch":{"value":{"type":"error.list","request_id":"45d96ec2-641f-4354-b24e-83a85d33bd34","errors":[{"code":"data_invalid","message":"target_id must match the help center for a help_center redirect"}]},"key":"Help center target mismatch","summary":"Help center target mismatch","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Help center target mismatch"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/200/content/application~1json/examples/Successful":{"value":{"id":"26","type":"help_center_redirect","from_url":"http://help-center.test/lovelyhelpcenter/old-page","locale":"en","help_center_id":"7","target_type":"article","target_id":"11","created_at":1781619405,"updated_at":1781619405},"key":"Successful","summary":"Successful","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/200/content/application~1json/examples/Successful"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12c2d3a0-77ef-462e-a5ed-e67ddff50b6e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"6c2d3a0a-77ef-462e-a5ed-e67ddff50b6e","errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/get/responses/404/content/application~1json/examples/Not Found"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/200/content/application~1json/examples/redirect deleted":{"value":{"id":"26","object":"help_center_redirect","deleted":true},"key":"redirect deleted","summary":"redirect deleted","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/200/content/application~1json/examples/redirect deleted"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"25d96ec2-641f-4354-b24e-83a85d33bd30","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"6c2d3a0a-77ef-462e-a5ed-e67ddff50b6e","errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1help_center~1help_centers~1{help_center_id}~1redirects~1{id}/delete/responses/404/content/application~1json/examples/Not Found"},"paths/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"id":"159","type":"collection","workspace_id":"this_is_an_id96_that_should_be_at_least_4","name":"English collection title","url":"http://help-center.test/myapp-96/en/collections/159-english-collection-title","order":17,"created_at":1734537309,"updated_at":1734537309,"description":"english collection description","icon":"bookmark","parent_id":null,"help_center_id":79},{"id":"160","type":"collection","workspace_id":"this_is_an_id96_that_should_be_at_least_4","name":"English section title","url":"http://help-center.test/myapp-96/en/collections/160-english-section-title","order":1,"created_at":1734537309,"updated_at":1734537309,"description":null,"icon":"bookmark","parent_id":"159","help_center_id":null}],"total_count":2,"pages":{"type":"pages","page":1,"per_page":20,"total_pages":1}},"key":"Successful","summary":"Successful","id":"paths/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful"},"paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Per page too large":{"value":{"type":"error.list","request_id":"a53bbddf-0c1f-5347-ad35-6e77920c9856","errors":[{"code":"parameter_invalid","message":"Per Page is too big"}]},"key":"Per page too large","summary":"Per page too large","id":"paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Per page too large"},"paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Invalid help center":{"value":{"type":"error.list","request_id":"806bb340-2357-544e-8fc2-8500543d72bd","errors":[{"code":"invalid_help_center_id","message":"Invalid help center id"}]},"key":"Invalid help center","summary":"Invalid help center","id":"paths/~1help_center~1collections/get/responses/400/content/application~1json/examples/Invalid help center"},"paths/~1help_center~1collections/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12c2d3a0-77ef-462e-a5ed-e67ddff50b6e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created":{"value":{"name":"Thanks for everything"},"key":"collection_created","summary":"collection created","id":"paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/collection_created"},"paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request":{"value":{"description":"Missing required parameter"},"key":"bad_request","summary":"Bad Request","id":"paths/~1help_center~1collections/post/requestBody/content/application~1json/examples/bad_request"},"paths/~1help_center~1collections/post/responses/200/content/application~1json/examples/collection created":{"value":{"id":"165","type":"collection","workspace_id":"this_is_an_id100_that_should_be_at_least_","name":"Thanks for everything","url":"http://help-center.test/myapp-100/en/collections/165-thanks-for-everything","order":1,"created_at":1734537312,"updated_at":1734537312,"description":"","icon":"book-bookmark","parent_id":null,"help_center_id":81},"key":"collection created","summary":"collection created","id":"paths/~1help_center~1collections/post/responses/200/content/application~1json/examples/collection created"},"paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":"816186b3-3187-4b47-adf8-e201bea32208","errors":[{"code":"parameter_not_found","message":"Name is a required parameter."}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request"},"paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Invalid help center":{"value":{"type":"error.list","request_id":"68bc842d-927f-5ac0-a16c-27cfa23c2f2f","errors":[{"code":"invalid_help_center_id","message":"Invalid help center id"}]},"key":"Invalid help center","summary":"Invalid help center","id":"paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Invalid help center"},"paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Parent collection not found":{"value":{"type":"error.list","request_id":"aefba0b8-1416-5186-9b13-2d2ea4c4eedd","errors":[{"code":"parameter_invalid","message":"Parent collection doesn't exist"}]},"key":"Parent collection not found","summary":"Parent collection not found","id":"paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Parent collection not found"},"paths/~1help_center~1collections/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"25d96ec2-641f-4354-b24e-83a85d33bd30","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{collection_id}/get/responses/200/content/application~1json/examples/Collection found":{"value":{"id":"170","type":"collection","workspace_id":"this_is_an_id106_that_should_be_at_least_","name":"English collection title","url":"http://help-center.test/myapp-106/en/collections/170-english-collection-title","order":22,"created_at":1734537315,"updated_at":1734537315,"description":"english collection description","icon":"bookmark","parent_id":null,"help_center_id":84},"key":"Collection found","summary":"Collection found","id":"paths/~1help_center~1collections~1{collection_id}/get/responses/200/content/application~1json/examples/Collection found"},"paths/~1help_center~1collections~1{collection_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a29395a5-181c-4f3b-b069-5b2f32604c58","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections~1{collection_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{collection_id}/get/responses/404/content/application~1json/examples/Collection not found":{"value":{"type":"error.list","request_id":"a074a09e-97d1-44e2-b164-b703559c9f23","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Collection not found","summary":"Collection not found","id":"paths/~1help_center~1collections~1{collection_id}/get/responses/404/content/application~1json/examples/Collection not found"},"paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"name":"Update collection name"},"key":"successful","summary":"successful","id":"paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found":{"value":{"name":"Update collection name"},"key":"collection_not_found","summary":"Collection Not Found","id":"paths/~1help_center~1collections~1{collection_id}/put/requestBody/content/application~1json/examples/collection_not_found"},"paths/~1help_center~1collections~1{collection_id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"176","type":"collection","workspace_id":"this_is_an_id112_that_should_be_at_least_","name":"Update collection name","url":"http://help-center.test/myapp-112/en/collections/176-update-collection-name","order":25,"created_at":1734537318,"updated_at":1734537319,"description":"english collection description","icon":"folder","parent_id":null,"help_center_id":87},"key":"successful","summary":"successful","id":"paths/~1help_center~1collections~1{collection_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Help center mismatch":{"value":{"type":"error.list","request_id":"9bd76817-9f0d-5cc1-9ea0-bba489c1469c","errors":[{"code":"invalid_help_center_id","message":"Supplied help center id doesn't match the collection's help center id."}]},"key":"Help center mismatch","summary":"Help center mismatch","id":"paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Help center mismatch"},"paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Parent collection not found":{"value":{"type":"error.list","request_id":"9a35a830-4e68-528c-bf1b-7f1d3c689edf","errors":[{"code":"parameter_invalid","message":"Parent collection doesn't exist"}]},"key":"Parent collection not found","summary":"Parent collection not found","id":"paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Parent collection not found"},"paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Unsupported locale":{"value":{"type":"error.list","request_id":"0ff611e4-cde8-52c8-8665-1f307615e359","errors":[{"code":"data_invalid","message":"Locale 'xx' isn't supported."}]},"key":"Unsupported locale","summary":"Unsupported locale","id":"paths/~1help_center~1collections~1{collection_id}/put/responses/400/content/application~1json/examples/Unsupported locale"},"paths/~1help_center~1collections~1{collection_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b286edcc-453d-43af-bf2f-40f303708c61","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections~1{collection_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{collection_id}/put/responses/404/content/application~1json/examples/Collection Not Found":{"value":{"type":"error.list","request_id":"198e3add-d017-4e18-b478-fbe2cb8c538b","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Collection Not Found","summary":"Collection Not Found","id":"paths/~1help_center~1collections~1{collection_id}/put/responses/404/content/application~1json/examples/Collection Not Found"},"paths/~1help_center~1collections~1{collection_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"182","object":"collection","deleted":true},"key":"successful","summary":"successful","id":"paths/~1help_center~1collections~1{collection_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1help_center~1collections~1{collection_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d0d16fb5-93e6-45ca-b07d-f98fb92fd733","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections~1{collection_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{collection_id}/delete/responses/404/content/application~1json/examples/collection Not Found":{"value":{"type":"error.list","request_id":"f0d0ea9b-ffaf-48f5-95d0-e99531c379e2","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"collection Not Found","summary":"collection Not Found","id":"paths/~1help_center~1collections~1{collection_id}/delete/responses/404/content/application~1json/examples/collection Not Found"},"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Help Center found":{"value":{"id":"93","workspace_id":"this_is_an_id124_that_should_be_at_least_","created_at":1734537325,"updated_at":1734537325,"identifier":"help-center-1","website_turned_on":false,"display_name":"Intercom Help Center","url":"https://help.mycompany.com","custom_domain":"help.mycompany.com","default":true,"locales":["en"]},"key":"Help Center found","summary":"Help Center found","id":"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Help Center found"},"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c7c301f6-9206-418b-9792-98821970e48b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Help Center not found":{"value":{"type":"error.list","request_id":"bbd5de60-49c4-4850-afff-1226cdaa0beb","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Help Center not found","summary":"Help Center not found","id":"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Help Center not found"},"paths/~1help_center~1help_centers/get/responses/200/content/application~1json/examples/Help Centers found":{"value":{"type":"list","data":[]},"key":"Help Centers found","summary":"Help Centers found","id":"paths/~1help_center~1help_centers/get/responses/200/content/application~1json/examples/Help Centers found"},"paths/~1help_center~1help_centers/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"76edbbb7-e463-4f6a-817a-b7905d467535","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"type":"pages","page":1,"per_page":50,"total_pages":1},"total_count":1,"data":[{"id":39,"title":"Thanks for everything","body":"Body of the Article","owner_id":991266252,"author_id":991266252,"locale":"en"}]},"key":"successful","summary":"successful","id":"paths/~1internal_articles/get/responses/200/content/application~1json/examples/successful"},"paths/~1internal_articles/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2e760b85-9020-471b-89dc-f579ec8a0104","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created":{"value":{"title":"Thanks for everything","body":"Body of the Article","owner_id":991266252,"author_id":991266252,"locale":"en"},"key":"internal_article_created","summary":"internal article created","id":"paths/~1internal_articles/post/requestBody/content/application~1json/examples/internal_article_created"},"paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters":{"value":{"title":"Thanks for everything","body":"Body of the Internal Article"},"key":"missing_required_parameters","summary":"Missing required parameters","id":"paths/~1internal_articles/post/requestBody/content/application~1json/examples/missing_required_parameters"},"paths/~1internal_articles/post/responses/200/content/application~1json/examples/internal article created":{"value":{"id":42,"title":"Thanks for everything","body":"Body of the Article","owner_id":991266252,"author_id":991266252,"locale":"en"},"key":"internal article created","summary":"internal article created","id":"paths/~1internal_articles/post/responses/200/content/application~1json/examples/internal article created"},"paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids is not an array":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"data_invalid","message":"audience_ids must be an array"}]},"key":"audience_ids is not an array","summary":"audience_ids is not an array","id":"paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids is not an array"},"paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids contains a non-integer":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"data_invalid","message":"audience_ids must contain only integer values"}]},"key":"audience_ids contains a non-integer","summary":"audience_ids contains a non-integer","id":"paths/~1internal_articles/post/responses/400/content/application~1json/examples/audience_ids contains a non-integer"},"paths/~1internal_articles/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"85e91429-72df-4e69-8a12-b55793dff59f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles/post/responses/404/content/application~1json/examples/Teammate not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Admin with ID 999999 not found"}]},"key":"Teammate not found","summary":"Teammate not found","id":"paths/~1internal_articles/post/responses/404/content/application~1json/examples/Teammate not found"},"paths/~1internal_articles/post/responses/404/content/application~1json/examples/Folder not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Folder with ID 123 not found"}]},"key":"Folder not found","summary":"Folder not found","id":"paths/~1internal_articles/post/responses/404/content/application~1json/examples/Folder not found"},"paths/~1internal_articles/post/responses/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"audience_ids contains unknown audience IDs: 999"}]},"key":"Unknown audience IDs","summary":"Unknown audience IDs","id":"paths/~1internal_articles/post/responses/404/content/application~1json/examples/Unknown audience IDs"},"paths/~1internal_articles/post/responses/422/content/application~1json/examples/Missing required parameters":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Missing required parameters: owner_id, author_id"}]},"key":"Missing required parameters","summary":"Missing required parameters","id":"paths/~1internal_articles/post/responses/422/content/application~1json/examples/Missing required parameters"},"paths/~1internal_articles/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"body_markdown is mutually exclusive with body and json_blocks - please provide only one"}]},"key":"Body and JSON blocks both provided","summary":"Body and JSON blocks both provided","id":"paths/~1internal_articles/post/responses/422/content/application~1json/examples/Body and JSON blocks both provided"},"paths/~1internal_articles/post/responses/422/content/application~1json/examples/Non-boolean availability flag":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"ai_chatbot_availability must be a boolean (true or false)"}]},"key":"Non-boolean availability flag","summary":"Non-boolean availability flag","id":"paths/~1internal_articles/post/responses/422/content/application~1json/examples/Non-boolean availability flag"},"paths/~1internal_articles~1{internal_article_id}/get/responses/200/content/application~1json/examples/Internal article found":{"value":{"id":45,"body":"Body of the Article","owner_id":991266252,"author_id":991266252,"locale":"en"},"key":"Internal article found","summary":"Internal article found","id":"paths/~1internal_articles~1{internal_article_id}/get/responses/200/content/application~1json/examples/Internal article found"},"paths/~1internal_articles~1{internal_article_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2eab07fb-5092-49a4-ba74-44094f31f264","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles~1{internal_article_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles~1{internal_article_id}/get/responses/404/content/application~1json/examples/Internal article not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Internal article not found","summary":"Internal article not found","id":"paths/~1internal_articles~1{internal_article_id}/get/responses/404/content/application~1json/examples/Internal article not found"},"paths/~1internal_articles~1{internal_article_id}/get/responses/422/content/application~1json/examples/Invalid article ID":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"id must be an integer"}]},"key":"Invalid article ID","summary":"Invalid article ID","id":"paths/~1internal_articles~1{internal_article_id}/get/responses/422/content/application~1json/examples/Invalid article ID"},"paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>"},"key":"successful","summary":"successful","id":"paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>"},"key":"internal_article_not_found","summary":"Internal article not found","id":"paths/~1internal_articles~1{internal_article_id}/put/requestBody/content/application~1json/examples/internal_article_not_found"},"paths/~1internal_articles~1{internal_article_id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":48,"title":"Thanks for everything","body":"Body of the Article","body_markdown":"Body of the Article\n","owner_id":991266252,"author_id":991266252,"locale":"en","folder_id":null,"audience_ids":[1,2],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_at":1672928359,"updated_at":1672928610,"tags":{"type":"tag.list","tags":[]}},"key":"successful","summary":"successful","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids is not an array":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"data_invalid","message":"audience_ids must be an array"}]},"key":"audience_ids is not an array","summary":"audience_ids is not an array","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids is not an array"},"paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids contains a non-integer":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"data_invalid","message":"audience_ids must contain only integer values"}]},"key":"audience_ids contains a non-integer","summary":"audience_ids contains a non-integer","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/400/content/application~1json/examples/audience_ids contains a non-integer"},"paths/~1internal_articles~1{internal_article_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d1ea223d-bb62-42e3-8bcf-30fdcf7dbd99","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Internal article not found","summary":"Internal article not found","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found"},"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Teammate not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Admin with ID 999999 not found"}]},"key":"Teammate not found","summary":"Teammate not found","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Teammate not found"},"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Folder not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Folder with ID 123 not found"}]},"key":"Folder not found","summary":"Folder not found","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Folder not found"},"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"audience_ids contains unknown audience IDs: 999"}]},"key":"Unknown audience IDs","summary":"Unknown audience IDs","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Unknown audience IDs"},"paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"body_markdown is mutually exclusive with body and json_blocks - please provide only one"}]},"key":"Body and JSON blocks both provided","summary":"Body and JSON blocks both provided","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Body and JSON blocks both provided"},"paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Non-boolean availability flag":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"ai_chatbot_availability must be a boolean (true or false)"}]},"key":"Non-boolean availability flag","summary":"Non-boolean availability flag","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Non-boolean availability flag"},"paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Release live experiment conflict":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"release_live_experiment_conflict","message":"Can't update this internal article while release \"Q3 launch\" is running a live experiment on it. Complete or stop the experiment first."}]},"key":"Release live experiment conflict","summary":"Release live experiment conflict","id":"paths/~1internal_articles~1{internal_article_id}/put/responses/422/content/application~1json/examples/Release live experiment conflict"},"paths/~1internal_articles~1{internal_article_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"51","object":"internal_article","deleted":true},"key":"successful","summary":"successful","id":"paths/~1internal_articles~1{internal_article_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1internal_articles~1{internal_article_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c6e86ce8-9402-4196-89c5-f1b2912b4bac","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles~1{internal_article_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles~1{internal_article_id}/delete/responses/404/content/application~1json/examples/Internal article not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"not_found","message":"Resource not found"}]},"key":"Internal article not found","summary":"Internal article not found","id":"paths/~1internal_articles~1{internal_article_id}/delete/responses/404/content/application~1json/examples/Internal article not found"},"paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Invalid article ID":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"id must be an integer"}]},"key":"Invalid article ID","summary":"Invalid article ID","id":"paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Invalid article ID"},"paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"release_live_experiment_conflict","message":"Can't delete this internal article while release \"Q3 launch\" is running a live experiment on it. Complete or stop the experiment first."}]},"key":"Release live experiment conflict","summary":"Release live experiment conflict","id":"paths/~1internal_articles~1{internal_article_id}/delete/responses/422/content/application~1json/examples/Release live experiment conflict"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"7522907"},"key":"successful","summary":"Apply a tag","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":1663597223,"applied_by":{"type":"admin","id":"1234"}},"key":"Tag applied","summary":"Tag applied","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/200/content/application~1json/examples/Tag applied"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"internal_article_not_found","message":"Internal article not found"}]},"key":"Internal article not found","summary":"Internal article not found","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Internal article not found"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Tag not found"},"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found":{"value":{"type":"error.list","request_id":"5d1f0c6e-7b7a-4c9d-8f3e-2a4b6c8d0e1f","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Teammate not found","summary":"Teammate not found","id":"paths/~1internal_articles~1{internal_article_id}~1tags/post/responses/404/content/application~1json/examples/Teammate not found"},"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed":{"value":{"type":"tag","id":"7522907","name":"Independent","applied_at":null,"applied_by":null},"key":"Tag removed","summary":"Tag removed","id":"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/Tag removed"},"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"forbidden","message":"Not authorized to manage knowledge base content"}]},"key":"Forbidden","summary":"Forbidden","id":"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/403/content/application~1json/examples/Forbidden"},"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found":{"value":{"type":"error.list","request_id":"302049fb-b8c1-4dc8-a327-a8f6e1923484","errors":[{"code":"internal_article_not_found","message":"Internal article not found"}]},"key":"Internal article not found","summary":"Internal article not found","id":"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Internal article not found"},"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8a3e4f88-ae65-433a-b4eb-46780ffc5402","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found":{"value":{"type":"error.list","request_id":"5d1f0c6e-7b7a-4c9d-8f3e-2a4b6c8d0e1f","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Teammate not found","summary":"Teammate not found","id":"paths/~1internal_articles~1{internal_article_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Teammate not found"},"paths/~1internal_articles~1search/get/responses/200/content/application~1json/examples/Search successful":{"value":{"type":"list","total_count":1,"internal_articles":[{"id":55,"title":"Thanks for everything","body":"Body of the Article","body_markdown":"Body of the Article\n","owner_id":991266252,"author_id":991266252,"locale":"en","folder_id":123,"audience_ids":[1,2],"ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true,"created_at":1672928359,"updated_at":1672928610,"tags":{"type":"tag.list","tags":[{"type":"tag","id":"7522907","name":"Independent","applied_at":1663597223,"applied_by":{"type":"admin","id":"991266252"}}]}}],"pages":{"type":"pages","page":1,"total_pages":1,"per_page":10}},"key":"Search successful","summary":"Search successful","id":"paths/~1internal_articles~1search/get/responses/200/content/application~1json/examples/Search successful"},"paths/~1internal_articles~1search/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c70746a8-a5b2-4772-afba-1a4b487ea75d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1internal_articles~1search/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1internal_articles~1search/get/responses/404/content/application~1json/examples/Folder not found":{"value":{"type":"error.list","request_id":null,"errors":[{"code":"parameter_invalid","message":"Folder with ID 123 not found"}]},"key":"Folder not found","summary":"Folder not found","id":"paths/~1internal_articles~1search/get/responses/404/content/application~1json/examples/Folder not found"},"paths/~1ip_allowlist/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"ip_allowlist","enabled":true,"ip_allowlist":["192.168.1.0/24","10.0.0.1"]},"key":"Successful","summary":"Successful","id":"paths/~1ip_allowlist/get/responses/200/content/application~1json/examples/Successful"},"paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful":{"value":{"enabled":true,"ip_allowlist":["192.168.1.0/24","10.0.0.1"]},"key":"successful","summary":"Enable IP allowlist","id":"paths/~1ip_allowlist/put/requestBody/content/application~1json/examples/successful"},"paths/~1ip_allowlist/put/responses/200/content/application~1json/examples/Successful":{"value":{"type":"ip_allowlist","enabled":true,"ip_allowlist":["192.168.1.0/24","10.0.0.1"]},"key":"Successful","summary":"Successful","id":"paths/~1ip_allowlist/put/responses/200/content/application~1json/examples/Successful"},"paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a3e5b8e2-1234-5678-9abc-def012345678","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1ip_allowlist/put/responses/422/content/application~1json/examples/Lockout Protection":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"parameter_invalid","message":"Your IP (1.2.3.4) is not on the allowlist. Saving would lock you out of this workspace."}]},"key":"Lockout Protection","summary":"Lockout Protection","id":"paths/~1ip_allowlist/put/responses/422/content/application~1json/examples/Lockout Protection"},"paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved":{"value":{"type":"job","id":"2","url":"https://api.intercom.io/jobs/status/2","status":"success","resource_type":"ticket","resource_id":"20","resource_url":"https://api.intercom.io/tickets/20"},"key":"job status retrieved","summary":"job status retrieved","id":"paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved"},"paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job still pending":{"value":{"type":"job","id":"2","url":"https://api.intercom.io/jobs/status/2","status":"pending","resource_type":"ticket"},"key":"job still pending","summary":"job still pending","id":"paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job still pending"},"paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"ad9c4f05-6e31-4b7a-82d6-15c0e934b7f8","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1jobs~1status~1{job_id}/get/responses/404/content/application~1json/examples/Job not found":{"value":{"type":"error.list","request_id":"123e4567-e89b-12d3-a456-426614174000","errors":[{"code":"job_not_found","message":"Job Not Found"}]},"key":"Job not found","summary":"Job not found","id":"paths/~1jobs~1status~1{job_id}/get/responses/404/content/application~1json/examples/Job not found"},"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/support_macro":{"value":{"type":"macro","id":"789","name":"Refund Process Explanation","body":"<p>Hi <attribute key=\"user.first_name\" default=\"there\"/>,</p><p>I understand you'd like a refund for order #<attribute key=\"conversation.custom_attributes.order_number\"/>. The refund will be processed within 3-5 business days to your <attribute key=\"user.custom_attributes.payment_method\" default=\"original payment method\"/>.</p><p>Is there anything else I can help you with?</p>","body_text":"Hi {{user.first_name|fallback:\"there\"}},\n\nI understand you'd like a refund for order #{{conversation.custom_attributes.order_number}}. The refund will be processed within 3-5 business days to your {{user.custom_attributes.payment_method|fallback:\"original payment method\"}}.\n\nIs there anything else I can help you with?","created_at":"2025-07-21T14:44:35.000Z","updated_at":"2025-07-21T14:44:35.000Z","visible_to":"specific_teams","visible_to_team_ids":["support_team_1","support_team_2"],"available_on":["inbox","messenger"]},"key":"support_macro","summary":"Customer support macro with placeholders","id":"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/support_macro"},"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/sales_macro":{"value":{"type":"macro","id":"456","name":"Product Demo Request","body":"<p>Hello <attribute key=\"user.name\" default=\"valued customer\"/>,</p><p>Thank you for your interest in <attribute key=\"product.name\" default=\"our products\"/>! I'd love to schedule a personalized demo for your team at <attribute key=\"company.name\" default=\"your company\"/>.</p><p>Would <attribute key=\"suggested_time\" default=\"next Tuesday at 2 PM EST\"/> work for you?</p>","body_text":"Hello {{user.name|fallback:\"valued customer\"}},\n\nThank you for your interest in {{product.name|fallback:\"our products\"}}! I'd love to schedule a personalized demo for your team at {{company.name|fallback:\"your company\"}}.\n\nWould {{suggested_time|fallback:\"next Tuesday at 2 PM EST\"}} work for you?","created_at":"2025-07-22T11:06:40.000Z","updated_at":"2025-07-23T00:00:00.000Z","visible_to":"specific_teams","visible_to_team_ids":["sales_team_us","sales_team_eu"],"available_on":["messenger"]},"key":"sales_macro","summary":"Sales team macro for product inquiries","id":"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/sales_macro"},"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/technical_support":{"value":{"type":"macro","id":"890","name":"API Integration Help","body":"<p>Hi <attribute key=\"user.name\"/>,</p><p>I see you're having trouble with the <attribute key=\"conversation.custom_attributes.api_endpoint\" default=\"API\"/> integration. Your API key for app <attribute key=\"app.id\"/> is configured correctly.</p><p>Error code: <attribute key=\"conversation.custom_attributes.error_code\" default=\"unknown\"/></p><p>Let me help you resolve this issue.</p>","body_text":"Hi {{user.name}},\n\nI see you're having trouble with the {{conversation.custom_attributes.api_endpoint|fallback:\"API\"}} integration. Your API key for app {{app.id}} is configured correctly.\n\nError code: {{conversation.custom_attributes.error_code|fallback:\"unknown\"}}\n\nLet me help you resolve this issue.","created_at":"2025-07-18T09:15:00.000Z","updated_at":"2025-07-18T09:15:00.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox"]},"key":"technical_support","summary":"Technical support macro with nested attributes","id":"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/technical_support"},"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/simple_greeting":{"value":{"type":"macro","id":"123","name":"Thank You Response","body":"<p>Thank you for reaching out! We appreciate your message and will get back to you as soon as possible.</p>","body_text":"Thank you for reaching out! We appreciate your message and will get back to you as soon as possible.","created_at":"2025-07-17T11:18:08.000Z","updated_at":"2025-07-17T15:30:24.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox","messenger"]},"key":"simple_greeting","summary":"Simple macro without placeholders","id":"paths/~1macros~1{id}/get/responses/200/content/application~1json/examples/simple_greeting"},"paths/~1macros~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1macros~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1macros~1{id}/get/responses/403/content/application~1json/examples/Missing required scope":{"value":{"type":"error.list","request_id":"f097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"forbidden","message":"You do not have the required scope (read_conversations) to access this resource"}]},"key":"Missing required scope","summary":"OAuth token lacks read_conversations scope","id":"paths/~1macros~1{id}/get/responses/403/content/application~1json/examples/Missing required scope"},"paths/~1macros~1{id}/get/responses/404/content/application~1json/examples/Macro not found":{"value":{"type":"error.list","request_id":"bc300b1a-492a-405f-924e-a5881cb72e3a","errors":[{"code":"not_found","message":"Macro not found"}]},"key":"Macro not found","summary":"Macro not found","id":"paths/~1macros~1{id}/get/responses/404/content/application~1json/examples/Macro not found"},"paths/~1macros/get/responses/200/content/application~1json/examples/basic_list":{"value":{"type":"list","data":[{"type":"macro","id":"123","name":"Order Status Update","body":"<p>Hi <attribute key=\"user.name\" default=\"there\"/>, your order #<attribute key=\"order.number\"/> is ready for pickup!</p>","body_text":"Hi {{user.name|fallback:\"there\"}}, your order #{{order.number}} is ready for pickup!","created_at":"2025-07-17T11:18:08.000Z","updated_at":"2025-07-17T15:30:24.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox","messenger"]},{"type":"macro","id":"456","name":"Welcome Message","body":"<p>Welcome to our support! I'm <attribute key=\"teammate.name\"/>. How can I help you today?</p>","body_text":"Welcome to our support! I'm {{teammate.name}}. How can I help you today?","created_at":"2025-07-21T14:44:35.000Z","updated_at":"2025-07-21T14:44:35.000Z","visible_to":"specific_teams","visible_to_team_ids":["789","101"],"available_on":["inbox"]}],"pages":{"type":"pages","per_page":50,"next":{"starting_after":"WzE3MTk0OTM3NTcuMCwgIjEyMyJd"}}},"key":"basic_list","summary":"Basic list of macros","id":"paths/~1macros/get/responses/200/content/application~1json/examples/basic_list"},"paths/~1macros/get/responses/200/content/application~1json/examples/pagination_with_cursor":{"value":{"type":"list","data":[{"type":"macro","id":"789","name":"Refund Process","body":"<p>I understand you'd like a refund for order #<attribute key=\"conversation.custom_attributes.order_number\"/>. The refund will be processed within 3-5 business days.</p>","body_text":"I understand you'd like a refund for order #{{conversation.custom_attributes.order_number}}. The refund will be processed within 3-5 business days.","created_at":"2025-07-21T07:15:34.000Z","updated_at":"2025-07-21T07:15:34.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox","messenger"]},{"type":"macro","id":"101","name":"Product Inquiry Response","body":"<p>Thank you for your interest in <attribute key=\"product.name\" default=\"our products\"/>. I'd be happy to provide more information!</p>","body_text":"Thank you for your interest in {{product.name|fallback:\"our products\"}}. I'd be happy to provide more information!","created_at":"2025-07-20T05:33:20.000Z","updated_at":"2025-07-21T10:00:00.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox","messenger"]}],"pages":{"type":"pages","per_page":50,"next":{"starting_after":"WzE3MTk0MDAwMDAuMCwgIjEwMSJd"}}},"key":"pagination_with_cursor","summary":"Paginated response using starting_after cursor","id":"paths/~1macros/get/responses/200/content/application~1json/examples/pagination_with_cursor"},"paths/~1macros/get/responses/200/content/application~1json/examples/filtered_by_timestamp":{"value":{"type":"list","data":[{"type":"macro","id":"234","name":"Shipping Update Template","body":"<p>Your order has been shipped via <attribute key=\"shipping.carrier\" default=\"our shipping partner\"/>. Tracking number: <attribute key=\"shipping.tracking_number\"/></p>","body_text":"Your order has been shipped via {{shipping.carrier|fallback:\"our shipping partner\"}}. Tracking number: {{shipping.tracking_number}}","created_at":"2025-07-22T05:31:01.000Z","updated_at":"2025-07-22T18:45:12.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox"]}],"pages":{"type":"pages","per_page":50,"next":null}},"key":"filtered_by_timestamp","summary":"Macros filtered by updated_since parameter","id":"paths/~1macros/get/responses/200/content/application~1json/examples/filtered_by_timestamp"},"paths/~1macros/get/responses/200/content/application~1json/examples/complex_placeholders":{"value":{"type":"list","data":[{"type":"macro","id":"567","name":"Account Status Review","body":"<p>Hi <attribute key=\"user.first_name\" default=\"there\"/>,</p><p>Your account status: <attribute key=\"user.custom_attributes.account_status\" default=\"pending review\"/></p><p>Last activity: <attribute key=\"user.last_seen_at\"/></p>","body_text":"Hi {{user.first_name|fallback:\"there\"}},\n\nYour account status: {{user.custom_attributes.account_status|fallback:\"pending review\"}}\n\nLast activity: {{user.last_seen_at}}","created_at":"2025-07-21T09:00:00.000Z","updated_at":"2025-07-21T09:00:00.000Z","visible_to":"specific_teams","visible_to_team_ids":["security_team"],"available_on":["inbox"]}],"pages":{"type":"pages","per_page":50,"next":null}},"key":"complex_placeholders","summary":"Macros with various placeholder formats","id":"paths/~1macros/get/responses/200/content/application~1json/examples/complex_placeholders"},"paths/~1macros/get/responses/200/content/application~1json/examples/empty_result":{"value":{"type":"list","data":[],"pages":{"type":"pages","per_page":50,"next":null}},"key":"empty_result","summary":"Empty macro list (no macros or all filtered out)","id":"paths/~1macros/get/responses/200/content/application~1json/examples/empty_result"},"paths/~1macros/get/responses/200/content/application~1json/examples/large_list_preview":{"value":{"type":"list","data":[{"type":"macro","id":"1001","name":"Quick Response 1","body":null,"body_text":null,"created_at":"2025-07-22T11:08:20.000Z","updated_at":"2025-07-23T11:08:20.000Z","visible_to":"everyone","visible_to_team_ids":[],"available_on":["inbox"]}],"pages":{"type":"pages","per_page":50,"next":{"starting_after":"WzE3MTk0OTAxMDAuMCwgIjEwMDIiXQ=="}}},"key":"large_list_preview","summary":"Large list with performance optimization","id":"paths/~1macros/get/responses/200/content/application~1json/examples/large_list_preview"},"paths/~1macros/get/responses/400/content/application~1json/examples/Invalid parameter":{"value":{"type":"error.list","request_id":"bc300b1a-492a-405f-924e-a5881cb72e3a","errors":[{"code":"parameter_invalid","message":"Invalid updated_since timestamp"}]},"key":"Invalid parameter","summary":"Invalid parameter","id":"paths/~1macros/get/responses/400/content/application~1json/examples/Invalid parameter"},"paths/~1macros/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1macros/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1macros/get/responses/403/content/application~1json/examples/Missing required scope":{"value":{"type":"error.list","request_id":"f097e446-9ae6-44a8-8e13-2bf3008b87ef","errors":[{"code":"forbidden","message":"You do not have the required scope (read_conversations) to access this resource"}]},"key":"Missing required scope","summary":"OAuth token lacks read_conversations scope","id":"paths/~1macros/get/responses/403/content/application~1json/examples/Missing required scope"},"paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created":{"value":{"from":{"type":"user","id":"6762f2341bb69f9f2193bc17"},"body":"heyy","referer":"https://twitter.com/bob"},"key":"user_message_created","summary":"user message created","id":"paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created"},"paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created":{"value":{"from":{"type":"lead","id":"6762f2371bb69f9f2193bc18"},"body":"heyy","referer":"https://twitter.com/bob"},"key":"lead_message_created","summary":"lead message created","id":"paths/~1messages/post/requestBody/content/application~1json/examples/lead_message_created"},"paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created":{"value":{"from":{"type":"admin","id":"991267816"},"to":[{"type":"user","id":"6762f2391bb69f9f2193bc19"},{"type":"lead","id":"6762f23c1bb69f9f2193bc1b"},{"type":"user","id":"6762f23d1bb69f9f2193bc1c"}],"cc":[{"type":"user","id":"6762f23e1bb69f9f2193bc1d"},{"type":"user","id":"6762f23f1bb69f9f2193bc1e"}],"bcc":[{"type":"user","id":"6762f23e1bb69f9f2193bc2f"}],"message_type":"inapp","body":"heyy"},"key":"admin_message_created","summary":"admin message created","id":"paths/~1messages/post/requestBody/content/application~1json/examples/admin_message_created"},"paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created":{"value":{"from":{"type":"admin","id":"991267817"},"to":{"phone":"+5547999998888","name":"John Doe"},"message_type":"whatsapp","components":[{"type":"BODY","parameters":[{"type":"text","text":"Username 123"}]}],"template":"keep_live","locale":"en"},"key":"admin_whatsapp_message_created","summary":"admin whatsapp message created","id":"paths/~1messages/post/requestBody/content/application~1json/examples/admin_whatsapp_message_created"},"paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message":{"value":{"from":{"type":"admin","id":"991267818"},"to":{"type":"user","id":"6762f23b1bb69f9f2193bc1a"},"message_type":"inapp","body":null,"subject":"heyy"},"key":"no_body_supplied_for_message","summary":"No body supplied for message","id":"paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_message"},"paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message":{"value":{"from":{"type":"admin","id":"991267819"},"to":{"type":"user","user_id":"70"},"message_type":"email","body":"hey there"},"key":"no_subject_supplied_for_email_message","summary":"No subject supplied for email message","id":"paths/~1messages/post/requestBody/content/application~1json/examples/no_subject_supplied_for_email_message"},"paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message":{"value":{"from":{"type":"admin","id":"991267820"},"to":{"type":"user","id":"6762f23d1bb69f9f2193bc1c"},"message_type":"email","body":null,"subject":"heyy"},"key":"no_body_supplied_for_email_message","summary":"No body supplied for email message","id":"paths/~1messages/post/requestBody/content/application~1json/examples/no_body_supplied_for_email_message"},"paths/~1messages/post/responses/200/content/application~1json/examples/user message created":{"value":{"type":"user_message","id":"403918396","created_at":1734537780,"body":"heyy","message_type":"inapp","conversation_id":"613"},"key":"user message created","summary":"user message created","id":"paths/~1messages/post/responses/200/content/application~1json/examples/user message created"},"paths/~1messages/post/responses/200/content/application~1json/examples/lead message created":{"value":{"type":"user_message","id":"403918397","created_at":1734537783,"body":"heyy","message_type":"inapp","conversation_id":"614"},"key":"lead message created","summary":"lead message created","id":"paths/~1messages/post/responses/200/content/application~1json/examples/lead message created"},"paths/~1messages/post/responses/200/content/application~1json/examples/admin message created":{"value":{"type":"admin_message","id":"19","created_at":1734537786,"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}},"key":"admin message created","summary":"admin message created","id":"paths/~1messages/post/responses/200/content/application~1json/examples/admin message created"},"paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for message":{"value":{"type":"error.list","request_id":"3f3e74cc-65af-4408-9bf5-9e71b55c8166","errors":[{"code":"parameter_invalid","message":"Body is required"}]},"key":"No body supplied for message","summary":"No body supplied for message","id":"paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for message"},"paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for email message":{"value":{"type":"error.list","request_id":"2d6abc61-1441-4860-9ef0-777852f8b24f","errors":[{"code":"parameter_invalid","message":"Body is required"}]},"key":"No body supplied for email message","summary":"No body supplied for email message","id":"paths/~1messages/post/responses/400/content/application~1json/examples/No body supplied for email message"},"paths/~1messages/post/responses/400/content/application~1json/examples/Recipient missing":{"value":{"type":"error.list","request_id":"8c1f3a52-6d0e-4f7b-9a41-2e5b7c9d0a11","errors":[{"code":"data_invalid","message":"Field 'to' is required"}]},"key":"Recipient missing","summary":"Recipient missing","id":"paths/~1messages/post/responses/400/content/application~1json/examples/Recipient missing"},"paths/~1messages/post/responses/400/content/application~1json/examples/Too many recipients":{"value":{"type":"error.list","request_id":"1b7e9d34-5c28-4a6f-8e03-7d4a6b2c9f52","errors":[{"code":"parameter_invalid","message":"Max Number of recipients per request reached"}]},"key":"Too many recipients","summary":"Too many recipients","id":"paths/~1messages/post/responses/400/content/application~1json/examples/Too many recipients"},"paths/~1messages/post/responses/400/content/application~1json/examples/Brand not found":{"value":{"type":"error.list","request_id":"5a2c8e71-3f94-4d0b-b6a8-0c9e1d7f3b64","errors":[{"code":"parameter_invalid","message":"brand_id 1234 not found"}]},"key":"Brand not found","summary":"Brand not found","id":"paths/~1messages/post/responses/400/content/application~1json/examples/Brand not found"},"paths/~1messages/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1messages/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"72b6821e-54ff-4a25-adf9-abdfef5fe72b","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1messages/post/responses/403/content/application~1json/examples/Recipient unsubscribed from emails":{"value":{"type":"error.list","request_id":"e4d6b0a8-2c71-4f35-9d8e-6a1b3c5f7e20","errors":[{"code":"action_forbidden","message":"One or more users are unsubscribed from emails"}]},"key":"Recipient unsubscribed from emails","summary":"Recipient unsubscribed from emails","id":"paths/~1messages/post/responses/403/content/application~1json/examples/Recipient unsubscribed from emails"},"paths/~1messages/post/responses/403/content/application~1json/examples/Recipient hard bounced":{"value":{"type":"error.list","request_id":"9f3a7c15-8b42-4e60-a1d9-5c7e2b4d6a83","errors":[{"code":"action_forbidden","message":"One or more users have hard bounced and cannot be messaged via email"}]},"key":"Recipient hard bounced","summary":"Recipient hard bounced","id":"paths/~1messages/post/responses/403/content/application~1json/examples/Recipient hard bounced"},"paths/~1messages/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"7b0d4e92-6a53-4c18-9e2f-3a5c8d1b6f40","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1messages/post/responses/404/content/application~1json/examples/Contact not found"},"paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message":{"value":{"type":"error.list","request_id":"97db463e-7070-4ac9-9846-9a5d31933772","errors":[{"code":"parameter_not_found","message":"No subject supplied for email message"}]},"key":"No subject supplied for email message","summary":"No subject supplied for email message","id":"paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message"},"paths/~1messages/post/responses/422/content/application~1json/examples/Subject too long":{"value":{"type":"error.list","request_id":"3d8b5f90-7a16-4c2e-8f04-9b6d1e3a5c77","errors":[{"code":"parameter_invalid","message":"Subject length must be under 255 characters"}]},"key":"Subject too long","summary":"Subject too long","id":"paths/~1messages/post/responses/422/content/application~1json/examples/Subject too long"},"paths/~1messages/post/responses/422/content/application~1json/examples/Message too long":{"value":{"type":"error.list","request_id":"c2e7a461-0d95-4b38-a7f6-4e8c0b2d9a15","errors":[{"code":"parameter_invalid","message":"Message is too long. Maximum length is 300000"}]},"key":"Message too long","summary":"Message too long","id":"paths/~1messages/post/responses/422/content/application~1json/examples/Message too long"},"paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response":{"value":{"conversation_id":"123456789","status":"delivered","type":"broadcast_outbound","created_at":1734537980,"updated_at":1734538000,"template_name":"appointment_reminder","message_id":"wamid_abc123"},"key":"Successful response","summary":"Successful response","id":"paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error":{"value":{"conversation_id":"123456789","status":"failed","type":"broadcast_outbound","created_at":1734537980,"updated_at":1734538000,"template_name":"appointment_reminder","message_id":"wamid_abc123","error":{"message":"Message delivery failed","details":"Recipient phone number not on WhatsApp"}},"key":"Failed message with error","summary":"Failed message with error","id":"paths/~1messages~1whatsapp~1status/get/responses/200/content/application~1json/examples/Failed message with error"},"paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id":{"value":{"type":"error.list","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","errors":[{"code":"parameter_not_found","message":"message_id is required"}]},"key":"missing message_id","summary":"missing message_id","id":"paths/~1messages~1whatsapp~1status/get/responses/400/content/application~1json/examples/missing message_id"},"paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8b2e4c6f-1234-5678-9abc-def012345678","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1messages~1whatsapp~1status/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"76d8344a-bd94-424c-937b-cc19de8215bb","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1messages~1whatsapp~1status/get/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found":{"value":{"type":"error.list","request_id":"c4d5e6f7-8901-2345-6789-abcdef012345","errors":[{"code":"whatsapp_message_not_found","message":"Whatsapp message not found"}]},"key":"Message not found","summary":"Message not found","id":"paths/~1messages~1whatsapp~1status/get/responses/404/content/application~1json/examples/Message not found"},"paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","ruleset_id":12345,"pages":{"type":"pages","per_page":50,"total_pages":3,"next":{"starting_after":"abc123"}},"total_count":125,"events":[{"id":"event_1","conversation_id":"conv_123","user_id":"user_123","status":"delivered","type":"broadcast_outbound","created_at":1734537980,"updated_at":1734538000,"whatsapp_message_id":"wamid_123","template_name":"appointment_reminder"},{"id":"event_2","conversation_id":"conv_456","user_id":"user_456","status":"sent","type":"broadcast_outbound","created_at":1734537970,"updated_at":1734538010,"whatsapp_message_id":"wamid_456","template_name":"order_update"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1messages~1status/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id":{"value":{"type":"error.list","request_id":"71c45f21-af71-4b0a-a3c6-ef5e2b55740c","errors":[{"code":"parameter_not_found","message":"ruleset_id is required"}]},"key":"missing ruleset_id","summary":"missing ruleset_id","id":"paths/~1messages~1status/get/responses/400/content/application~1json/examples/missing ruleset_id"},"paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d7997515-cd92-4fe4-966c-cb1f4bdda1d4","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1messages~1status/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b0","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1messages~1status/get/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error":{"value":{"type":"error.list","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b2","errors":[{"code":"server_error","message":"Request failed due to an internal error. Please reach out to support"}]},"key":"server error","summary":"server error","id":"paths/~1messages~1status/get/responses/500/content/application~1json/examples/server error"},"paths/~1news~1news_items/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"page":1,"per_page":10,"total_pages":1,"type":"pages"},"data":[{"id":"29","type":"news-item","workspace_id":"this_is_an_id530_that_should_be_at_least_","title":"We have news","body":"<p>Hello there,</p>","sender_id":991267825,"state":"draft","labels":[],"cover_image_url":null,"reactions":[],"deliver_silently":false,"created_at":1734537793,"updated_at":1734537793,"published_at":null,"newsfeed_assignments":[]},{"id":"30","type":"news-item","workspace_id":"this_is_an_id530_that_should_be_at_least_","title":"We have news","body":"<p>Hello there,</p>","sender_id":991267827,"state":"draft","labels":[],"cover_image_url":null,"reactions":[],"deliver_silently":false,"created_at":1734537793,"updated_at":1734537793,"published_at":null,"newsfeed_assignments":[]}],"total_count":2},"key":"successful","summary":"successful","id":"paths/~1news~1news_items/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items/get/responses/400/content/application~1json/examples/Per page too small":{"value":{"type":"error.list","request_id":"1d4b6f2a-5c83-4e71-9a0d-2b6e8c47f310","errors":[{"code":"parameter_invalid","message":"Per Page is too small"}]},"key":"Per page too small","summary":"Per page too small","id":"paths/~1news~1news_items/get/responses/400/content/application~1json/examples/Per page too small"},"paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d7997515-cd92-4fe4-966c-cb1f4bdda1d4","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"3f7c91e4-6a25-4d8b-b1c3-7e95a2d6048f","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful":{"value":{"title":"Halloween is here!","body":"<p>New costumes in store for this spooky season</p>","labels":["Product","Update","New"],"sender_id":991267834,"deliver_silently":true,"reactions":["😆","😅"],"state":"live","newsfeed_assignments":[{"newsfeed_id":53,"published_at":1664638214}]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items/post/requestBody/content/application~1json/examples/successful"},"paths/~1news~1news_items/post/responses/200/content/application~1json/examples/successful":{"value":{"id":"33","type":"news-item","workspace_id":"this_is_an_id534_that_should_be_at_least_","title":"Halloween is here!","body":"<p>New costumes in store for this spooky season</p>","sender_id":991267834,"state":"live","labels":["New","Product","Update"],"cover_image_url":null,"reactions":["😆","😅"],"deliver_silently":true,"created_at":1734537797,"updated_at":1734537797,"published_at":1734537797,"newsfeed_assignments":[{"newsfeed_id":53,"published_at":1664638214}]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items/post/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Title missing":{"value":{"type":"error.list","request_id":"5a2e8d16-9b47-4c30-8f6a-1c84e7b59d22","errors":[{"code":"parameter_not_found","message":"Title is a required parameter"}]},"key":"Title missing","summary":"Title missing","id":"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Title missing"},"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Sender missing":{"value":{"type":"error.list","request_id":"7c93f4b8-2d16-4a59-93e7-6b0d85f1c4a3","errors":[{"code":"parameter_not_found","message":"sender_id is a required parameter"}]},"key":"Sender missing","summary":"Sender missing","id":"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Sender missing"},"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid cover image URL":{"value":{"type":"error.list","request_id":"9e51a7c2-4f38-4b6d-a27c-85d3f960e1b4","errors":[{"code":"parameter_invalid","message":"Invalid cover image URL. Must be a valid url of a PNG or JPG file"}]},"key":"Invalid cover image URL","summary":"Invalid cover image URL","id":"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid cover image URL"},"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Newsfeed does not exist":{"value":{"type":"error.list","request_id":"2b86d053-7e14-49af-8c35-4a71e2d9f806","errors":[{"code":"parameter_invalid","message":"Newsfeed with id 123 does not exist"}]},"key":"Newsfeed does not exist","summary":"Newsfeed does not exist","id":"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Newsfeed does not exist"},"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid state":{"value":{"type":"error.list","request_id":"8d40b2f7-3c95-4e18-a6d1-5f27c09e4b83","errors":[{"code":"parameter_invalid","message":"Invalid state. State can either be draft or live"}]},"key":"Invalid state","summary":"Invalid state","id":"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Invalid state"},"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Published date in the future":{"value":{"type":"error.list","request_id":"a3e61c58-7b04-4f92-8d3e-1c69f5b20a47","errors":[{"code":"parameter_invalid","message":"Invalid published_at 4102444800. Date cannot be in the future. Scheduling is not supported through API"}]},"key":"Published date in the future","summary":"Published date in the future","id":"paths/~1news~1news_items/post/responses/400/content/application~1json/examples/Published date in the future"},"paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5142ad8e-883e-4b71-9adb-6494851e9b77","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"6f02b3a9-1c74-4d85-ae29-50b7c38d6e14","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1news_items/post/responses/404/content/application~1json/examples/Sender Not Found":{"value":{"type":"error.list","request_id":"4d19c6e7-8a52-4f03-b67d-93e5017ac2b8","errors":[{"code":"not_found","message":"Admin not found"}]},"key":"Sender Not Found","summary":"Sender Not Found","id":"paths/~1news~1news_items/post/responses/404/content/application~1json/examples/Sender Not Found"},"paths/~1news~1news_items~1{news_item_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"34","type":"news-item","workspace_id":"this_is_an_id538_that_should_be_at_least_","title":"We have news","body":"<p>Hello there,</p>","sender_id":991267837,"state":"live","labels":[],"cover_image_url":null,"reactions":[],"deliver_silently":false,"created_at":1734537800,"updated_at":1734537800,"published_at":1734537800,"newsfeed_assignments":[{"newsfeed_id":55,"published_at":1734537800}]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{news_item_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"33ff62c6-ceb7-4bde-93d6-301bed6f24b2","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"0c63f8b1-5d27-4e94-82a6-7f91b35ce0d8","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1news_items~1{news_item_id}/get/responses/404/content/application~1json/examples/News Item Not Found":{"value":{"type":"error.list","request_id":"da84e250-8626-47e8-815c-62b33f0f2c36","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"News Item Not Found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{news_item_id}/get/responses/404/content/application~1json/examples/News Item Not Found"},"paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>","sender_id":991267845,"reactions":["😝","😂"]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found":{"value":{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>","sender_id":991267848,"reactions":["😝","😂"]},"key":"news_item_not_found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{news_item_id}/put/requestBody/content/application~1json/examples/news_item_not_found"},"paths/~1news~1news_items~1{news_item_id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"37","type":"news-item","workspace_id":"this_is_an_id544_that_should_be_at_least_","title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>","sender_id":991267845,"state":"live","labels":[],"cover_image_url":null,"reactions":["😝","😂"],"deliver_silently":false,"created_at":1734537803,"updated_at":1734537804,"published_at":1734537804,"newsfeed_assignments":[]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid cover image URL":{"value":{"type":"error.list","request_id":"1e58a2c9-7f43-4b06-95d1-3c82e67a4f90","errors":[{"code":"parameter_invalid","message":"Invalid cover image URL. Must be a valid url of a PNG or JPG file"}]},"key":"Invalid cover image URL","summary":"Invalid cover image URL","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid cover image URL"},"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid state":{"value":{"type":"error.list","request_id":"3a91d7f5-2e68-4c47-b830-6d15f92b8c07","errors":[{"code":"parameter_invalid","message":"Invalid state. State can either be draft or live"}]},"key":"Invalid state","summary":"Invalid state","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Invalid state"},"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Newsfeed does not exist":{"value":{"type":"error.list","request_id":"5c74e019-4a3b-4d62-8e15-9f07a2c631d4","errors":[{"code":"parameter_invalid","message":"Newsfeed with id 123 does not exist"}]},"key":"Newsfeed does not exist","summary":"Newsfeed does not exist","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Newsfeed does not exist"},"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Published date in the future":{"value":{"type":"error.list","request_id":"f27c9d14-5a68-4b3e-90c2-7e81a4d6b359","errors":[{"code":"parameter_invalid","message":"Invalid published_at 4102444800. Date cannot be in the future. Scheduling is not supported through API"}]},"key":"Published date in the future","summary":"Published date in the future","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/400/content/application~1json/examples/Published date in the future"},"paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5838c54e-dd15-460b-82dd-794c4d0e12c5","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"9d36c851-8e05-4a7b-b492-1a63f58d720e","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item Not Found":{"value":{"type":"error.list","request_id":"2014d867-b634-495a-9b4f-ce56c4d657a9","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"News Item Not Found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item Not Found"},"paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/Sender Not Found":{"value":{"type":"error.list","request_id":"7b20f6a4-6c81-4e39-a05b-2d48e71c9035","errors":[{"code":"not_found","message":"Admin not found"}]},"key":"Sender Not Found","summary":"Sender Not Found","id":"paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/Sender Not Found"},"paths/~1news~1news_items~1{news_item_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"40","object":"news-item","deleted":true},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{news_item_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e5357876-89be-4a04-80c3-16735b7f53ff","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"2f85b4d7-0a19-4c63-8e74-5b92d16fa038","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1news_items~1{news_item_id}/delete/responses/404/content/application~1json/examples/News Item Not Found":{"value":{"type":"error.list","request_id":"23728e22-7b9f-44a9-9b8d-5028811b9cd0","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"News Item Not Found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{news_item_id}/delete/responses/404/content/application~1json/examples/News Item Not Found"},"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"page":1,"per_page":20,"total_pages":0,"type":"pages"},"data":[],"total_count":0},"key":"successful","summary":"successful","id":"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/400/content/application~1json/examples/Per page too small":{"value":{"type":"error.list","request_id":"4a07e9b3-2c56-4f81-96d0-8e34b15c7d92","errors":[{"code":"parameter_invalid","message":"Per Page is too small"}]},"key":"Per page too small","summary":"Per page too small","id":"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/400/content/application~1json/examples/Per page too small"},"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"022ff8b0-d16f-437c-8217-754c13e16dee","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"8e71a3c6-6b90-4d48-85f2-3a07c14e9d26","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/404/content/application~1json/examples/Newsfeed Not Found":{"value":{"type":"error.list","request_id":"6c58d1f0-4e73-4a25-b8c9-0f26a93e5b14","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Newsfeed Not Found","summary":"Newsfeed Not Found","id":"paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/404/content/application~1json/examples/Newsfeed Not Found"},"paths/~1news~1newsfeeds/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"page":1,"per_page":10,"total_pages":1,"type":"pages"},"data":[{"id":"68","type":"newsfeed","name":"Visitor Feed","created_at":1734537813,"updated_at":1734537813},{"id":"69","type":"newsfeed","name":"Visitor Feed","created_at":1734537813,"updated_at":1734537813}],"total_count":2},"key":"successful","summary":"successful","id":"paths/~1news~1newsfeeds/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1newsfeeds/get/responses/400/content/application~1json/examples/Per page too small":{"value":{"type":"error.list","request_id":"0b94f5e2-8d17-4b60-a3c7-5e29d60b847f","errors":[{"code":"parameter_invalid","message":"Per Page is too small"}]},"key":"Per page too small","summary":"Per page too small","id":"paths/~1news~1newsfeeds/get/responses/400/content/application~1json/examples/Per page too small"},"paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"caa26d8b-6512-445d-9418-9fc5849ca304","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"2d16c7a8-0f34-4e82-9b51-7c40e83f6a95","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"72","type":"newsfeed","name":"Visitor Feed","created_at":1734537815,"updated_at":1734537815},"key":"successful","summary":"successful","id":"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"6d9a1bf5-aa08-4c93-a61a-5a21130b6553","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"1a7d35c0-6e82-4b49-9f13-48c0d2e671ba","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/404/content/application~1json/examples/Newsfeed Not Found":{"value":{"type":"error.list","request_id":"4f38e9b0-2a51-4c06-83d7-9e62f05a1b48","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Newsfeed Not Found","summary":"Newsfeed Not Found","id":"paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/404/content/application~1json/examples/Newsfeed Not Found"},"paths/~1notes~1{note_id}/get/responses/200/content/application~1json/examples/Note found":{"value":{"type":"note","id":"34","created_at":1733846617,"contact":{"type":"contact","id":"6762f2591bb69f9f2193bc1f"},"author":{"type":"admin","id":"991267864","name":"Ciaran346 Lee","email":"admin346@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>This is a note.</p>"},"key":"Note found","summary":"Note found","id":"paths/~1notes~1{note_id}/get/responses/200/content/application~1json/examples/Note found"},"paths/~1notes~1{note_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"81384687-5818-4df9-b421-fba77edd6c17","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1notes~1{note_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1notes~1{note_id}/get/responses/404/content/application~1json/examples/Note not found":{"value":{"type":"error.list","request_id":"bc300b1a-492a-405f-924e-a5881cb72e3a","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Note not found","summary":"Note not found","id":"paths/~1notes~1{note_id}/get/responses/404/content/application~1json/examples/Note not found"},"paths/~1notes~1{note_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"34","type":"note","deleted":true},"key":"successful","summary":"successful","id":"paths/~1notes~1{note_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1notes~1{note_id}/delete/responses/400/content/application~1json/examples/Resource not available":{"value":{"type":"error.list","request_id":"9a2d6e4b-7c1f-4a83-b6d0-2f8e5c1a9b37","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Resource not available","summary":"Resource not available","id":"paths/~1notes~1{note_id}/delete/responses/400/content/application~1json/examples/Resource not available"},"paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e3f0a9c1-2b4d-4e6a-8c7f-1d5b9a3e6f02","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"b24e8f37-0a91-4d5c-9e76-38c1b0da5f62","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1notes~1{note_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1notes~1{note_id}/delete/responses/404/content/application~1json/examples/Note not found":{"value":{"type":"error.list","request_id":"5c1ca6c7-6f5e-4d4b-9f52-3a2e1c9d7b64","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Note not found","summary":"Note not found","id":"paths/~1notes~1{note_id}/delete/responses/404/content/application~1json/examples/Note not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/200/content/application~1json/examples/Office hours exception found":{"value":{"type":"office_hours_exception","id":"456","office_hours_schedule_id":"123","exception_date":"2026-12-25","exception_type":"closed","name":"Christmas Day","time_intervals":null,"recurring_annually":true,"created_at":1717200000,"updated_at":1717200000},"key":"Office hours exception found","summary":"Office hours exception found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/200/content/application~1json/examples/Office hours exception found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours exception not found":{"value":{"type":"error.list","request_id":"f58c31d2-a33c-41e2-ad14-d2c7e907f5fd","errors":[{"code":"office_hours_exception_not_found","message":"Office hours exception not found"}]},"key":"Office hours exception not found","summary":"Office hours exception not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/Office hours exception not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception":{"value":{"exception_type":"custom_hours","name":"Christmas Day (reduced hours)","time_intervals":[{"start_minute":540,"end_minute":780}],"recurring_annually":true},"key":"Update exception","summary":"Update exception","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/requestBody/content/application~1json/examples/Update exception"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/200/content/application~1json/examples/Office hours exception updated":{"value":{"type":"office_hours_exception","id":"456","office_hours_schedule_id":"123","exception_date":"2026-12-25","exception_type":"custom_hours","name":"Christmas Day (reduced hours)","time_intervals":[{"start_minute":540,"end_minute":780,"day_of_week":4}],"recurring_annually":true,"created_at":1717200000,"updated_at":1717203600},"key":"Office hours exception updated","summary":"Office hours exception updated","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/200/content/application~1json/examples/Office hours exception updated"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/400/content/application~1json/examples/Unknown field":{"value":{"type":"error.list","request_id":"3b886172-7c30-49c4-adcd-64c4da2cc22c","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :day_of_week"}]},"key":"Unknown field","summary":"Unknown field","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/400/content/application~1json/examples/Unknown field"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours exception not found":{"value":{"type":"error.list","request_id":"f58c31d2-a33c-41e2-ad14-d2c7e907f5fd","errors":[{"code":"office_hours_exception_not_found","message":"Office hours exception not found"}]},"key":"Office hours exception not found","summary":"Office hours exception not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/Office hours exception not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Intervals on a closed exception":{"value":{"type":"error.list","request_id":"f14c2e4e-484b-4960-af3a-46636c3ad153","errors":[{"code":"parameter_invalid","message":"time_intervals must not be provided for a closed exception"}]},"key":"Intervals on a closed exception","summary":"Intervals on a closed exception","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Intervals on a closed exception"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid":{"value":{"type":"error.list","request_id":"cca3b23b-1fb4-444d-a793-1099086544ff","errors":[{"code":"parameter_invalid","message":"time_intervals start_minute and end_minute must be integers on a 15-minute boundary"}]},"key":"Interval off the 15-minute grid","summary":"Interval off the 15-minute grid","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Invalid exception_type":{"value":{"type":"error.list","request_id":"b9c61923-b499-4ac3-a5ac-5b5b9d7a7d45","errors":[{"code":"parameter_invalid","message":"Exception type must be 'closed' or 'custom_hours'"}]},"key":"Invalid exception_type","summary":"Invalid exception_type","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/Invalid exception_type"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/200/content/application~1json/examples/Office hours exception deleted":{"value":{"id":"456","object":"office_hours_exception","deleted":true},"key":"Office hours exception deleted","summary":"Office hours exception deleted","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/200/content/application~1json/examples/Office hours exception deleted"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours exception not found":{"value":{"type":"error.list","request_id":"f58c31d2-a33c-41e2-ad14-d2c7e907f5fd","errors":[{"code":"office_hours_exception_not_found","message":"Office hours exception not found"}]},"key":"Office hours exception not found","summary":"Office hours exception not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/Office hours exception not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"office_hours_exception.list","data":[{"type":"office_hours_exception","id":"457","office_hours_schedule_id":"123","exception_date":"2026-12-24","exception_type":"custom_hours","name":"Christmas Eve","time_intervals":[{"start_minute":540,"end_minute":780,"day_of_week":3}],"recurring_annually":true,"created_at":1717200000,"updated_at":1717200000},{"type":"office_hours_exception","id":"456","office_hours_schedule_id":"123","exception_date":"2026-12-25","exception_type":"closed","name":"Christmas Day","time_intervals":null,"recurring_annually":true,"created_at":1717200000,"updated_at":1717200000}]},"key":"Successful response","summary":"Successful response","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception":{"value":{"exception_date":"2026-12-25","exception_type":"closed","name":"Christmas Day","recurring_annually":true},"key":"Create exception","summary":"Create exception","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/requestBody/content/application~1json/examples/Create exception"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/201/content/application~1json/examples/Office hours exception created":{"value":{"type":"office_hours_exception","id":"458","office_hours_schedule_id":"123","exception_date":"2026-12-25","exception_type":"closed","name":"Christmas Day","time_intervals":null,"recurring_annually":true,"created_at":1717200000,"updated_at":1717200000},"key":"Office hours exception created","summary":"Office hours exception created","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/201/content/application~1json/examples/Office hours exception created"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/400/content/application~1json/examples/Unknown field":{"value":{"type":"error.list","request_id":"e6180ccb-38df-4f47-aa82-97eb5c6c1482","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :day_of_week"}]},"key":"Unknown field","summary":"Unknown field","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/400/content/application~1json/examples/Unknown field"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing exception_type":{"value":{"type":"error.list","request_id":"6f68d983-3afb-4ddc-a5fc-0181f07a0da0","errors":[{"code":"parameter_not_found","message":"exception_type is required when creating an exception"}]},"key":"Missing exception_type","summary":"Missing exception_type","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing exception_type"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Intervals on a closed exception":{"value":{"type":"error.list","request_id":"f14c2e4e-484b-4960-af3a-46636c3ad153","errors":[{"code":"parameter_invalid","message":"time_intervals must not be provided for a closed exception"}]},"key":"Intervals on a closed exception","summary":"Intervals on a closed exception","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Intervals on a closed exception"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing time_intervals":{"value":{"type":"error.list","request_id":"aa205b58-370f-4ddd-adc1-82381d9555e8","errors":[{"code":"parameter_invalid","message":"Time intervals are required for custom hours exceptions"}]},"key":"Missing time_intervals","summary":"Missing time_intervals","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Missing time_intervals"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Duplicate date":{"value":{"type":"error.list","request_id":"72a58e2b-58f7-4af2-ad85-1922f1a26479","errors":[{"code":"parameter_invalid","message":"An exception already exists for this date"}]},"key":"Duplicate date","summary":"Duplicate date","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Duplicate date"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid":{"value":{"type":"error.list","request_id":"cca3b23b-1fb4-444d-a793-1099086544ff","errors":[{"code":"parameter_invalid","message":"time_intervals start_minute and end_minute must be integers on a 15-minute boundary"}]},"key":"Interval off the 15-minute grid","summary":"Interval off the 15-minute grid","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid"},"paths/~1office_hours_schedules~1{id}/get/responses/200/content/application~1json/examples/Office hours schedule found":{"value":{"type":"office_hours_schedule","id":"123","name":"Standard Support Hours","time_zone_name":"America/New_York","time_intervals":[{"start_minute":540,"end_minute":1020,"day_of_week":0}],"twenty_four_seven":false,"created_at":1717200000,"updated_at":1717200000},"key":"Office hours schedule found","summary":"Office hours schedule found","id":"paths/~1office_hours_schedules~1{id}/get/responses/200/content/application~1json/examples/Office hours schedule found"},"paths/~1office_hours_schedules~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule":{"value":{"name":"Extended Support Hours","time_intervals":[{"start_minute":480,"end_minute":1080}]},"key":"Update schedule","summary":"Update schedule","id":"paths/~1office_hours_schedules~1{id}/put/requestBody/content/application~1json/examples/Update schedule"},"paths/~1office_hours_schedules~1{id}/put/responses/200/content/application~1json/examples/Office hours schedule updated":{"value":{"type":"office_hours_schedule","id":"123","name":"Extended Support Hours","time_zone_name":"America/New_York","time_intervals":[{"start_minute":480,"end_minute":1080,"day_of_week":0}],"twenty_four_seven":false,"created_at":1717200000,"updated_at":1717203600},"key":"Office hours schedule updated","summary":"Office hours schedule updated","id":"paths/~1office_hours_schedules~1{id}/put/responses/200/content/application~1json/examples/Office hours schedule updated"},"paths/~1office_hours_schedules~1{id}/put/responses/400/content/application~1json/examples/Unknown field":{"value":{"type":"error.list","request_id":"8a13f337-edee-4f90-adaa-52dd58dfd63c","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :day_of_week"}]},"key":"Unknown field","summary":"Unknown field","id":"paths/~1office_hours_schedules~1{id}/put/responses/400/content/application~1json/examples/Unknown field"},"paths/~1office_hours_schedules~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Duplicate name":{"value":{"type":"error.list","request_id":"e7bfd750-7e4b-44c0-a711-e8ab09e0b897","errors":[{"code":"parameter_invalid","message":"A schedule already exists with this name"}]},"key":"Duplicate name","summary":"Duplicate name","id":"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Duplicate name"},"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid":{"value":{"type":"error.list","request_id":"36146ba3-853f-482c-a9b2-435c6848a0c2","errors":[{"code":"parameter_invalid","message":"time_intervals start_minute and end_minute must be integers on a 15-minute boundary"}]},"key":"Interval off the 15-minute grid","summary":"Interval off the 15-minute grid","id":"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Interval off the 15-minute grid"},"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Invalid time zone":{"value":{"type":"error.list","request_id":"b46c814a-bafd-4ad4-a84f-416f753c9096","errors":[{"code":"parameter_invalid","message":"Time zone is invalid"}]},"key":"Invalid time zone","summary":"Invalid time zone","id":"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/Invalid time zone"},"paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted":{"value":{"id":"123","object":"office_hours_schedule","deleted":true},"key":"Office hours schedule deleted","summary":"Office hours schedule deleted","id":"paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted"},"paths/~1office_hours_schedules~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found":{"value":{"type":"error.list","request_id":"01664eba-f831-4abf-a194-acf282811d5d","errors":[{"code":"office_hours_schedule_not_found","message":"Office hours schedule not found"}]},"key":"Office hours schedule not found","summary":"Office hours schedule not found","id":"paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/Office hours schedule not found"},"paths/~1office_hours_schedules~1{id}/delete/responses/422/content/application~1json/examples/Default schedule":{"value":{"type":"error.list","request_id":"1c24c1c0-009f-44f8-ab8f-35f607ef0a83","errors":[{"code":"parameter_invalid","message":"Cannot delete the default office hours."}]},"key":"Default schedule","summary":"Default schedule","id":"paths/~1office_hours_schedules~1{id}/delete/responses/422/content/application~1json/examples/Default schedule"},"paths/~1office_hours_schedules/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"office_hours_schedule.list","data":[{"type":"office_hours_schedule","id":"123","name":"Standard Support Hours","time_zone_name":"America/New_York","time_intervals":[{"start_minute":540,"end_minute":1020,"day_of_week":0},{"start_minute":1980,"end_minute":2460,"day_of_week":1}],"twenty_four_seven":false,"created_at":1717200000,"updated_at":1717200000}]},"key":"Successful response","summary":"Successful response","id":"paths/~1office_hours_schedules/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1office_hours_schedules/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule":{"value":{"name":"Standard Support Hours","time_zone_name":"America/New_York","time_intervals":[{"start_minute":540,"end_minute":1020}]},"key":"Create schedule","summary":"Create schedule","id":"paths/~1office_hours_schedules/post/requestBody/content/application~1json/examples/Create schedule"},"paths/~1office_hours_schedules/post/responses/201/content/application~1json/examples/Office hours schedule created":{"value":{"type":"office_hours_schedule","id":"125","name":"Standard Support Hours","time_zone_name":"America/New_York","time_intervals":[{"start_minute":540,"end_minute":1020,"day_of_week":0}],"twenty_four_seven":false,"created_at":1717200000,"updated_at":1717200000},"key":"Office hours schedule created","summary":"Office hours schedule created","id":"paths/~1office_hours_schedules/post/responses/201/content/application~1json/examples/Office hours schedule created"},"paths/~1office_hours_schedules/post/responses/400/content/application~1json/examples/Unknown field":{"value":{"type":"error.list","request_id":"5c7edb8e-8f11-4cfc-a8b8-d2f0f80d432e","errors":[{"code":"parameter_invalid","message":"found unpermitted parameter: :day_of_week"}]},"key":"Unknown field","summary":"Unknown field","id":"paths/~1office_hours_schedules/post/responses/400/content/application~1json/examples/Unknown field"},"paths/~1office_hours_schedules/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1office_hours_schedules/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Missing time_intervals":{"value":{"type":"error.list","request_id":"074541fe-2ac8-45f6-a367-263b43483ef9","errors":[{"code":"parameter_not_found","message":"time_intervals is required when creating a new schedule"}]},"key":"Missing time_intervals","summary":"Missing time_intervals","id":"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Missing time_intervals"},"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Duplicate name":{"value":{"type":"error.list","request_id":"e7bfd750-7e4b-44c0-a711-e8ab09e0b897","errors":[{"code":"parameter_invalid","message":"A schedule already exists with this name"}]},"key":"Duplicate name","summary":"Duplicate name","id":"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Duplicate name"},"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid":{"value":{"type":"error.list","request_id":"36146ba3-853f-482c-a9b2-435c6848a0c2","errors":[{"code":"parameter_invalid","message":"time_intervals start_minute and end_minute must be integers on a 15-minute boundary"}]},"key":"Interval off the 15-minute grid","summary":"Interval off the 15-minute grid","id":"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Interval off the 15-minute grid"},"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Invalid time zone":{"value":{"type":"error.list","request_id":"b46c814a-bafd-4ad4-a84f-416f753c9096","errors":[{"code":"parameter_invalid","message":"Time zone is invalid"}]},"key":"Invalid time zone","summary":"Invalid time zone","id":"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/Invalid time zone"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No dataset_id":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"'dataset_id' is a required parameter"}]},"key":"No dataset_id","summary":"No dataset_id","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No dataset_id"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid dataset_id":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"imaginary is not a valid dataset_id"}]},"key":"Invalid dataset_id","summary":"Invalid dataset_id","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid dataset_id"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No attribute_ids":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"'attribute_ids' is a required parameter"}]},"key":"No attribute_ids","summary":"No attribute_ids","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/No attribute_ids"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Empty attribute_ids":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"attribute_ids must contain at least one attribute_id"}]},"key":"Empty attribute_ids","summary":"Empty attribute_ids","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Empty attribute_ids"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Non array attribute_ids":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"'attribute_ids: not an array' must be of type Array"}]},"key":"Non array attribute_ids","summary":"Non array attribute_ids","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Non array attribute_ids"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid attribute_ids":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"attribute_ids invalid for conversation dataset: non_existent"}]},"key":"Invalid attribute_ids","summary":"Invalid attribute_ids","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Invalid attribute_ids"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unqualified attribute_ids":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"attribute_ids must use qualified_id format (e.g., 'people.Brand' instead of 'Brand'). Use the qualified_id from the get_datasets response. Unqualified ids: conversation_id"}]},"key":"Unqualified attribute_ids","summary":"Unqualified attribute_ids","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unqualified attribute_ids"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/start_time too far in the past":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"'start_time' parameter too far in past (more than 2 years)"}]},"key":"start_time too far in the past","summary":"start_time too far in the past","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/start_time too far in the past"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/end_time before start_time":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"end_time is less than start_time"}]},"key":"end_time before start_time","summary":"end_time before start_time","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/end_time before start_time"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unknown parameter":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"bad_request","message":"bad 'unknown_field' parameter"}]},"key":"Unknown parameter","summary":"Unknown parameter","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Unknown parameter"},"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1export~1reporting_data~1enqueue/post/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1export~1reporting_data~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1reporting_data~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1export~1reporting_data~1enqueue/post/responses/429/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"rate_limit_exceeded","message":"Exceeded rate limit of 5 pending reporting dataset export jobs"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1reporting_data~1enqueue/post/responses/429/content/application~1json/examples/Unauthorized"},"paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With pending status":{"value":{"job_identifier":"job1","status":"pending","download_url":"","download_expires_at":""},"key":"With pending status","summary":"With pending status","id":"paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With pending status"},"paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With complete status":{"value":{"job_identifier":"job1","status":"complete","download_url":"https://api.intercom.io/download/reporting_data/job1","download_expires_at":1788480000},"key":"With complete status","summary":"With complete status","id":"paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With complete status"},"paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With failed status":{"value":{"job_identifier":"job1","status":"failed","download_url":"","download_expires_at":""},"key":"With failed status","summary":"With failed status","id":"paths/~1export~1reporting_data~1{job_identifier}/get/responses/200/content/application~1json/examples/With failed status"},"paths/~1export~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1export~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1export~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1export~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"not_found","message":"Export job not found for identifier: job1"}]},"key":"Not found","summary":"Not found","id":"paths/~1export~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1export~1reporting_data~1get_datasets/get/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1export~1reporting_data~1get_datasets/get/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1export~1reporting_data~1get_datasets/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1reporting_data~1get_datasets/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1download~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"intercom_version_invalid","message":"Requested resource is not available in current API version"}]},"key":"Not available in this API version","summary":"Not available in this API version","id":"paths/~1download~1reporting_data~1{job_identifier}/get/responses/400/content/application~1json/examples/Not available in this API version"},"paths/~1download~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1download~1reporting_data~1{job_identifier}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"not_found","message":"Export job not found for identifier: job1"}]},"key":"Not found","summary":"Not found","id":"paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Export file not found":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"not_found","message":"Object not found"}]},"key":"Export file not found","summary":"Export file not found","id":"paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Export file not found"},"paths/~1roles/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"role","id":"991267902","name":"Support Lead","description":"Can view and reply to conversations"}]},"key":"successful","summary":"successful","id":"paths/~1roles/get/responses/200/content/application~1json/examples/successful"},"paths/~1roles/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a77dadbc-1f1e-4875-bac3-f0d09bbc214a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1roles/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1roles~1{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"role","id":"991267902","name":"Support Lead","description":"Can view and reply to conversations"},"key":"successful","summary":"successful","id":"paths/~1roles~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1roles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"fc4b741b-b9f1-4ef9-92c7-eb71e9811df3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1roles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1roles~1{id}/get/responses/404/content/application~1json/examples/Role not found":{"value":{"type":"error.list","request_id":"3ff156ba-a66e-40d4-93ff-cb6e6afc3c9d","errors":[{"code":"role_not_found","message":"Role not found"}]},"key":"Role not found","summary":"Role not found","id":"paths/~1roles~1{id}/get/responses/404/content/application~1json/examples/Role not found"},"paths/~1segments/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"segment.list","segments":[{"type":"segment","id":"6762f25c1bb69f9f2193bc22","name":"John segment","created_at":1734537820,"updated_at":1734537820,"person_type":"user"},{"type":"segment","id":"6762f25c1bb69f9f2193bc23","name":"Jane segment","created_at":1734537820,"updated_at":1734537820,"person_type":"user"}]},"key":"Successful response","summary":"Successful response","id":"paths/~1segments/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b1939528-98f0-4a63-a442-2cc9203fc8c7","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"5fa31c82-7d64-4e09-b1a7-9c48d0e35b61","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1segments/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1segments~1{segment_id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"segment","id":"6762f25f1bb69f9f2193bc26","name":"John segment","created_at":1734537823,"updated_at":1734537823,"person_type":"user"},"key":"Successful response","summary":"Successful response","id":"paths/~1segments~1{segment_id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"be0d5309-d722-4d2a-aae9-77f4bc0a2cd0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"36b0d794-82ce-4a15-9f63-71d4ea80c592","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1segments~1{segment_id}/get/responses/404/content/application~1json/examples/Segment not found":{"value":{"type":"error.list","request_id":"bd697cc6-7757-488c-a89f-16e6feaf7585","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Segment not found","summary":"Segment not found","id":"paths/~1segments~1{segment_id}/get/responses/404/content/application~1json/examples/Segment not found"},"paths/~1subscription_types/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"type":"subscription","id":"135","state":"live","consent_type":"opt_out","default_translation":{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"},"translations":[{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"}],"content_types":["email"]}]},"key":"Successful","summary":"Successful","id":"paths/~1subscription_types/get/responses/200/content/application~1json/examples/Successful"},"paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"06d15b1f-19b0-42cc-aff9-a9d9db39402b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1subscription_types/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"e8471b06-3d25-4c9f-b0a8-57fe2d619c3a","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1subscription_types/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1subscription_types~1{id}/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"subscription","id":"135","state":"live","consent_type":"opt_out","default_translation":{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"},"translations":[{"name":"Newsletters","description":"Lorem ipsum dolor sit amet","locale":"en"}],"content_types":["email"]},"key":"Successful","summary":"Successful","id":"paths/~1subscription_types~1{id}/get/responses/200/content/application~1json/examples/Successful"},"paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9d3f28a5-6e07-4b14-8c92-45a0f7d6b318","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"41c7e95b-08a3-4d62-97f1-6b2d5c8a034e","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1subscription_types~1{id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1subscription_types~1{id}/get/responses/404/content/application~1json/examples/Subscription type not found":{"value":{"type":"error.list","request_id":"5c1d8f0e-3b7a-4a52-9c21-7e6d4b8f2a10","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Subscription type not found","summary":"Subscription type not found","id":"paths/~1subscription_types~1{id}/get/responses/404/content/application~1json/examples/Subscription type not found"},"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful":{"value":{"phone":"+353832345678","custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"successful","summary":"successful","id":"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/successful"},"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms":{"value":{"phone":"+353832345678","custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"bad_request_-_exception_sending_sms","summary":"bad request - exception sending sms","id":"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_exception_sending_sms"},"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number":{"value":{"phone":"+353832345678","custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"bad_request_-_invalid_number","summary":"bad request - invalid number","id":"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/bad_request_-_invalid_number"},"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity":{"value":{"phone":"+40241100100","custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"unprocessable_entity","summary":"unprocessable entity","id":"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/unprocessable_entity"},"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number":{"value":{"custom_attributes":{"issue_type":"Billing","priority":"High"}},"key":"missing_phone_number","summary":"Missing phone number","id":"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/missing_phone_number"},"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes":{"value":{"phone":"+353832345678","custom_attributes":{"issue_type":["Billing"]}},"key":"invalid_custom_attributes","summary":"Invalid custom attributes","id":"paths/~1phone_call_redirects/post/requestBody/content/application~1json/examples/invalid_custom_attributes"},"paths/~1phone_call_redirects/post/responses/200/content/application~1json/examples/successful":{"value":{"url":"http://via.intercom.io/msgr/1add3dd1-a75e-4a96-96fd-984d16aba059","type":"phone_call_redirect"},"key":"successful","summary":"successful","id":"paths/~1phone_call_redirects/post/responses/200/content/application~1json/examples/successful"},"paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - exception sending sms":{"value":{"error_key":"sms_failed","message":"SMS was not sent due to an unknown error"},"key":"bad request - exception sending sms","summary":"bad request - exception sending sms","id":"paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - exception sending sms"},"paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - invalid number":{"value":{"error_key":"invalid_phone_number","message":"Invalid phone number"},"key":"bad request - invalid number","summary":"bad request - invalid number","id":"paths/~1phone_call_redirects/post/responses/400/content/application~1json/examples/bad request - invalid number"},"paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e1ed4f34-9477-492a-8ddb-22f10af39734","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Feature not available":{"value":{"type":"error.list","request_id":"79b635fd-f1f6-4404-aa83-5782675987fb","errors":[{"code":"unauthorized","message":"App does not have access to this feature"}]},"key":"Feature not available","summary":"Feature not available","id":"paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Feature not available"},"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid phone number":{"value":{"error_key":"invalid_phone_number"},"key":"Invalid phone number","summary":"Invalid phone number","id":"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid phone number"},"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity":{"value":{"error_key":"landline_phone"},"key":"unprocessable entity","summary":"unprocessable entity","id":"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity"},"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Twilio account not found":{"value":{"error_key":"twilio_settings"},"key":"Twilio account not found","summary":"Twilio account not found","id":"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Twilio account not found"},"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Missing phone number":{"value":{"error_key":"caller_phone"},"key":"Missing phone number","summary":"Missing phone number","id":"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Missing phone number"},"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid custom attributes":{"value":{"error_key":"context"},"key":"Invalid custom attributes","summary":"Invalid custom attributes","id":"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/Invalid custom attributes"},"paths/~1tags/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"tag","id":"102","name":"Manual tag 1"}]},"key":"successful","summary":"successful","id":"paths/~1tags/get/responses/200/content/application~1json/examples/successful"},"paths/~1tags/get/responses/200/content/application~1json/examples/single tag":{"value":{"type":"tag","id":"102","name":"Manual tag 1"},"key":"single tag","summary":"single tag","id":"paths/~1tags/get/responses/200/content/application~1json/examples/single tag"},"paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2859da57-c83f-405c-8166-240a312442a3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"7a4e0c61-9b35-4d28-8f70-c2a916e5473d","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1tags/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1tags/get/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"0c93d5a8-62f1-4e37-b54a-8d7016c9f2be","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1tags/get/responses/404/content/application~1json/examples/Tag not found"},"paths/~1tags/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"93e157b4-d0a2-4c86-bf39-5e702a1c4d86","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1tags/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1tags/get/responses/404/content/application~1json/examples/Company not found":{"value":{"type":"error.list","request_id":"2d6f81e0-4a37-49b5-91c8-607de4a2b3f5","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company not found","summary":"Company not found","id":"paths/~1tags/get/responses/404/content/application~1json/examples/Company not found"},"paths/~1tags/post/requestBody/content/application~1json/examples/action_successful":{"value":{"name":"test"},"key":"action_successful","summary":"Action successful","id":"paths/~1tags/post/requestBody/content/application~1json/examples/action_successful"},"paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged":{"value":{"name":"test","companies":[{"company_id":"6"}]},"key":"companies_tagged","summary":"Companies tagged","id":"paths/~1tags/post/requestBody/content/application~1json/examples/companies_tagged"},"paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters":{"value":{"test":"invalid"},"key":"invalid_parameters","summary":"Invalid parameters","id":"paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters"},"paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped":{"value":{"name":"test","companies":[{"company_id":"123"}]},"key":"unknown_company_skipped","summary":"Unknown company skipped","id":"paths/~1tags/post/requestBody/content/application~1json/examples/unknown_company_skipped"},"paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped":{"value":{"name":"test","users":[{"id":"123"}]},"key":"unknown_user_skipped","summary":"Unknown user skipped","id":"paths/~1tags/post/requestBody/content/application~1json/examples/unknown_user_skipped"},"paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found":{"value":{"name":"test","taggable_type":"user","ids_to_add":["123"]},"key":"contact_in_ids_to_add_not_found","summary":"Contact in ids_to_add not found","id":"paths/~1tags/post/requestBody/content/application~1json/examples/contact_in_ids_to_add_not_found"},"paths/~1tags/post/responses/200/content/application~1json/examples/Action successful":{"value":{"type":"tag","id":"105","name":"test","users":[],"companies":[]},"key":"Action successful","summary":"Action successful","id":"paths/~1tags/post/responses/200/content/application~1json/examples/Action successful"},"paths/~1tags/post/responses/200/content/application~1json/examples/Companies tagged":{"value":{"type":"tag","id":"105","name":"test","users":[],"companies":[{"id":"6329e838deab40166d1a5400","tagged":true}]},"key":"Companies tagged","summary":"Companies tagged","id":"paths/~1tags/post/responses/200/content/application~1json/examples/Companies tagged"},"paths/~1tags/post/responses/400/content/application~1json/examples/Invalid parameters":{"value":{"type":"error.list","request_id":"33a05108-3bf7-411f-a270-72db40b5a31c","errors":[{"code":"parameter_invalid","message":"invalid tag parameters"}]},"key":"Invalid parameters","summary":"Invalid parameters","id":"paths/~1tags/post/responses/400/content/application~1json/examples/Invalid parameters"},"paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f230e3a7-00a9-456b-bf1c-2ad4b7dc49f6","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"6e02b8d5-91c7-4a30-bf68-74d1e953c0a2","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1tags/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1tags/post/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"8f51c0a4-2d79-4e36-9b1a-50c7d2e86f43","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1tags/post/responses/404/content/application~1json/examples/Tag not found"},"paths/~1tags/post/responses/404/content/application~1json/examples/Contact in ids_to_add not found":{"value":{"type":"error.list","request_id":"d7b4169e-35fa-4c80-91d2-6e0853a7bc15","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact in ids_to_add not found","summary":"Contact in ids_to_add not found","id":"paths/~1tags/post/responses/404/content/application~1json/examples/Contact in ids_to_add not found"},"paths/~1tags~1{tag_id}/get/responses/200/content/application~1json/examples/Tag found":{"value":{"type":"tag","id":"113","name":"Manual tag"},"key":"Tag found","summary":"Tag found","id":"paths/~1tags~1{tag_id}/get/responses/200/content/application~1json/examples/Tag found"},"paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c1c0477c-5b80-4874-be65-01ec8a9ffe14","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"a05f7362-c194-4d8b-9e27-f63b85c1d409","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1tags~1{tag_id}/get/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"e20c89d2-29c6-4abb-aa3d-c860e1cec1ca","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1tags~1{tag_id}/get/responses/404/content/application~1json/examples/Tag not found"},"paths/~1tags~1{tag_id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects":{"value":{"type":"error.list","request_id":"28960d1e-a056-46c0-bf18-a0d798eb889f","errors":[{"code":"tag_has_dependent_objects","message":"Unable to delete Tag with dependent objects. Segments: Seg 1."}]},"key":"Tag has dependent objects","summary":"Tag has dependent objects","id":"paths/~1tags~1{tag_id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"},"paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"90a369be-14bb-48d1-8ed6-6287976f6a64","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"1b8e4790-ad35-42f6-8c01-9e5d73a2bf64","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"type":"error.list","request_id":"49536975-bbc5-4a2f-ab8b-7928275cb4d3","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Resource not found"},"paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":121,"admin_id":991267958},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found":{"value":{"id":122,"admin_id":991267963},"key":"ticket_not_found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1tags/post/requestBody/content/application~1json/examples/ticket_not_found"},"paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"121","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}~1tags/post/responses/200/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2bed74fe-1b04-4c07-8813-02c700e8dcad","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"b44cff1d-c6f8-4d60-ab6f-33522cd739d8","errors":[{"code":"ticket_not_found","message":"Ticket not found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1tags/post/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful":{"value":{"admin_id":991267973},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found":{"value":{"admin_id":991267978},"key":"ticket_not_found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/ticket_not_found"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found":{"value":{"admin_id":991267983},"key":"tag_not_found","summary":"Tag not found","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/requestBody/content/application~1json/examples/tag_not_found"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"124","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2e87c98e-4ffc-407e-b7bc-065d4d456ea7","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"734019dc-1d61-4fad-a86e-e3fb06244c4d","errors":[{"code":"ticket_not_found","message":"Ticket not found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"a3658b9a-3562-48a7-8afe-362284632d67","errors":[{"code":"tag_not_found","message":"Tag not found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1tickets~1{ticket_id}~1tags~1{tag_id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1teams/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"team.list","teams":[]},"key":"successful","summary":"successful","id":"paths/~1teams/get/responses/200/content/application~1json/examples/successful"},"paths/~1teams/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a77dadbc-1f1e-4875-bac3-f0d09bbc214a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1teams/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1teams~1{team_id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"team","id":"991267902","name":"team 1","admin_ids":[],"distribution_method":"round_robin"},"key":"successful","summary":"successful","id":"paths/~1teams~1{team_id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1teams~1{team_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"fc4b741b-b9f1-4ef9-92c7-eb71e9811df3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1teams~1{team_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1teams~1{team_id}/get/responses/404/content/application~1json/examples/Team not found":{"value":{"type":"error.list","request_id":"3ff156ba-a66e-40d4-93ff-cb6e6afc3c9d","errors":[{"code":"team_not_found","message":"Team not found"}]},"key":"Team not found","summary":"Team not found","id":"paths/~1teams~1{team_id}/get/responses/404/content/application~1json/examples/Team not found"},"paths/~1teams~1{team_id}~1metrics/get/responses/200/content/application~1json/examples/successful_response":{"value":{"type":"team_metric.list","data":[{"type":"team_metric","admin_id":"123","open":5,"idle":2,"snoozed":1},{"type":"team_metric","admin_id":"456","open":3,"idle":0,"snoozed":2}]},"key":"successful_response","summary":"successful_response","id":"paths/~1teams~1{team_id}~1metrics/get/responses/200/content/application~1json/examples/successful_response"},"paths/~1teams~1{team_id}~1metrics/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1teams~1{team_id}~1metrics/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1teams~1{team_id}~1metrics/get/responses/403/content/application~1json/examples/feature_disabled":{"value":{"type":"error.list","request_id":"req-456","errors":[{"code":"api_plan_restricted","message":"Real-time monitoring is not enabled for your workspace."}]},"key":"feature_disabled","summary":"feature_disabled","id":"paths/~1teams~1{team_id}~1metrics/get/responses/403/content/application~1json/examples/feature_disabled"},"paths/~1teams~1{team_id}~1metrics/get/responses/404/content/application~1json/examples/team_not_found":{"value":{"type":"error.list","request_id":"req-789","errors":[{"code":"team_not_found","message":"Team not found"}]},"key":"team_not_found","summary":"team_not_found","id":"paths/~1teams~1{team_id}~1metrics/get/responses/404/content/application~1json/examples/team_not_found"},"paths/~1ticket_states/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"ticket_state","id":"8269","category":"submitted","internal_label":"Submitted","external_label":"Submitted","ticket_types":{"type":"list","data":[{"type":"ticket_type","id":"55","name":"my-ticket-type-3","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"56","name":"my-ticket-type-4","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"58","name":"my-ticket-type-6","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"}]},"archived":false},{"type":"ticket_state","id":"8270","category":"in_progress","internal_label":"In progress","external_label":"In progress","ticket_types":{"type":"list","data":[{"type":"ticket_type","id":"55","name":"my-ticket-type-3","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"56","name":"my-ticket-type-4","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"58","name":"my-ticket-type-6","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"}]},"archived":false},{"type":"ticket_state","id":"8271","category":"waiting_on_customer","internal_label":"Waiting on customer","external_label":"Waiting on you","ticket_types":{"type":"list","data":[{"type":"ticket_type","id":"55","name":"my-ticket-type-3","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"56","name":"my-ticket-type-4","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"58","name":"my-ticket-type-6","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"}]},"archived":false},{"type":"ticket_state","id":"8272","category":"resolved","internal_label":"Resolved","external_label":"Resolved","ticket_types":{"type":"list","data":[{"type":"ticket_type","id":"55","name":"my-ticket-type-3","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"56","name":"my-ticket-type-4","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"58","name":"my-ticket-type-6","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"}]},"archived":false},{"type":"ticket_state","id":"8273","category":"submitted","internal_label":"Admin label 1","external_label":"User label","ticket_types":{"type":"list","data":[{"type":"ticket_type","id":"55","name":"my-ticket-type-3","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"},{"type":"ticket_type","id":"56","name":"my-ticket-type-4","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"}]},"archived":false},{"type":"ticket_state","id":"8274","category":"submitted","internal_label":"Admin label 2","external_label":"User label","ticket_types":{"type":"list","data":[{"type":"ticket_type","id":"58","name":"my-ticket-type-6","description":"my ticket type description is awesome.","icon":"🦁","archived":false,"is_internal":false,"category":"Back-office"}]},"archived":false}]},"key":"successful","summary":"successful","id":"paths/~1ticket_states/get/responses/200/content/application~1json/examples/successful"},"paths/~1ticket_states/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5e0bd231-7307-42e6-a6ee-babf05bd163b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_states/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created":{"value":{"name":"Attribute Title","description":"Attribute Description","data_type":"string","required_to_create":false},"key":"ticket_type_attribute_created","summary":"Ticket Type Attribute created","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/requestBody/content/application~1json/examples/ticket_type_attribute_created"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/200/content/application~1json/examples/Ticket Type Attribute created":{"value":{"type":"ticket_type_attribute","id":"157","workspace_id":"this_is_an_id640_that_should_be_at_least_","name":"Attribute Title","description":"Attribute Description","data_type":"string","input_options":{"multiline":false},"order":2,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":false,"ticket_type_id":63,"archived":false,"created_at":1734537862,"updated_at":1734537862},"key":"Ticket Type Attribute created","summary":"Ticket Type Attribute created","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/200/content/application~1json/examples/Ticket Type Attribute created"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing name":{"value":{"type":"error.list","request_id":"5e2e5891-1673-417d-a27b-c0ffeecaf367","errors":[{"code":"parameter_invalid","message":"Invalid name parameter - Missing name"}]},"key":"Missing name","summary":"Missing name","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing name"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing data_type":{"value":{"type":"error.list","request_id":"5e2e7780-1680-4180-a280-c0ffeecc8c80","errors":[{"code":"parameter_invalid","message":"Invalid data_type parameter - Missing data type"}]},"key":"Missing data_type","summary":"Missing data_type","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Missing data_type"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Invalid data_type":{"value":{"type":"error.list","request_id":"5e2e966f-168d-4183-a285-c0ffeece2599","errors":[{"code":"parameter_invalid","message":"Invalid data_type parameter - Allowed options: string list integer decimal boolean datetime files"}]},"key":"Invalid data_type","summary":"Invalid data_type","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Invalid data_type"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Duplicate name":{"value":{"type":"error.list","request_id":"5e2eb55e-169a-4186-a28a-c0ffeecfbeb2","errors":[{"code":"parameter_invalid","message":"Ticket type attribute name 'Severity' already exists on this ticket type"}]},"key":"Duplicate name","summary":"Duplicate name","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/Duplicate name"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/List without enough options":{"value":{"type":"error.list","request_id":"5e2ed44d-16a7-4189-a28f-c0ffeed157cb","errors":[{"code":"parameter_invalid","message":"options requires a minimum of 2 items for list type attributes"}]},"key":"List without enough options","summary":"List without enough options","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/400/content/application~1json/examples/List without enough options"},"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"6c9836ed-8485-4f1d-929d-b9d7e153daed","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated":{"value":{"description":"New Attribute Description"},"key":"ticket_type_attribute_updated","summary":"Ticket Type Attribute updated","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"},"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated":{"value":{"type":"ticket_type_attribute","id":"162","workspace_id":"this_is_an_id644_that_should_be_at_least_","name":"name","description":"New Attribute Description","data_type":"string","order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":false,"visible_to_contacts":false,"default":false,"ticket_type_id":65,"archived":false,"created_at":1734537864,"updated_at":1734537864},"key":"Ticket Type Attribute updated","summary":"Ticket Type Attribute updated","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated"},"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"cd303186-b33e-4409-8bfc-5814b176d6e1","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"ticket_type","id":"67","name":"Bug Report","description":"Bug Report Template","icon":"🎟️","workspace_id":"this_is_an_id648_that_should_be_at_least_","archived":false,"created_at":1734537866,"updated_at":1734537866,"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_","name":"_default_title_","description":"","data_type":"string","input_options":{"multiline":false},"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":67,"archived":false,"created_at":1734537866,"updated_at":1734537866},{"type":"ticket_type_attribute","id":"167","workspace_id":"this_is_an_id648_that_should_be_at_least_","name":"name","description":"description","data_type":"string","input_options":null,"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":false,"visible_to_contacts":false,"default":false,"ticket_type_id":67,"archived":false,"created_at":1734537866,"updated_at":1734537866},{"type":"ticket_type_attribute","id":"166","workspace_id":"this_is_an_id648_that_should_be_at_least_","name":"_default_description_","description":"","data_type":"string","input_options":{"multiline":true},"order":1,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":67,"archived":false,"created_at":1734537866,"updated_at":1734537866}]},"category":"Customer","ticket_states":{"type":"list","data":[{"type":"ticket_state","id":"8321","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},{"type":"ticket_state","id":"8322","category":"in_progress","internal_label":"In progress","external_label":"In progress"},{"type":"ticket_state","id":"8323","category":"waiting_on_customer","internal_label":"Waiting on customer","external_label":"Waiting on you"},{"type":"ticket_state","id":"8324","category":"resolved","internal_label":"Resolved","external_label":"Resolved"}]}}]},"key":"successful","summary":"successful","id":"paths/~1ticket_types/get/responses/200/content/application~1json/examples/successful"},"paths/~1ticket_types/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a63507c2-3b3b-4a1a-aafa-f08b87eb2c12","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created":{"value":{"name":"Customer Issue","description":"Customer Report Template","icon":"🎟️","category":"Customer"},"key":"ticket_type_created","summary":"Ticket type created","id":"paths/~1ticket_types/post/requestBody/content/application~1json/examples/ticket_type_created"},"paths/~1ticket_types/post/responses/200/content/application~1json/examples/Ticket type created":{"value":{"type":"ticket_type","id":"70","name":"Customer Issue","description":"Customer Report Template","icon":"🎟️","workspace_id":"this_is_an_id652_that_should_be_at_least_","archived":false,"created_at":1734537869,"updated_at":1734537869,"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_","name":"_default_title_","description":"","data_type":"string","input_options":{"multiline":false},"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":70,"archived":false,"created_at":1734537869,"updated_at":1734537869},{"type":"ticket_type_attribute","id":"175","workspace_id":"this_is_an_id652_that_should_be_at_least_","name":"_default_description_","description":"","data_type":"string","input_options":{"multiline":true},"order":1,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":70,"archived":false,"created_at":1734537869,"updated_at":1734537869}]},"category":"Customer","ticket_states":{"type":"list","data":[{"type":"ticket_state","id":"8337","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},{"type":"ticket_state","id":"8338","category":"in_progress","internal_label":"In progress","external_label":"In progress"},{"type":"ticket_state","id":"8339","category":"waiting_on_customer","internal_label":"Waiting on customer","external_label":"Waiting on you"},{"type":"ticket_state","id":"8340","category":"resolved","internal_label":"Resolved","external_label":"Resolved"}]}},"key":"Ticket type created","summary":"Ticket type created","id":"paths/~1ticket_types/post/responses/200/content/application~1json/examples/Ticket type created"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing name":{"value":{"type":"error.list","request_id":"5e2d6119-160b-4165-a253-c0ffeebe2a9f","errors":[{"code":"parameter_not_found","message":"name is a required parameter"}]},"key":"Missing name","summary":"Missing name","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing name"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing category":{"value":{"type":"error.list","request_id":"5e2d8008-1618-4168-a258-c0ffeebfc3b8","errors":[{"code":"parameter_not_found","message":"category is a required parameter"}]},"key":"Missing category","summary":"Missing category","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Missing category"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid category":{"value":{"type":"error.list","request_id":"5e2d9ef7-1625-416b-a25d-c0ffeec15cd1","errors":[{"code":"ticket_type_category_invalid","message":"Ticket type category: Unknown is invalid. Valid categories are: Tracker, Customer, Back-office"}]},"key":"Invalid category","summary":"Invalid category","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid category"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Duplicate name":{"value":{"type":"error.list","request_id":"5e2dbde6-1632-416e-a262-c0ffeec2f5ea","errors":[{"code":"parameter_invalid","message":"A ticket type with Bug already exists"}]},"key":"Duplicate name","summary":"Duplicate name","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Duplicate name"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Customer ticket type cannot be internal":{"value":{"type":"error.list","request_id":"5e2ddcd5-163f-4171-a267-c0ffeec48f03","errors":[{"code":"parameter_invalid","message":"Requests cannot be internal"}]},"key":"Customer ticket type cannot be internal","summary":"Customer ticket type cannot be internal","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Customer ticket type cannot be internal"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Tracker ticket type must be internal":{"value":{"type":"error.list","request_id":"5e2dfbc4-164c-4174-a26c-c0ffeec6281c","errors":[{"code":"parameter_invalid","message":"Trackers must be internal"}]},"key":"Tracker ticket type must be internal","summary":"Tracker ticket type must be internal","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Tracker ticket type must be internal"},"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid icon":{"value":{"type":"error.list","request_id":"5e2e1ab3-1659-4177-a271-c0ffeec7c135","errors":[{"code":"parameter_invalid","message":"Emoji should be valid and supported"}]},"key":"Invalid icon","summary":"Invalid icon","id":"paths/~1ticket_types/post/responses/400/content/application~1json/examples/Invalid icon"},"paths/~1ticket_types/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"36b79d0c-b78f-4e1d-bd6d-bfc3dcc71f53","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types~1{ticket_type_id}/get/responses/200/content/application~1json/examples/Ticket type found":{"value":{"type":"ticket_type","id":"72","name":"Bug Report","description":"Bug Report Template","icon":"🎟️","workspace_id":"this_is_an_id656_that_should_be_at_least_","archived":false,"created_at":1734537870,"updated_at":1734537870,"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_","name":"_default_title_","description":"","data_type":"string","input_options":{"multiline":false},"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":72,"archived":false,"created_at":1734537871,"updated_at":1734537871},{"type":"ticket_type_attribute","id":"181","workspace_id":"this_is_an_id656_that_should_be_at_least_","name":"name","description":"description","data_type":"string","input_options":null,"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":false,"visible_to_contacts":false,"default":false,"ticket_type_id":72,"archived":false,"created_at":1734537871,"updated_at":1734537871},{"type":"ticket_type_attribute","id":"180","workspace_id":"this_is_an_id656_that_should_be_at_least_","name":"_default_description_","description":"","data_type":"string","input_options":{"multiline":true},"order":1,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":72,"archived":false,"created_at":1734537871,"updated_at":1734537871}]},"category":"Customer","ticket_states":{"type":"list","data":[{"type":"ticket_state","id":"8353","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},{"type":"ticket_state","id":"8354","category":"in_progress","internal_label":"In progress","external_label":"In progress"},{"type":"ticket_state","id":"8355","category":"waiting_on_customer","internal_label":"Waiting on customer","external_label":"Waiting on you"},{"type":"ticket_state","id":"8356","category":"resolved","internal_label":"Resolved","external_label":"Resolved"}]}},"key":"Ticket type found","summary":"Ticket type found","id":"paths/~1ticket_types~1{ticket_type_id}/get/responses/200/content/application~1json/examples/Ticket type found"},"paths/~1ticket_types~1{ticket_type_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c9a2c3da-7536-4eba-bde7-c38c2d9e2942","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{ticket_type_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types~1{ticket_type_id}/get/responses/404/content/application~1json/examples/Ticket type not found":{"value":{"type":"error.list","request_id":"5e2e39a2-1666-417a-a276-c0ffeec95a4e","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Ticket type not found","summary":"Ticket type not found","id":"paths/~1ticket_types~1{ticket_type_id}/get/responses/404/content/application~1json/examples/Ticket type not found"},"paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated":{"value":{"name":"Bug Report 2"},"key":"ticket_type_updated","summary":"Ticket type updated","id":"paths/~1ticket_types~1{ticket_type_id}/put/requestBody/content/application~1json/examples/ticket_type_updated"},"paths/~1ticket_types~1{ticket_type_id}/put/responses/200/content/application~1json/examples/Ticket type updated":{"value":{"type":"ticket_type","id":"74","name":"Bug Report 2","description":"Bug Report Template","icon":"🎟️","workspace_id":"this_is_an_id660_that_should_be_at_least_","archived":false,"created_at":1734537873,"updated_at":1734537874,"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_","name":"_default_title_","description":"","data_type":"string","input_options":{"multiline":false},"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":74,"archived":false,"created_at":1734537873,"updated_at":1734537873},{"type":"ticket_type_attribute","id":"187","workspace_id":"this_is_an_id660_that_should_be_at_least_","name":"name","description":"description","data_type":"string","input_options":null,"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":false,"visible_to_contacts":false,"default":false,"ticket_type_id":74,"archived":false,"created_at":1734537873,"updated_at":1734537873},{"type":"ticket_type_attribute","id":"186","workspace_id":"this_is_an_id660_that_should_be_at_least_","name":"_default_description_","description":"","data_type":"string","input_options":{"multiline":true},"order":1,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":74,"archived":false,"created_at":1734537873,"updated_at":1734537873}]},"category":"Customer","ticket_states":{"type":"list","data":[{"type":"ticket_state","id":"8369","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},{"type":"ticket_state","id":"8370","category":"in_progress","internal_label":"In progress","external_label":"In progress"},{"type":"ticket_state","id":"8371","category":"waiting_on_customer","internal_label":"Waiting on customer","external_label":"Waiting on you"},{"type":"ticket_state","id":"8372","category":"resolved","internal_label":"Resolved","external_label":"Resolved"}]}},"key":"Ticket type updated","summary":"Ticket type updated","id":"paths/~1ticket_types~1{ticket_type_id}/put/responses/200/content/application~1json/examples/Ticket type updated"},"paths/~1ticket_types~1{ticket_type_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2fc2ae95-64ec-4581-80f0-79ecfdc2e759","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{ticket_type_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply":{"value":{"message_type":"comment","type":"admin","admin_id":991267940,"body":"<p>Thanks for reaching out, we're looking into it!</p>"},"key":"admin_reply","summary":"Admin reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_reply"},"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6762f2971bb69f9f2193bc49","body":"Thanks again :)"},"key":"user_reply","summary":"User reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/user_reply"},"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply":{"value":{"message_type":"note","type":"admin","admin_id":991267943,"body":"<html> <body>  <h2>An Unordered HTML List</h2>  <ul>   <li>Coffee</li>   <li>Tea</li>   <li>Milk</li> </ul>    <h2>An Ordered HTML List</h2>  <ol>   <li>Coffee</li>   <li>Tea</li>   <li>Milk</li> </ol>   </body> </html>"},"key":"admin_note_reply","summary":"Admin note reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"},"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply":{"value":{"message_type":"note","type":"admin","admin_id":991267943,"body":"This note will be cross-posted to all linked conversations.","cross_post":true},"key":"admin_note_cross_post_reply","summary":"Admin note reply with cross-post to linked conversations","id":"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_note_cross_post_reply"},"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply":{"value":{"message_type":"quick_reply","type":"admin","admin_id":991267948,"reply_options":[{"text":"Yes","uuid":"0df48b85-9a93-4c66-a167-753eff0baaec"},{"text":"No","uuid":"4f0b5145-4193-4b4f-8cad-ce19478a3938"}]},"key":"admin_quick_reply_reply","summary":"Admin quick_reply reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/admin_quick_reply_reply"},"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6762f2a41bb69f9f2193bc4c","body":"Thanks again :)"},"key":"not_found","summary":"Not found","id":"paths/~1tickets~1{ticket_id}~1reply/post/requestBody/content/application~1json/examples/not_found"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin reply":{"value":{"type":"ticket_part","id":"155","part_type":"comment","body":"<p>Thanks for reaching out, we're looking into it!</p>","created_at":1734537880,"updated_at":1734537880,"author":{"id":"991267940","type":"admin","name":"Ciaran418 Lee","email":"admin418@email.com"},"attachments":[],"redacted":false,"app_package_code":"test-integration","translations":{"original":"en","en":"<p>Thanks for reaching out, we're looking into it!</p>","fr":"<p>Merci de nous avoir contactés, nous nous en occupons !</p>"}},"key":"Admin reply","summary":"Admin reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin reply"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply":{"value":{"type":"ticket_part","id":"156","part_type":"note","body":"<h2>An Unordered HTML List</h2>\n<ul>\n<li>Coffee</li>\n<li>Tea</li>\n<li>Milk</li>\n</ul>\n<h2>An Ordered HTML List</h2>\n<ol>\n<li>Coffee</li>\n<li>Tea</li>\n<li>Milk</li>\n</ol>","created_at":1734537884,"updated_at":1734537884,"author":{"id":"991267943","type":"admin","name":"Ciaran419 Lee","email":"admin419@email.com"},"attachments":[],"redacted":false,"app_package_code":"test-integration"},"key":"Admin note reply","summary":"Admin note reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply":{"value":{"type":"ticket_part","id":"158","part_type":"quick_reply","created_at":1734537890,"updated_at":1734537890,"author":{"id":"991267948","type":"admin","name":"Ciaran423 Lee","email":"admin423@email.com"},"attachments":[],"redacted":false},"key":"Admin quick_reply reply","summary":"Admin quick_reply reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply":{"value":{"type":"error.list","request_id":"603ce1da-f2bf-4641-a1ee-d1f13ebf9172","errors":[{"code":"parameter_mismatch","message":"User replies are not allowed on Backoffice tickets"}]},"key":"User reply","summary":"User reply","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a back-office ticket":{"value":{"type":"error.list","request_id":"7a1c9f02-5d3e-4b8a-9c21-6f0d84e5b713","errors":[{"code":"parameter_mismatch","message":"Comments are not allowed on Backoffice tickets not shared with user. Use message_type 'note' instead, or share the ticket with the customer"}]},"key":"Admin comment on a back-office ticket","summary":"Admin comment on a back-office ticket","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a back-office ticket"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a tracker ticket":{"value":{"type":"error.list","request_id":"c4e2a980-31bf-4d76-8a05-2e9cb17f4d6a","errors":[{"code":"parameter_mismatch","message":"Comments are not allowed on Tracker tickets. Use message_type 'note' instead"}]},"key":"Admin comment on a tracker ticket","summary":"Admin comment on a tracker ticket","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/Admin comment on a tracker ticket"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ed4305b3-4364-4fab-9f8d-e07e9a8190ab","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1reply/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"24561472-06a4-41b2-aca2-97b3ccd9ca19","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1tickets~1{ticket_id}~1reply/post/responses/404/content/application~1json/examples/Not found"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful":{"value":{"conversation_id":"204"},"key":"successful","summary":"Link a conversation to a tracker ticket","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"conversation","id":"204","created_at":1734537715,"updated_at":1734537740,"source":{"type":"conversation","id":"403918350","delivered_as":"admin_initiated","subject":"","body":"<p>Customer report</p>","author":{"type":"admin","id":"991267645","name":"Ciaran176 Lee","email":"admin176@email.com"},"attachments":[],"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1261bb69f9f2193bba7","external_id":"70"}]},"open":true,"state":"open","linked_objects":{"type":"list","total_count":1,"has_more":false,"data":[{"type":"ticket","id":"207","category":"Tracker"}]}},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/200/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Not a tracker ticket":{"value":{"type":"error.list","request_id":"4f2d9c1a-7b3e-4a6c-9d21-8e5f0c2b1a34","errors":[{"code":"invalid_ticket_type","message":"Only tracker tickets support linking conversations"}]},"key":"Not a tracker ticket","summary":"Not a tracker ticket","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Not a tracker ticket"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Already linked to a tracker":{"value":{"type":"error.list","request_id":"5a3e0d2b-8c4f-4b7d-ae32-9f6a1d3c2b45","errors":[{"code":"already_linked_to_tracker","message":"A conversation can only have one tracker ticket"}]},"key":"Already linked to a tracker","summary":"Already linked to a tracker","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Already linked to a tracker"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Linked conversation limit exceeded":{"value":{"type":"error.list","request_id":"6b4f1e3c-9d50-4c8e-bf43-0a7b2e4d3c56","errors":[{"code":"linked_conversation_limit_exceeded","message":"Ticket has reached the maximum number of conversations that can be linked"}]},"key":"Linked conversation limit exceeded","summary":"Linked conversation limit exceeded","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Linked conversation limit exceeded"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Missing conversation_id":{"value":{"type":"error.list","request_id":"7c5a2f4d-ae61-4d9f-c054-1b8c3f5e4d67","errors":[{"code":"parameter_not_found","message":"conversation_id not specified"}]},"key":"Missing conversation_id","summary":"Missing conversation_id","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/400/content/application~1json/examples/Missing conversation_id"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"af8d5c70-d194-40c2-f387-4e1f6c8b7091","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"8d6b3a5e-bf72-4ea0-d165-2c9d4a6f5e78","errors":[{"code":"ticket_not_found","message":"Ticket not found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Conversation not found":{"value":{"type":"error.list","request_id":"9e7c4b6f-c083-4fb1-e276-3d0e5b7a6f89","errors":[{"code":"conversation_not_found","message":"Conversation not found"}]},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1tickets~1{ticket_id}~1linked_conversations/post/responses/404/content/application~1json/examples/Conversation not found"},"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"type":"conversation","id":"204","created_at":1734537715,"updated_at":1734537752,"source":{"type":"conversation","id":"403918350","delivered_as":"admin_initiated","subject":"","body":"<p>Customer report</p>","author":{"type":"admin","id":"991267645","name":"Ciaran176 Lee","email":"admin176@email.com"},"attachments":[],"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f1261bb69f9f2193bba7","external_id":"70"}]},"open":true,"state":"open","linked_objects":{"type":"list","total_count":0,"has_more":false,"data":[]}},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/400/content/application~1json/examples/Not a tracker ticket":{"value":{"type":"error.list","request_id":"b09e6d81-e2a5-41d3-9498-5f2a7d9c8102","errors":[{"code":"invalid_ticket_type","message":"Only tracker tickets support unlinking conversations"}]},"key":"Not a tracker ticket","summary":"Not a tracker ticket","id":"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/400/content/application~1json/examples/Not a tracker ticket"},"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e3c19fb4-150d-44a6-a721-8c5daf2f1435","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"c1af7e92-f3b6-42e4-8509-6a3b8e0d9213","errors":[{"code":"ticket_not_found","message":"Ticket not found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Conversation not linked":{"value":{"type":"error.list","request_id":"d2b08fa3-04c7-43f5-9610-7b4c9f1e0324","errors":[{"code":"conversation_not_found","message":"Conversation is not linked to this ticket"}]},"key":"Conversation not linked","summary":"Conversation not linked","id":"paths/~1tickets~1{ticket_id}~1linked_conversations~1{id}/delete/responses/404/content/application~1json/examples/Conversation not linked"},"paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response":{"value":{"ticket_type_id":"88","contacts":[{"id":"6762f2d81bb69f9f2193bc54"}],"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"}},"key":"successful_response","summary":"Successful response","id":"paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"},"paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"ticket","id":"626","ticket_id":"33","ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"ticket_state":{"type":"ticket_state","id":"8481","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},"ticket_type":{"type":"ticket_type","id":"88","name":"my-ticket-type-23","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id688_that_should_be_at_least_","archived":false,"created_at":1734537943,"updated_at":1734537943,"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_","name":"_default_title_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":88,"archived":false,"created_at":1734537943,"updated_at":1734537943},{"type":"ticket_type_attribute","id":"197","workspace_id":"this_is_an_id688_that_should_be_at_least_","name":"_default_description_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":88,"archived":false,"created_at":1734537943,"updated_at":1734537943}]},"category":"Back-office"},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f2d81bb69f9f2193bc54","external_id":"70"}]},"admin_assignee_id":0,"team_assignee_id":0,"created_at":1734537944,"updated_at":1734537946,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"175","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1734537945,"updated_at":1734537945,"author":{"id":"991267999","type":"bot","name":"Fin","email":"operator+this_is_an_id688_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false}],"total_count":1},"open":true,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"category":"Back-office","is_shared":false,"channel":"messenger"},"key":"Successful response","summary":"Successful response","id":"paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1tickets/post/responses/400/content/application~1json/examples/Missing ticket_type_id":{"value":{"type":"error.list","request_id":"5e2b344b-1521-412f-a1f9-c0ffeea166dd","errors":[{"code":"parameter_not_found","message":"ticket_type_id is a required parameter"}]},"key":"Missing ticket_type_id","summary":"Missing ticket_type_id","id":"paths/~1tickets/post/responses/400/content/application~1json/examples/Missing ticket_type_id"},"paths/~1tickets/post/responses/400/content/application~1json/examples/Missing contact":{"value":{"type":"error.list","request_id":"5e2b533a-152e-4132-a1fe-c0ffeea2fff6","errors":[{"code":"parameter_invalid","message":"You must pass in a single contact in an array"}]},"key":"Missing contact","summary":"Missing contact","id":"paths/~1tickets/post/responses/400/content/application~1json/examples/Missing contact"},"paths/~1tickets/post/responses/400/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"5e2b7229-153b-4135-a203-c0ffeea4990f","errors":[{"code":"parameter_invalid","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1tickets/post/responses/400/content/application~1json/examples/Contact not found"},"paths/~1tickets/post/responses/400/content/application~1json/examples/Invalid ticket type":{"value":{"type":"error.list","request_id":"5e2b9118-1548-4138-a208-c0ffeea63228","errors":[{"code":"parameter_invalid","message":"Invalid ticket type provided"}]},"key":"Invalid ticket type","summary":"Invalid ticket type","id":"paths/~1tickets/post/responses/400/content/application~1json/examples/Invalid ticket type"},"paths/~1tickets/post/responses/400/content/application~1json/examples/Missing required attributes":{"value":{"type":"error.list","request_id":"5e2bb007-1555-413b-a20d-c0ffeea7cb41","errors":[{"code":"parameter_invalid","message":"Missing required attributes: _default_title_"}]},"key":"Missing required attributes","summary":"Missing required attributes","id":"paths/~1tickets/post/responses/400/content/application~1json/examples/Missing required attributes"},"paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c7bf358f-135e-48d7-8286-a4988a8a1d9b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets/post/responses/404/content/application~1json/examples/Conversation to link not found":{"value":{"type":"error.list","request_id":"5e2bcef6-1562-413e-a212-c0ffeea9645a","errors":[{"code":"conversation_to_link_not_found","message":"Couldn't find Conversation with ID=1234"}]},"key":"Conversation to link not found","summary":"Conversation to link not found","id":"paths/~1tickets/post/responses/404/content/application~1json/examples/Conversation to link not found"},"paths/~1tickets/post/responses/500/content/application~1json/examples/Ticket creation failed":{"value":{"type":"error.list","request_id":"5e2bede5-156f-4141-a217-c0ffeeaafd73","errors":[{"code":"ticket_creation","message":"Error creating ticket"}]},"key":"Ticket creation failed","summary":"Ticket creation failed","id":"paths/~1tickets/post/responses/500/content/application~1json/examples/Ticket creation failed"},"paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response":{"value":{"ticket_type_id":"88","contacts":[{"id":"6762f2d81bb69f9f2193bc54"}],"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"}},"key":"successful_response","summary":"Successful response","id":"paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"},"paths/~1tickets~1enqueue/post/responses/200/content/application~1json/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},"key":"Successful response","summary":"Successful response","id":"paths/~1tickets~1enqueue/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1tickets~1enqueue/post/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":"c7bf358f-135e-48d7-8286-a4988a8a1456","errors":[{"code":"parameter_invalid","message":"attributes: Missing required attributes: _default_title_"}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1tickets~1enqueue/post/responses/400/content/application~1json/examples/Bad Request"},"paths/~1tickets~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c7bf358f-135e-48d7-8286-a4988a8a1d9b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1enqueue/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1enqueue/post/responses/500/content/application~1json/examples/Enqueue failed":{"value":{"type":"error.list","request_id":"5e2c0cd4-157c-4144-a21c-c0ffeeac968c","errors":[{"code":"ticket_creation","message":"Failed to enqueue ticket creation job"}]},"key":"Enqueue failed","summary":"Enqueue failed","id":"paths/~1tickets~1enqueue/post/responses/500/content/application~1json/examples/Enqueue failed"},"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response":{"value":{"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"admin_id":991268011,"assignee_id":"991268013","open":true,"snoozed_until":1673609604,"ticket_state_id":"8498"},"key":"successful_response","summary":"Successful response","id":"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/successful_response"},"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found":{"value":{"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"admin_id":991268011,"assignee_id":"991268013","ticket_state_id":"8506"},"key":"admin_not_found","summary":"Admin not found","id":"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found":{"value":{"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"admin_id":991268011,"assignee_id":"991268013","ticket_state_id":"8514"},"key":"assignee_not_found","summary":"Assignee not found","id":"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/assignee_not_found"},"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type":{"value":{"ticket_state_id":0},"key":"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.","id":"paths/~1tickets~1{ticket_id}/put/requestBody/content/application~1json/examples/ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type"},"paths/~1tickets~1{ticket_id}/put/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"ticket","id":"627","ticket_id":"34","ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"ticket_state":{"type":"ticket_state","id":"8498","category":"in_progress","internal_label":"In progress","external_label":"In progress"},"ticket_type":{"type":"ticket_type","id":"90","name":"my-ticket-type-25","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id692_that_should_be_at_least_","archived":false,"created_at":1734537948,"updated_at":1734537948,"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_","name":"_default_title_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":90,"archived":false,"created_at":1734537949,"updated_at":1734537949},{"type":"ticket_type_attribute","id":"201","workspace_id":"this_is_an_id692_that_should_be_at_least_","name":"_default_description_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":90,"archived":false,"created_at":1734537949,"updated_at":1734537949}]},"category":"Back-office"},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f2dd1bb69f9f2193bc55","external_id":"8df1fa21-b41d-4621-9229-d6f7a3a590ce"}]},"admin_assignee_id":991268013,"team_assignee_id":0,"created_at":1734537950,"updated_at":1734537955,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"176","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1734537951,"updated_at":1734537951,"author":{"id":"991268011","type":"admin","name":"Ciaran477 Lee","email":"admin477@email.com"},"attachments":[],"redacted":false},{"type":"ticket_part","id":"177","part_type":"ticket_attribute_updated_by_admin","created_at":1734537953,"updated_at":1734537953,"author":{"id":"991268012","type":"bot","name":"Fin","email":"operator+this_is_an_id692_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false,"updated_attribute_data":{"attribute":{"type":"attribute","id":"10","label":"Photo"},"value":{"type":"value","id":[2],"label":["photo.png"]}}},{"type":"ticket_part","id":"178","part_type":"ticket_attribute_updated_by_admin","created_at":1734537953,"updated_at":1734537953,"author":{"id":"991268012","type":"bot","name":"Fin","email":"operator+this_is_an_id692_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false,"updated_attribute_data":{"attribute":{"type":"attribute","id":"7","label":"Progress"},"value":{"type":"value","id":"Fast","label":"Fast"}}},{"type":"ticket_part","id":"179","part_type":"ticket_state_updated_by_admin","ticket_state":"in_progress","previous_ticket_state":"submitted","created_at":1734537954,"updated_at":1734537954,"author":{"id":"991268012","type":"bot","name":"Fin","email":"operator+this_is_an_id692_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false,"app_package_code":"test-integration"},{"type":"ticket_part","id":"180","part_type":"assignment","created_at":1734537954,"updated_at":1734537954,"assigned_to":{"type":"admin","id":"991268013"},"author":{"id":"991268011","type":"admin","name":"Ciaran477 Lee","email":"admin477@email.com"},"attachments":[],"redacted":false},{"type":"ticket_part","id":"181","part_type":"snoozed","created_at":1734537955,"updated_at":1734537955,"author":{"id":"991268012","type":"bot","name":"Fin","email":"operator+this_is_an_id692_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false}],"total_count":6},"open":true,"snoozed_until":1734627600,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"category":"Back-office","is_shared":false},"key":"Successful response","summary":"Successful response","id":"paths/~1tickets~1{ticket_id}/put/responses/200/content/application~1json/examples/Successful response"},"paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/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","errors":[{"code":"ticket_state_id_invalid","message":"Ticket state id is not valid or is not associated with the ticket type"}]},"key":"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.","id":"paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket state id is not valid or is not associated with the ticket type."},"paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be unshared":{"value":{"type":"error.list","request_id":"5e2c4ab2-1596-414a-a226-c0ffeeafc8be","errors":[{"code":"parameter_invalid","message":"Tickets cannot be unshared"}]},"key":"Ticket cannot be unshared","summary":"Ticket cannot be unshared","id":"paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be unshared"},"paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be shared":{"value":{"type":"error.list","request_id":"5e2c69a1-15a3-414d-a22b-c0ffeeb161d7","errors":[{"code":"parameter_invalid","message":"Ticket cannot be shared. Tracker tickets cannot be shared and Customer tickets are shared by default. Back-Office tickets can only be shared if they are linked to a conversation and that conversation does not have any other shared linked tickets"}]},"key":"Ticket cannot be shared","summary":"Ticket cannot be shared","id":"paths/~1tickets~1{ticket_id}/put/responses/400/content/application~1json/examples/Ticket cannot be shared"},"paths/~1tickets~1{ticket_id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"17db783e-1e43-41c9-b4db-0c05da78a909","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"f9757add-b48a-4519-a6e0-04b2ef9c8c6c","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Admin not found"},"paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Assignee not found":{"value":{"type":"error.list","request_id":"39cf6495-768c-450c-a2c4-c9c3c4ea2e01","errors":[{"code":"assignee_not_found","message":"Assignee not found"}]},"key":"Assignee not found","summary":"Assignee not found","id":"paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Assignee not found"},"paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"5e2c2bc3-1589-4147-a221-c0ffeeae2fa5","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}/put/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}/put/responses/422/content/application~1json/examples/Already assigned":{"value":{"type":"error.list","request_id":"5e2c8890-15b0-4150-a230-c0ffeeb2faf0","errors":[{"code":"conversation_already_assigned_to_assignee","message":"The conversation is already assigned to the specified assignee"}]},"key":"Already assigned","summary":"Already assigned","id":"paths/~1tickets~1{ticket_id}/put/responses/422/content/application~1json/examples/Already assigned"},"paths/~1tickets~1{ticket_id}/get/responses/200/content/application~1json/examples/Ticket found":{"value":{"type":"ticket","id":"631","ticket_id":"38","ticket_attributes":{"_default_title_":"attribute_value","_default_description_":null},"ticket_state":{"type":"ticket_state","id":"8537","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},"ticket_type":{"type":"ticket_type","id":"95","name":"my-ticket-type-30","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id702_that_should_be_at_least_","archived":false,"created_at":1734537973,"updated_at":1734537973,"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_","name":"_default_title_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":95,"archived":false,"created_at":1734537973,"updated_at":1734537973},{"type":"ticket_type_attribute","id":"211","workspace_id":"this_is_an_id702_that_should_be_at_least_","name":"_default_description_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":95,"archived":false,"created_at":1734537973,"updated_at":1734537973}]},"category":"Back-office"},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f2f61bb69f9f2193bc59","external_id":"b16afa36-2637-4880-adee-a46d145bc27f"}]},"admin_assignee_id":0,"team_assignee_id":0,"created_at":1734537974,"updated_at":1734537976,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"185","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1734537975,"updated_at":1734537975,"author":{"id":"991268047","type":"admin","name":"Ciaran509 Lee","email":"admin509@email.com"},"attachments":[],"redacted":false,"app_package_code":"test-integration"}],"total_count":1},"open":true,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"category":"Back-office","is_shared":false,"channel":"messenger"},"key":"Ticket found","summary":"Ticket found","id":"paths/~1tickets~1{ticket_id}/get/responses/200/content/application~1json/examples/Ticket found"},"paths/~1tickets~1{ticket_id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d719ad4f-5ae2-492f-88d6-98ba0a9ab6cc","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}/get/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"5e2ca77f-15bd-4153-a235-c0ffeeb49409","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}/get/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"632","object":"ticket","deleted":true},"key":"successful","summary":"successful","id":"paths/~1tickets~1{ticket_id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1tickets~1{ticket_id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"50348131-55cd-4ca1-a65f-de093b232adb","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}/delete/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"7a80b950-b392-499f-85db-ea7c6c424d37","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1tickets~1{ticket_id}/delete/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1tickets~1{ticket_id}/delete/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"34a070f1-122e-42dc-a94e-9b86768df26c","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}/delete/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1{ticket_id}/delete/responses/422/content/application~1json/examples/Linked to a conversation":{"value":{"type":"error.list","request_id":"5e2cc66e-15ca-4156-a23a-c0ffeeb62d22","errors":[{"code":"back_office_ticket_delete_exception","message":"Cannot delete back-office ticket with a linked conversation, delete conversation instead"}]},"key":"Linked to a conversation","summary":"Linked to a conversation","id":"paths/~1tickets~1{ticket_id}/delete/responses/422/content/application~1json/examples/Linked to a conversation"},"paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response":{"value":{"ticket_type_id":"1234","ticket_state_id":"5678"},"key":"successful_response","summary":"Successful response","id":"paths/~1tickets~1{ticket_id}~1change_type/post/requestBody/content/application~1json/examples/successful_response"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"ticket","id":"494","ticket_id":"53","ticket_attributes":{"_default_title_":"example","_default_description_":"having a problem"},"ticket_state":{"type":"ticket_state","id":"8481","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},"ticket_type":{"type":"ticket_type","id":"1234","name":"my-new-ticket-type","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id664_that_should_be_at_least_","archived":false,"created_at":1719493065,"updated_at":1719493065,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[]},"category":"Back-office"},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"667d61c88a68186f43bafe93","external_id":"71"}]},"admin_assignee_id":0,"team_assignee_id":0,"created_at":1719493065,"updated_at":1719493068,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"136","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1719493065,"updated_at":1719493065,"author":{"id":"991267920","type":"bot","name":"Operator","email":"operator+this_is_an_id664_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false}],"total_count":1},"open":true,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"category":"Back-office","is_shared":false},"key":"Successful response","summary":"Successful response","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_type_id":{"value":{"type":"error.list","request_id":"a35b00e4-97b2-4b5d-a6f9-e82c4d8f7e12","errors":[{"code":"parameter_not_found","message":"ticket_type_id is a required parameter"}]},"key":"Missing ticket_type_id","summary":"Missing ticket_type_id","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_type_id"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_state_id":{"value":{"type":"error.list","request_id":"b46c11f5-08c3-5c6e-b7a3-f93d5e8f9f23","errors":[{"code":"parameter_not_found","message":"ticket_state_id is a required parameter"}]},"key":"Missing ticket_state_id","summary":"Missing ticket_state_id","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Missing ticket_state_id"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Same ticket type":{"value":{"type":"error.list","request_id":"f90a55j9-42g7-9g0i-f1e7-jd7h9i2j3j67","errors":[{"code":"parameter_invalid","message":"Cannot change to the same ticket type"}]},"key":"Same ticket type","summary":"Same ticket type","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Same ticket type"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Ticket state not in new ticket type":{"value":{"type":"error.list","request_id":"g01b66k0-53h8-0h1j-g2f8-ke8i0j3k4k78","errors":[{"code":"parameter_invalid","message":"Ticket custom state doesn't belong to the new ticket type"}]},"key":"Ticket state not in new ticket type","summary":"Ticket state not in new ticket type","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Ticket state not in new ticket type"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Unknown ticket attribute":{"value":{"type":"error.list","request_id":"h12c77l1-64i9-1i2k-h3g9-lf9j1k4l5l89","errors":[{"code":"parameter_invalid","message":"Extra attributes provided that are not found on ticket type: Priority"}]},"key":"Unknown ticket attribute","summary":"Unknown ticket attribute","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/400/content/application~1json/examples/Unknown ticket attribute"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"c57d22g6-19d4-6d7f-c8b4-ga4e6f9g0g34","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{ticket_id}~1change_type/post/responses/404/content/application~1json/examples/Ticket not found":{"value":{"type":"error.list","request_id":"e79f44i8-31f6-8f9h-e0d6-ic6g8h1i2i56","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Ticket not found","summary":"Ticket not found","id":"paths/~1tickets~1{ticket_id}~1change_type/post/responses/404/content/application~1json/examples/Ticket not found"},"paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful":{"value":{"query":{"operator":"AND","value":[{"field":"created_at","operator":">","value":"1306054154"}]},"pagination":{"per_page":5}},"key":"successful","summary":"successful","id":"paths/~1tickets~1search/post/requestBody/content/application~1json/examples/successful"},"paths/~1tickets~1search/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"ticket.list","pages":{"type":"pages","page":1,"per_page":5,"total_pages":1},"total_count":1,"tickets":[{"type":"ticket","id":"633","ticket_id":"40","ticket_attributes":{"_default_title_":"attribute_value","_default_description_":null},"ticket_state":{"type":"ticket_state","id":"8577","category":"submitted","internal_label":"Submitted","external_label":"Submitted"},"ticket_type":{"type":"ticket_type","id":"100","name":"my-ticket-type-35","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id712_that_should_be_at_least_","archived":false,"created_at":1734537989,"updated_at":1734537989,"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_","name":"_default_title_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":100,"archived":false,"created_at":1734537989,"updated_at":1734537989},{"type":"ticket_type_attribute","id":"221","workspace_id":"this_is_an_id712_that_should_be_at_least_","name":"_default_description_","description":"ola","data_type":"string","input_options":null,"order":0,"required_to_create":true,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":false,"default":false,"ticket_type_id":100,"archived":false,"created_at":1734537989,"updated_at":1734537989}]},"category":"Back-office"},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6762f3061bb69f9f2193bc5b","external_id":"9b913927-c084-4391-b1db-098341b5ffe3"}]},"admin_assignee_id":0,"team_assignee_id":0,"created_at":1734537990,"updated_at":1734537992,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"188","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1734537991,"updated_at":1734537991,"author":{"id":"991268079","type":"admin","name":"Ciaran539 Lee","email":"admin539@email.com"},"attachments":[],"redacted":false}],"total_count":1},"open":true,"linked_objects":{"type":"list","data":[],"total_count":0,"has_more":false},"category":"Back-office","is_shared":false}]},"key":"successful","summary":"successful","id":"paths/~1tickets~1search/post/responses/200/content/application~1json/examples/successful"},"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid query":{"value":{"type":"error.list","request_id":"5e2ce55d-15d7-4159-a23f-c0ffeeb7c63b","errors":[{"code":"invalid_query","message":"Invalid query. Ensure 'field', 'operator', 'value' are present for simple queries. Ensure 'operator' and 'value' for composite queries. Ensure query is a JSON object."}]},"key":"Invalid query","summary":"Invalid query","id":"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid query"},"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid field":{"value":{"type":"error.list","request_id":"5e2d044c-15e4-415c-a244-c0ffeeb95f54","errors":[{"code":"invalid_field","message":"source.body is not a valid field"}]},"key":"Invalid field","summary":"Invalid field","id":"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid field"},"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid operator":{"value":{"type":"error.list","request_id":"5e2d233b-15f1-415f-a249-c0ffeebaf86d","errors":[{"code":"invalid_operator","message":"== is not a valid operator"}]},"key":"Invalid operator","summary":"Invalid operator","id":"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid operator"},"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid per_page":{"value":{"type":"error.list","request_id":"5e2d422a-15fe-4162-a24e-c0ffeebc9186","errors":[{"code":"invalid_per_page","message":"per_page must be an integer between 0 and 150"}]},"key":"Invalid per_page","summary":"Invalid per_page","id":"paths/~1tickets~1search/post/responses/400/content/application~1json/examples/Invalid per_page"},"paths/~1visitors/put/requestBody/content/application~1json/examples/successful":{"value":{"id":"6762f30c1bb69f9f2193bc5e","name":"Gareth Bale"},"key":"successful","summary":"successful","id":"paths/~1visitors/put/requestBody/content/application~1json/examples/successful"},"paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found":{"value":{"user_id":"fail","name":"Christian Fail"},"key":"visitor_not_found","summary":"visitor Not Found","id":"paths/~1visitors/put/requestBody/content/application~1json/examples/visitor_not_found"},"paths/~1visitors/put/responses/200/content/application~1json/examples/successful":{"value":{"type":"visitor","id":"6762f30c1bb69f9f2193bc5e","user_id":"3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3","anonymous":true,"email":"","phone":null,"name":"Gareth Bale","pseudonym":"Violet Suitcase","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_","companies":{"type":"company.list","companies":[]},"location_data":{},"last_request_at":null,"created_at":1734537996,"remote_created_at":1734537996,"signed_up_at":1734537996,"updated_at":1734537997,"session_count":0,"social_profiles":{"type":"social_profile.list","social_profiles":[]},"owner_id":null,"unsubscribed_from_emails":false,"marked_email_as_spam":false,"has_hard_bounced":false,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"custom_attributes":{},"referrer":null,"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"do_not_track":null},"key":"successful","summary":"successful","id":"paths/~1visitors/put/responses/200/content/application~1json/examples/successful"},"paths/~1visitors/put/responses/400/content/application~1json/examples/No identifier supplied":{"value":{"type":"error.list","request_id":"2a71c4e6-85d0-4b93-9f18-6c0e3b7a52d4","errors":[{"code":"400","message":"Visitor id or user_id must be supplied"}]},"key":"No identifier supplied","summary":"No identifier supplied","id":"paths/~1visitors/put/responses/400/content/application~1json/examples/No identifier supplied"},"paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"3f474ec4-4e61-42ee-9acc-eac64982e393","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1visitors/put/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"8f25b071-3ca9-4d68-b4e0-5719c2a6f30e","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1visitors/put/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1visitors/put/responses/404/content/application~1json/examples/visitor Not Found":{"value":{"type":"error.list","request_id":"6a6d5522-54e2-437d-8fd0-1109686af965","errors":[{"code":"not_found","message":"Visitor Not Found"}]},"key":"visitor Not Found","summary":"visitor Not Found","id":"paths/~1visitors/put/responses/404/content/application~1json/examples/visitor Not Found"},"paths/~1visitors/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"visitor","id":"6762f3101bb69f9f2193bc64","user_id":"3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3","anonymous":true,"email":"","phone":null,"name":null,"pseudonym":null,"avatar":{"type":"avatar","image_url":null},"app_id":"this_is_an_id722_that_should_be_at_least_","companies":{"type":"company.list","companies":[]},"location_data":{},"last_request_at":null,"created_at":1734538000,"remote_created_at":1734538000,"signed_up_at":1734538000,"updated_at":1734538000,"session_count":0,"social_profiles":{"type":"social_profile.list","social_profiles":[]},"owner_id":null,"unsubscribed_from_emails":false,"marked_email_as_spam":false,"has_hard_bounced":false,"tags":{"type":"tag.list","tags":[]},"segments":{"type":"segment.list","segments":[]},"custom_attributes":{},"referrer":null,"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"do_not_track":null},"key":"successful","summary":"successful","id":"paths/~1visitors/get/responses/200/content/application~1json/examples/successful"},"paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1d7f49b3-10bc-4bf8-a28a-1ac95de3a6ff","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1visitors/get/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"7b09e4d2-61c8-4530-9a7f-284c60b5e1d3","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1visitors/get/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1visitors/get/responses/404/content/application~1json/examples/Visitor not found":{"value":{"type":"error.list","request_id":"3c1b017d-39fb-4d13-8cc9-540ad0d37106","errors":[{"code":"not_found","message":"Visitor Not Found"}]},"key":"Visitor not found","summary":"Visitor not found","id":"paths/~1visitors/get/responses/404/content/application~1json/examples/Visitor not found"},"paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful":{"value":{"visitor":{"user_id":"3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"},"user":{"email":"foo@bar.com"},"type":"user"},"key":"successful","summary":"successful","id":"paths/~1visitors~1convert/post/requestBody/content/application~1json/examples/successful"},"paths/~1visitors~1convert/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6762f3141bb69f9f2193bc6b","workspace_id":"this_is_an_id728_that_should_be_at_least_","external_id":null,"role":"user","email":"foo@bar.com","email_domain":"bar.com","email_verified":false,"phone":null,"name":null,"avatar":null,"owner_id":null,"social_profiles":{"type":"list","data":[]},"has_hard_bounced":false,"marked_email_as_spam":false,"unsubscribed_from_emails":false,"created_at":1734538004,"updated_at":1734538005,"signed_up_at":1734538004,"last_seen_at":null,"last_replied_at":null,"last_contacted_at":null,"last_email_opened_at":null,"last_email_clicked_at":null,"language_override":null,"browser":null,"browser_version":null,"browser_language":null,"os":null,"location":{"type":"location","country":null,"region":null,"city":null,"country_code":null,"continent_code":null},"android_app_name":null,"android_app_version":null,"android_device":null,"android_os_version":null,"android_sdk_version":null,"android_last_seen_at":null,"ios_app_name":null,"ios_app_version":null,"ios_device":null,"ios_os_version":null,"ios_sdk_version":null,"ios_last_seen_at":null,"custom_attributes":{},"tags":{"type":"list","data":[],"url":"/contacts/6762f3141bb69f9f2193bc6b/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6762f3141bb69f9f2193bc6b/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6762f3141bb69f9f2193bc6b/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f3141bb69f9f2193bc6b/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6762f3141bb69f9f2193bc6b/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null,"sms_consent":false,"unsubscribed_from_sms":false,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1visitors~1convert/post/responses/200/content/application~1json/examples/successful"},"paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/No visitor identifier supplied":{"value":{"type":"error.list","request_id":"9e4b2c07-61da-4f85-93b0-c7a1e568d234","errors":[{"code":"400","message":"Visitor id or user_id must be supplied"}]},"key":"No visitor identifier supplied","summary":"No visitor identifier supplied","id":"paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/No visitor identifier supplied"},"paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/Missing or unknown type":{"value":{"type":"error.list","request_id":"41c70e93-8b26-4d5a-a9f7-02e6b1c38045","errors":[{"code":"type_mismatch","message":"The type attribute provided should be either 'user' or 'lead'"}]},"key":"Missing or unknown type","summary":"Missing or unknown type","id":"paths/~1visitors~1convert/post/responses/400/content/application~1json/examples/Missing or unknown type"},"paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b3e71306-0600-41e4-9f44-83b52906d2b7","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Token lacks required scope":{"value":{"type":"error.list","request_id":"6b58d204-3f91-4e7c-85a0-d2f71e634b09","errors":[{"code":"token_unauthorized","message":"Not authorized to access resource"}]},"key":"Token lacks required scope","summary":"Token lacks required scope","id":"paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Token lacks required scope"},"paths/~1visitors~1convert/post/responses/404/content/application~1json/examples/Visitor not found":{"value":{"type":"error.list","request_id":"0a7e53c1-9268-4bd4-83f6-1c5027e9a4b8","errors":[{"code":"not_found","message":"Visitor Not Found"}]},"key":"Visitor not found","summary":"Visitor not found","id":"paths/~1visitors~1convert/post/responses/404/content/application~1json/examples/Visitor not found"},"paths/~1export~1workflows~1{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"export_version":"1.0","exported_at":"2026-01-26T12:00:00Z","app_id":12345,"workflow":{"id":"67890","title":"My Workflow","description":"A workflow that handles customer inquiries","trigger_type":"inbound_conversation","state":"live","target_channels":["chat"],"preferred_devices":["desktop","mobile"],"created_at":"2025-06-15T10:30:00Z","updated_at":"2026-01-20T14:45:00Z","targeting":{},"snapshot":{},"attributes":[],"embedded_rules":[]}},"key":"successful","summary":"successful","id":"paths/~1export~1workflows~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1export~1workflows~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1export~1workflows~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found":{"value":{"type":"error.list","request_id":"b3c8c472-8478-4f10-a29e-a23dbf921c46","errors":[{"code":"not_found","message":"Workflow not found with id: 12345"}]},"key":"Workflow not found","summary":"Workflow not found","id":"paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found"},"paths/~1export~1workflows~1{id}/get/responses/503/content/application~1json/examples/Workflow export disabled":{"value":{"type":"error.list","request_id":"d92f7e84-5c31-4a2b-b8e6-9f4c3d2a1b0e","errors":[{"code":"service_unavailable","message":"Workflow export is currently disabled"}]},"key":"Workflow export disabled","summary":"Workflow export disabled","id":"paths/~1export~1workflows~1{id}/get/responses/503/content/application~1json/examples/Workflow export disabled"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly/","hideInfoMetadata":true,"schemaDefinitionsTagName":"Models","codeSamples":{"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"Ruby"},{"lang":"PHP"},{"lang":"Python"},{"lang":"Java"},{"lang":"Go"},{"lang":"C#"},{"lang":"R"}]},"feedback":{"type":"rating","settings":{"label":"Was this page helpful?","submitText":"Thanks for your feedback","comment":{"label":"Tell us more"}}},"hideSidebar":true,"mockServer":{"position":"off","off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/references/@2.18/rest-api/api.intercom.io.json?download"},{"url":"/_bundle/docs/references/@2.18/rest-api/api.intercom.io.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Intercom API","description":"The intercom API reference."}},"baseSlug":"/docs/references/rest-api/api.intercom.io","routesMapping":{}}