{"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.16/rest-api/api.intercom.io.json?download"},{"kind":"download","label":"api.intercom.io.yaml","url":"/_bundle/docs/references/@2.16/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.16)","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":[]}]}]}]}]},{"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_594"}],"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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"]}],"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"]}}}],"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":"You can set an Admin as away for the Inbox."},{"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_595","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_594"}],"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_596","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_596","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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_596","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","404"],"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_596","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_596","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":{"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_mandatory"]}},"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_mandatory"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"]},{"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"]}],"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","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_mandatory"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"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_mandatory"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}},{"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"]}}}],"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":"You can get a log of activities by all admins in an app."},{"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_597","description":"The start date that you request data for. It must be formatted as a UNIX timestamp.","required":true,"example":"1677253093"},{"name":"created_at_before","in":"query","schemaId":"schema_597","description":"The end date that you request data for. It must be formatted as a UNIX timestamp.","example":"1677861493"}],"pointer":"/paths/~1admins~1activity_logs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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":true,"example":"1677253093","schemaId":"schema_597"},{"name":"created_at_before","in":"query","required":false,"example":"1677861493","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"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."},{"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_594"}],"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_598","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_598","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_598","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","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_598","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_598","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_logs~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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 List all 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 List all activity logs endpoint."},"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_594"}],"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.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1activity_log_event_types/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"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"]}}}],"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":"You can fetch a list of admins for a given workspace."},{"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_599","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_594"}],"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_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can retrieve the details of a single admin."},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{admin_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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}"},{"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}]}]}]}]}},{"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":"You can retrieve a list of all content import sources for a 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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can create a new content import source by sending a POST request to this endpoint."},{"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_594"}],"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.16","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","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"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."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"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"]}}}],"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":"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":"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"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"]}}}],"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":"You can update an existing content import source."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1content_import_sources~1{source_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}}],"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":"You can retrieve a list of all external pages for a 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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]},{"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_594"}],"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.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"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"]}}}],"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":"You can retrieve an external page."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"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"]}}}],"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":"You can update an existing external page (if it was created via the API)."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ai~1external_pages~1{page_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-content/updateexternalpage"}],"panels":[]}]},"httpPath":"/ai/external_pages/{page_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}]}]}]}]}},{"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":[]}]}]}]}]},{"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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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 cannot be managed via the Articles API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints."},"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_594"}],"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.16","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"],"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":"Bad Request","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/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/~1articles/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/400/content/application~1json/examples/Bad Request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 cannot be managed via the Articles API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints."},"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","401","404"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/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}/put/responses/404/content/application~1json/examples/Article Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/404/content/application~1json/examples/Article Not Found"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}/put/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}/put/responses/404/content/application~1json/examples/Article Not Found"]}}}],"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":[]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/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"]}],"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"]}}}],"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":" when the article has no staged draft."},"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only versioned text content (such as "},"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":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is staged."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-versioned fields like AI availability are ignored, leaving the live"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values untouched."},"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 must be published before a draft can be staged","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}~1draft/put/responses/422/content/application~1json/examples/Article 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"],"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"]}}}],"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":"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","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_594"}],"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_600","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_600","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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_600","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_600","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_595","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_595"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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_595","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_595","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_595","description":"The number of results to return per page.","example":25},{"name":"locale","in":"query","schemaId":"schema_597","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 locale is not configured for the workspace, 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_594"}],"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_595"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_595"},{"name":"per_page","in":"query","required":false,"example":25,"schemaId":"schema_595"},{"name":"locale","in":"query","required":false,"example":"en","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"Unknown 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/Unknown locale"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/Unknown 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/Unknown 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/Unknown 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":"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_595","description":"The unique identifier for the article.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_597","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_597","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 locale is not configured for the workspace, 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_594"}],"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_595"},{"name":"id","in":"path","required":true,"example":"301","schemaId":"schema_597"}],"query":[{"name":"locale","in":"query","required":false,"example":"en","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"Unknown 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/Unknown locale"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/Unknown 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/Unknown 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/Unknown 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":[]}]}]}]},{"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_597","description":"The phrase within your articles to search for.","example":"Getting started"},{"name":"state","in":"query","schemaId":"schema_597","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":"."},"children":[]}]}]}],"example":"published"},{"name":"help_center_id","in":"query","schemaId":"schema_595","description":"The ID of the Help Center to search in.","example":123},{"name":"highlight","in":"query","schemaId":"schema_599","description":"Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.","example":false}],"pointer":"/paths/~1articles~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"},{"name":"state","in":"query","required":false,"example":"published","schemaId":"schema_597"},{"name":"help_center_id","in":"query","required":false,"example":123,"schemaId":"schema_595"},{"name":"highlight","in":"query","required":false,"example":false,"schemaId":"schema_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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"]}},"schemaId":"components/schemas/article_search_response","exampleIds":["paths/~1articles~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/~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"],"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"]}}},{"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":"You can fetch a list of all audiences for the workspace."},{"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_595","description":"The page of results to fetch. Defaults to first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_601","description":"The number of results to return per page. Defaults to 50. Maximum is 50.","example":50}],"pointer":"/paths/~1audiences/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_595"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_601"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]},{"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_594"}],"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.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/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/~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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"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/Validation error"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Validation error"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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/Validation error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Validation error"]}}}],"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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1audiences~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"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_594"}],"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.16","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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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 across surfaces, so a banner dismissed through this endpoint will also stop appearing in 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":"Records that a contact has dismissed a banner. Dismissals are shared across\nsurfaces, so a banner dismissed through this endpoint will also stop appearing\nin the web Messenger for that contact, and vice versa.\n\nThe request is idempotent: dismissing an already-dismissed banner succeeds and\nreturns the same response.\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_597","description":"The unique identifier of a contact.","required":true},{"name":"view_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"view_id","in":"path","required":true,"schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"404","description":"Banner view 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"]}},"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"]}],"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":"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"],"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"]}}}],"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"}},"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":"Retrieves all brands for the workspace, including the default brand.\nThe default brand id always matches the workspace\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_594"}],"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.16","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"}},"schemaId":"components/schemas/error"}],"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","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"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":"Fetches a specific brand by its unique identifier"},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"}},"schemaId":"components/schemas/error"},{"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","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"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":"Retrieve a paginated list of calls.\n"},{"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_595","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_595","description":"How many results to display per page. Defaults to 25. Max 25.","example":25}],"pointer":"/paths/~1calls/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_595"},{"name":"per_page","in":"query","required":false,"example":25,"schemaId":"schema_595"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"Retrieve a single call by id."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_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/~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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"Redirects to a signed URL for the call's recording if it exists."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_602"},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"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/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/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"],"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"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1recording/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}~1recording/get/responses/404/content/application~1json/examples/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 downloadable text file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showCallTranscript","name":"Get call transcript by call id","isWebhook":false,"pointer":"/paths/~1calls~1{call_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":"Returns the transcript for the specified call as a downloadable text file.\n"},{"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_597","description":"The id of the call","required":true}],"pointer":"/paths/~1calls~1{call_id}~1transcript/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"pointer":"/paths/~1calls~1{call_id}~1transcript/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calls/{call_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":"call_id","in":"path","required":true,"schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/calls/{call_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":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_603","exampleIds":["paths/~1calls~1{call_id}~1transcript/get/responses/200/content/text~1plain/examples/transcript_txt"]}},"schemaId":"schema_603","exampleIds":["paths/~1calls~1{call_id}~1transcript/get/responses/200/content/text~1plain/examples/transcript_txt"],"headers":{"Content-Disposition":{"description":"File attachment directive and suggested filename for the transcript","schema":{"type":"string","example":"attachment; filename=transcription_data-2025-07-17.txt"}}},"headerSchemaId":"schema_604"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"]}],"pointer":"/paths/~1calls~1{call_id}~1transcript/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_603","exampleIds":["paths/~1calls~1{call_id}~1transcript/get/responses/200/content/text~1plain/examples/transcript_txt"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_603","exampleIds":["paths/~1calls~1{call_id}~1transcript/get/responses/200/content/text~1plain/examples/transcript_txt"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1{call_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{call_id}~1transcript/get/responses/404/content/application~1json/examples/Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calls/showcalltranscript"}],"panels":[]}]},"httpPath":"/calls/{call_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":[]}]}]}]},{"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_594"}],"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_605","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"schema_605","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_605","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_605","exampleIds":["paths/~1calls~1search/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_605","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_606","exampleIds":["paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_606","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1calls~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_606","exampleIds":["paths/~1calls~1search/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_606","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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1calls~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"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":[],"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"}},"schemaId":"components/schemas/ai_call_response"},{"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","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai_call_response"}}},{"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":"Retrieve information about a Fin Voice call using the external reference 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_595","description":"The external reference ID","required":true}],"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_595"}],"query":[],"querystring":[],"header":[],"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":"Retrieve information about a Fin Voice call using the external call identifier."},{"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_597","description":"The external call identifier from the call provider","required":true}],"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_597"}],"query":[],"querystring":[],"header":[],"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":"Retrieve information about a Fin Voice call using the phone number.\n\nReturns the most recent matched call for the given phone number, ordered by creation date.\n"},{"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_597","description":"Phone number in E.164 format","required":true}],"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_597"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["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":"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":"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":"Retrieve information about Fin Voice calls associated with a conversation.\n\nReturns all matched calls for the given conversation ID. A conversation may have multiple associated calls.\n"},{"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_597","description":"The Intercom conversation identifier","required":true}],"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_597"}],"query":[],"querystring":[],"header":[],"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_607"}},"schemaId":"schema_607"},{"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_607","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_607"}}},{"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":[]}]}]}}],"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}]},{"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/{call_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":"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":[]}]}]}]}]},{"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_594"}],"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.16","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"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/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/~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/400/content/application~1json/examples/Bad Request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]},{"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_597","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_597","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_597","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_597","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":"page","in":"query","schemaId":"schema_595","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_595","description":"How many results to display per page. Defaults to 15","example":15}],"pointer":"/paths/~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"},{"name":"company_id","in":"query","required":false,"example":"12345","schemaId":"schema_597"},{"name":"tag_id","in":"query","required":false,"example":"678910","schemaId":"schema_597"},{"name":"segment_id","in":"query","required":false,"example":"98765","schemaId":"schema_597"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_595"},{"name":"per_page","in":"query","required":false,"example":15,"schemaId":"schema_595"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"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":"components/schemas/company_list","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies/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/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"]}],"pointer":"/paths/~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_list","exampleIds":["paths/~1companies/get/responses/200/content/application~1json/examples/Successful"]}}},{"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"]}}}],"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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/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":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{company_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/~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":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{company_id}/get/responses/200/content/application~1json/examples/Successful"]}}},{"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":"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":[]}]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","401","404"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/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}/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"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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"]}}}],"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":"This endpoint does not permanently remove the company. It archives the company record and detaches any contacts attached to it; the contacts themselves are not deleted. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook is sent once archival completes."},"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":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"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 — archival is processed asynchronously."},"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":[]}]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/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}/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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"You can fetch a list of all contacts that belong to a 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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/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}~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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}},{"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":"You can fetch a list of all segments that belong to a 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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1segments/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}~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"],"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"]}}},{"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":"You can fetch a list of notes that are associated to a 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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can add a note to 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_597","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_594"}],"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_608","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_608","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_608","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","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_608","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_608","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":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"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":"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":"."},"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":"page","in":"query","schemaId":"schema_595","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_595","description":"How many results to return per page. Defaults to 15","example":15},{"name":"order","in":"query","schemaId":"schema_597","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"},"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_594"}],"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_595"},{"name":"per_page","in":"query","required":false,"example":15,"schemaId":"schema_595"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1list/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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. You'll get an error message if you try to have more than one open per app."},"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 will fail"},"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, \"companies\" will be empty and the scroll parameter will expire"},"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":[]}]}]}]}]},{"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_597","description":""}],"pointer":"/paths/~1companies~1scroll/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1scroll/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can attach a company to a single 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_597","description":"The unique identifier for the contact which is given by Intercom","required":true}],"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_594"}],"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_609","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_609","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,"schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_609","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_609","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_609","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/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/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company 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"],"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"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company 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"]}}}],"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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can detach a company from a single 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_597","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"},{"name":"company_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"company_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/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~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"],"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"]}}},{"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}"},{"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/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}]}]}]}]}},{"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":"You can fetch a list of all contacts that belong to a 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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/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}~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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{company_id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}},{"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":"You can attach a company to a single 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_597","description":"The unique identifier for the contact which is given by Intercom","required":true}],"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_594"}],"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_609","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_609","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,"schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_609","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_609","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_609","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/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/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company 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"],"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"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies/post/responses/404/content/application~1json/examples/Company 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"]}}}],"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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can detach a company from a single 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_597","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"},{"name":"company_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"company_id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{company_id}/delete/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~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"],"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"]}}},{"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":"You can fetch a list of notes 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_597","description":"The unique identifier of a contact.","required":true}],"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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can add a note to a single 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_595","description":"The unique identifier of a given contact.","required":true,"example":"123"}],"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_594"}],"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_610","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_610","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":"123","schemaId":"schema_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_610","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","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_610","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_610","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":"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":"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":"You can fetch a list of segments 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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/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}~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"],"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"]}}},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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:\n\n  1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n  2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n"},{"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_597","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_594"}],"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_611","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_611","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_611","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_611","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_611","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"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 will return a subscription type model for the subscription type that was removed from 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":"You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact."},{"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_597","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"subscription_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"subscription_id","in":"path","required":true,"example":"37846","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 for the 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":"You can tag a specific contact. This will return a tag object for the tag that was added to the 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_597","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_594"}],"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_612","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_612","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_612","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_612","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_612","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/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/~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"],"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"]}}},{"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 a tag 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":"You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the 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_597","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"tag_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_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/~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"],"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"]}}},{"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":"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":[]}]}]}]}]},{"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_597","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_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"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_594"}],"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_614","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_614","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_597"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_614","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","401"],"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_614","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_614","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_615","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_615","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1{contact_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_615","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_615","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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]}]},{"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_597","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_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"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_594"}],"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_597"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","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_615","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_615","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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_616"}],"pointer":"/paths/~1contacts~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_615","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615","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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"You can delete a single 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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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 will return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"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":[]}]}]}]}]},{"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_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1merge/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"],"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_615","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_615","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_615","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615","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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/mergecontact"}],"panels":[]}]},"httpPath":"/contacts/merge"},{"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":"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":"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.) and Date custom attributes are matched by calendar day. Sub-day precision (hour, minute, second) is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day boundary uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your workspace's timezone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so the same query can return different results on two workspaces in different timezones."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because the value is truncated to a day:"},"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":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches the whole day."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":" day, not from the instant you passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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."},"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":"!="},"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 Date 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":", on a workspace set to UTC. 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) truncates that value 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). Because "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starts at the next day, the results begin from January 2nd, 2020 12:00 AM UTC - not from 9:00 AM on January 1st. On a workspace in another timezone, the boundaries fall on that timezone's midnight instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get contacts created on January 1st, 2020, search for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1577836800"},"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":"Only search queries behave this way. Responses still 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"},"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":"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"},"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":"formatted_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":"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":"signed_up_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":"last_seen_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_contacted_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_replied_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_email_opened_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_email_clicked_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":"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_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":"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":"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":"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_app_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":"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":"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_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":"andoid_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":"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":"String"},"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 fields"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date 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":", and any Date custom attribute) 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 an error."},"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":" 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."},"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":"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"},"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 fields, 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":"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 fields, 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":"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 fields"},"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":"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 fields"},"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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_merge_history","in":"query","schemaId":"schema_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts~1search/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/400/content/application~1json/examples/Invalid sort order"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1search/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/searchcontacts"}],"panels":[]}]},"httpPath":"/contacts/search"},{"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":"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/#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":"include_merge_history","in":"query","schemaId":"schema_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"children":[]}]}]}]}],"pointer":"/paths/~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can create a new contact (ie. user or lead)."},{"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_594"}],"pointer":"/paths/~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_617","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401"],"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_617","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_617","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_615","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_615","exampleIds":["paths/~1contacts/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/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_615","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]}]},{"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_597","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_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"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_594"}],"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_597"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","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_615","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"schema_615","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1find_by_external_id~1{external_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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_618"}],"pointer":"/paths/~1contacts~1find_by_external_id~1{external_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_615","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_615","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"],"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"]}}},{"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":"You can archive a single 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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"}],"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"}}}],"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":"You can unarchive a single 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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"}],"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"}}}],"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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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 across surfaces, so a banner dismissed through this endpoint will also stop appearing in 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":"Records that a contact has dismissed a banner. Dismissals are shared across\nsurfaces, so a banner dismissed through this endpoint will also stop appearing\nin the web Messenger for that contact, and vice versa.\n\nThe request is idempotent: dismissing an already-dismissed banner succeeds and\nreturns the same response.\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_597","description":"The unique identifier of a contact.","required":true},{"name":"view_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"view_id","in":"path","required":true,"schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"404","description":"Banner view 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"]}},"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"]}],"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":"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"],"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"]}}}],"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":[]}]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"}],"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"}}}],"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_history/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":[]}]}]}]},{"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_597","description":"The id of the contact to fetch merge history for.","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}~1merge_history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_597","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_619","description":"The number of results to return per page (default 50, max 150)."},{"name":"order","in":"query","schemaId":"schema_620","description":"The order to return results in. Defaults to descending."}],"pointer":"/paths/~1contacts~1{id}~1merge_history/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"pointer":"/paths/~1contacts~1{id}~1merge_history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{id}/merge_history","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"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_597"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_597"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_619"},{"name":"order","in":"query","required":false,"schemaId":"schema_620"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{id}/merge_history","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_history/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/merge_history_list","exampleIds":["paths/~1contacts~1{id}~1merge_history/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_history/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_history/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}~1merge_history/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_history/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1merge_history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/merge_history_list","exampleIds":["paths/~1contacts~1{id}~1merge_history/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_history/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_history/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_history/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1merge_history/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}~1merge_history/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactmergehistory"}],"panels":[]}]},"httpPath":"/contacts/{id}/merge_history"},{"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":[]}]}]}}],"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}]},{"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/{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/search","summary":"Search contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/searchcontacts","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_history","summary":"Get contact merge history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactmergehistory","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_594"}],"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.16","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","403","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":"Unauthorized","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1bulk_actions/post/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 — token 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"}},"schemaId":"components/schemas/error"},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1bulk_actions/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","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":"/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_621","description":"A free-text search term matched against the title and body of each content item. When omitted, returns the most recent content items.","example":"billing"},{"name":"page","in":"query","schemaId":"schema_622","description":"The page number to fetch. Defaults to 1. Values below 1 are clamped to 1.","example":1},{"name":"per_page","in":"query","schemaId":"schema_623","description":"Number of results per page. Defaults to 10. Maximum 50.","example":10},{"name":"states","in":"query","schemaId":"schema_624","description":"Filter by publication state. Accepts a comma-separated list or repeated params.","example":"published,draft"},{"name":"locales","in":"query","schemaId":"schema_625","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_626","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_627","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_626","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_626","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_628","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_629","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_630","description":"Filter by whether the content is enabled for Copilot.","example":"on"},{"name":"fin_service_state","in":"query","schemaId":"schema_630","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_630","description":"Filter by whether the content is enabled for Fin Sales Agent.","example":"on"},{"name":"created_by_ids","in":"query","schemaId":"schema_626","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_626","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_595","description":"Return content created at or after this time. Unix epoch seconds.","example":1677253093},{"name":"created_at_before","in":"query","schemaId":"schema_595","description":"Return content created at or before this time. Unix epoch seconds.","example":1677861493},{"name":"updated_at_after","in":"query","schemaId":"schema_595","description":"Return content last updated at or after this time. Unix epoch seconds.","example":1677253093},{"name":"updated_at_before","in":"query","schemaId":"schema_595","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_594"}],"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_621"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_622"},{"name":"per_page","in":"query","required":false,"example":10,"schemaId":"schema_623"},{"name":"states","in":"query","required":false,"example":"published,draft","schemaId":"schema_624","style":"form","explode":false},{"name":"locales","in":"query","required":false,"example":"en,fr","schemaId":"schema_625","style":"form","explode":false},{"name":"tag_ids","in":"query","required":false,"example":"1,2,3","schemaId":"schema_626","style":"form","explode":false},{"name":"tag_operator","in":"query","required":false,"example":"IN","schemaId":"schema_627"},{"name":"any_tag_ids","in":"query","required":false,"example":"1,2,3","schemaId":"schema_626","style":"form","explode":false},{"name":"folder_ids","in":"query","required":false,"example":"10,20","schemaId":"schema_626","style":"form","explode":false},{"name":"folder_entity_type","in":"query","required":false,"example":"folder","schemaId":"schema_628"},{"name":"content_types","in":"query","required":false,"example":"article,snippet","schemaId":"schema_629","style":"form","explode":false},{"name":"copilot_state","in":"query","required":false,"example":"on","schemaId":"schema_630"},{"name":"fin_service_state","in":"query","required":false,"example":"on","schemaId":"schema_630"},{"name":"fin_sales_state","in":"query","required":false,"example":"on","schemaId":"schema_630"},{"name":"created_by_ids","in":"query","required":false,"example":"991267464,991267465","schemaId":"schema_626","style":"form","explode":false},{"name":"last_updated_by_ids","in":"query","required":false,"example":"991267464,991267465","schemaId":"schema_626","style":"form","explode":false},{"name":"created_at_after","in":"query","required":false,"example":1677253093,"schemaId":"schema_595"},{"name":"created_at_before","in":"query","required":false,"example":1677861493,"schemaId":"schema_595"},{"name":"updated_at_after","in":"query","required":false,"example":1677253093,"schemaId":"schema_595"},{"name":"updated_at_before","in":"query","required":false,"example":1677861493,"schemaId":"schema_595"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"401","description":"Unauthorized","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/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/~1content~1search/get/responses/422/content/application~1json/examples/ValidationError"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/ValidationError"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/ValidationError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content~1search/get/responses/422/content/application~1json/examples/ValidationError"]}}}],"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":"You can fetch a list of all content snippets for a workspace."},{"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_631","description":"The page of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_632","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_594"}],"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_631"},{"name":"per_page","in":"query","required":false,"example":20,"schemaId":"schema_632"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"]}],"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"]}}}],"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":"You can create a new content snippet."},{"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_594"}],"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.16","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","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":"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":"Validation error","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error"]}],"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":"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets/post/responses/422/content/application~1json/examples/Validation error"]}}}],"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":"You can fetch a single content snippet by its 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_633","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_594"}],"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_633"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can update an existing content snippet."},{"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_633","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_594"}],"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_633"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"Validation error","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/put/responses/422/content/application~1json/examples/Validation error"]}],"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":"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"],"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"]}}}],"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":"You can delete a single content snippet by its 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_633","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_594"}],"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_633"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","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":"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","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1content_snippets~1{id}/delete/responses/422/content/application~1json/examples/Content snippet has procedure dependencies"]}],"pointer":"/paths/~1content_snippets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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"],"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"]}}}],"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_597","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_594"}],"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_600","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_600","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_600","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_600","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_597","description":"The unique identifier for the content snippet.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_597","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_594"}],"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_634","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_634","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_634","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_634","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_634","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_597","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_597","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_594"}],"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_635","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_635","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_597"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_635","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_635","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_635","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_636","description":"How many results per page"},{"name":"starting_after","in":"query","schemaId":"schema_597","description":"String used to get the next page of conversations."}],"pointer":"/paths/~1conversations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_636"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"user_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":" 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":"contact"},"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_594"}],"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.16","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","401","403","404"],"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_637","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]}},"schemaId":"schema_637","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]},{"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"]}],"pointer":"/paths/~1conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_637","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_637","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]}}},{"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"]}}}],"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_595","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_597","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."},"children":[]}]}]}],"example":"plaintext"},{"name":"include_translations","in":"query","schemaId":"schema_599","description":"If set to true, conversation parts will be translated to the detected language of the conversation.","example":true}],"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_594"}],"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_595"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_597"},{"name":"include_translations","in":"query","required":false,"example":true,"schemaId":"schema_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","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_597","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."},"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_594"}],"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_595"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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_595","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_599","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_594"}],"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_595"}],"query":[{"name":"retain_metrics","in":"query","required":false,"example":true,"schemaId":"schema_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"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":"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.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":"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.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_d"},"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 (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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_monitors","in":"query","schemaId":"schema_613","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 any QA monitor results that flagged it."},"children":[]}]}]}],"example":true},{"name":"include_scorecards","in":"query","schemaId":"schema_613","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_594"}],"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_613"},{"name":"include_scorecards","in":"query","required":false,"example":true,"schemaId":"schema_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"],"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"]}],"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"]}}}],"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":[]}]}]}]}]},{"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_597","description":"The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","401","403","404"],"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":"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":"API plan restricted","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/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}~1reply/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}],"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":"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"],"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"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1reply/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}~1reply/post/responses/404/content/application~1json/examples/Not found"]}}}],"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":[]}]}]}]}]},{"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_597","description":"The identifier for the conversation as given by Intercom.","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_594"}],"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_638","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_638","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_638","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","401","403","404"],"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_638","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_638","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":"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":"API plan restricted","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/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}~1parts/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/post/responses/404/content/application~1json/examples/Not found"]}],"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":"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"],"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"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1parts/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}~1parts/post/responses/404/content/application~1json/examples/Not found"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a 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","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","exampleIds":["paths/~1conversations~1{conversation_id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a 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_597","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"},{"name":"contact_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"contact_id","in":"path","required":true,"example":"123","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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","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","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":"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","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","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":"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 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_597","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_639","description":"The page number of results to return (starting from 1)."},{"name":"per_page","in":"query","schemaId":"schema_640","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_594"}],"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_597"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_639"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_640"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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_594"}],"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.16","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. When the secondary is a ticket,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_tickets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope is also required."},"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1convert/post/responses/400/content/application~1json/examples/Bad request"]}],"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"],"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"]}}}],"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_595","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_641","description":"How many results per page"},{"name":"order","in":"query","schemaId":"schema_597","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_594"}],"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_595"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_641"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"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"]}],"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"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listdeletedconversationids"}],"panels":[]}]},"httpPath":"/conversations/deleted"},{"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":"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":"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":"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":[]}]}]}}],"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":"Conversation Scorecard Evaluator Result","link":"/conversations/conversation_scorecard_evaluator_result","deprecated":false},{"title":"Reviewed Teammate","link":"/conversations/conversation_scorecard_reviewed_teammate","deprecated":false},{"title":"Merge Conversations Request","link":"/conversations/merge_conversations_request","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}/side_conversations","summary":"List side conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listsideconversations","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}]}]}]}]}},{"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_599","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_594"}],"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_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_594"}],"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.16","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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid data_type"},"children":[]}]}]}],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1attributes/post/responses/422/content/application~1json/examples/Invalid data_type"]}}}],"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"],"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"]}],"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"]}}}],"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/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"]}],"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"]}}}],"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","description":"The conversation attribute id","required":true,"example":2},{"name":"option_id","in":"path","schemaId":"schema_597","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_594"}],"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_595"},{"name":"option_id","in":"path","required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","description":"The conversation attribute id","required":true,"example":2},{"name":"option_id","in":"path","schemaId":"schema_597","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_594"}],"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_595"},{"name":"option_id","in":"path","required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":[]}]}]}]}]},{"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_597","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_613","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. Only returned for contacts with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role."},"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_594"}],"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_614","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_614","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_597"}],"query":[{"name":"include_merge_history","in":"query","required":false,"schemaId":"schema_613"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_614","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","401"],"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_614","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_614","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_615","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_615","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1{contact_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_615","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_615","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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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_595","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_597","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."},"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_594"}],"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_595"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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":"Create or update a custom object instance"},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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)."},"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_597","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_597","description":"Return instances associated with the given contact ID."},{"name":"references_conversation_id","in":"query","schemaId":"schema_597","description":"Return instances associated with the given conversation ID."},{"name":"external_id","in":"query","schemaId":"schema_597","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_595","description":"Page number of results to fetch."},{"name":"per_page","in":"query","schemaId":"schema_642","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_594"}],"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_597"}],"query":[{"name":"references_contact_id","in":"query","required":false,"schemaId":"schema_597"},{"name":"references_conversation_id","in":"query","required":false,"schemaId":"schema_597"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_597"},{"name":"page","in":"query","required":false,"schemaId":"schema_595"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_642"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/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":"components/schemas/custom_object_instances_paginated_list","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/custom_object_instances_paginated_list","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_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/~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":"components/schemas/custom_object_instances_paginated_list","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":"components/schemas/custom_object_instances_paginated_list","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/get/responses/200/content/application~1json/examples/successful"]}}},{"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/deletecustomobjectinstancesbyid","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/deletecustomobjectinstancesbyid","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":"deleteCustomObjectInstancesById","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":[]}]}]}]},{"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_597","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_643","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_594"}],"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_597"}],"query":[{"name":"external_id","in":"query","required":true,"schemaId":"schema_643","style":"form"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/deletecustomobjectinstancesbyid","openApiOperationId":"deleteCustomObjectInstancesById","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":"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/deletecustomobjectinstancesbyid"}],"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":"Fetch a Custom Object Instance by id."},{"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_597","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id or external_id of the custom object instance"},"children":[]}]}]}],"required":true},{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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}~1{custom_object_instance_id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/custom_object_instance","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_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/~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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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":"components/schemas/custom_object_instance","exampleIds":["paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/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}~1{custom_object_instance_id}/get/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}/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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"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/deletecustomobjectinstancesbyexternalid","routeSlug":"/docs/references/rest-api/api.intercom.io/custom-object-instances/deletecustomobjectinstancesbyexternalid","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":"deleteCustomObjectInstancesByExternalId","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":"Delete a single Custom Object instance using the Intercom defined id."},{"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_597","description":"The Intercom defined id of the custom object instance","required":true},{"name":"custom_object_type_identifier","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"custom_object_type_identifier","in":"path","required":true,"example":"Order","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/deletecustomobjectinstancesbyexternalid","openApiOperationId":"deleteCustomObjectInstancesByExternalId","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":"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-object-instances/deletecustomobjectinstancesbyexternalid"}],"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/deletecustomobjectinstancesbyid","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/deletecustomobjectinstancesbyexternalid","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":[]}]}]}]}]},{"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_644","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_599","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_594"}],"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_644"},{"name":"include_archived","in":"query","required":false,"example":false,"schemaId":"schema_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]},{"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_594"}],"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.16","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"],"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":"Too few options for list","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{data_attribute_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"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":"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.\n"},{"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_645","description":"The number of results to return per page. Defaults to 20, minimum 1, maximum 50."},{"name":"starting_after","in":"query","schemaId":"schema_597","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_594"}],"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_645"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]},{"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_594"}],"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.16","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","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized"]},{"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"You can retrieve the full detail of a single data connector by its ID.\n\nThe response includes configuration, data inputs, response fields, and object mappings.\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_597","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_646","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_594"}],"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_597"}],"query":[{"name":"state_version","in":"query","required":false,"schemaId":"schema_646"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"]},{"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{id}/patch/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]},{"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_647","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_648","description":"The number of results per page (1-30, default 10)."},{"name":"starting_after","in":"query","schemaId":"schema_597","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_649","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_650","description":"Filter by error type."},{"name":"start_ts","in":"query","schemaId":"schema_595","description":"Unix timestamp for start of time range (default 1 hour ago)."},{"name":"end_ts","in":"query","schemaId":"schema_595","description":"Unix timestamp for end of time range (default now)."},{"name":"include_bodies","in":"query","schemaId":"schema_649","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_594"}],"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_647"}],"query":[{"name":"per_page","in":"query","required":false,"schemaId":"schema_648"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_597"},{"name":"success","in":"query","required":false,"schemaId":"schema_649"},{"name":"error_type","in":"query","required":false,"schemaId":"schema_650"},{"name":"start_ts","in":"query","required":false,"schemaId":"schema_595"},{"name":"end_ts","in":"query","required":false,"schemaId":"schema_595"},{"name":"include_bodies","in":"query","required":false,"schemaId":"schema_649"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"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"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results/get/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}},{"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. Always includes request/response bodies and the sanitised request URL."}},"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":"Retrieve details for a specific data connector execution result.\nAlways includes request/response bodies and the sanitised request URL.\n"},{"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_647","description":"The unique identifier for the data connector.","required":true},{"name":"id","in":"path","schemaId":"schema_651","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_594"}],"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_647"},{"name":"id","in":"path","required":true,"example":"99001","schemaId":"schema_651"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_connectors~1{data_connector_id}~1execution_results~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"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}"},{"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":[]}]}]}}],"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}]},{"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}]}]}]}]}},{"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 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event."},"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":[]}]}]}]}]},{"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_594"}],"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.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercom_user_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":"."},"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":"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":[]}]}]}]},{"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_652","required":true},{"name":"type","in":"query","schemaId":"schema_597","description":"The value must be user","required":true},{"name":"summary","in":"query","schemaId":"schema_599","description":"summary flag"}],"pointer":"/paths/~1events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_652","style":"form","explode":true},{"name":"type","in":"query","required":true,"schemaId":"schema_597"},{"name":"summary","in":"query","required":false,"schemaId":"schema_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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":"components/schemas/data_event_summary","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/data_event_summary","exampleIds":["paths/~1events/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/~1events/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_event_summary","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data_event_summary","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n"},{"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_594"}],"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.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1events~1summaries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1events~1summaries/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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."},"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 one active job"},"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 one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job."},"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":[]}]}]}]}]},{"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_594"}],"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.16","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"],"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"]}],"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"]}}}],"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 two days"},"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 two days from when the export ob completed. After this, the data will no longer be available."},"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"]}],"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"]}}}],"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"}},"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":"You can cancel your job"},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"]}],"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"]}}}],"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 will be streamed continuously back down to you in a gzipped CSV format."},"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":[]}]}]}]}]},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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"}],"pointer":"/paths/~1download~1content~1data~1{job_identifier}/get/responses"}],"panels":[]},{"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":"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":"Lists all sender email address settings 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_594"}],"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.16","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"}},"schemaId":"components/schemas/error"}],"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","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"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":"Fetches a specific email setting by its unique identifier"},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"}},"schemaId":"components/schemas/error"},{"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","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"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":"Please reach out to your accounts team to discuss access."},"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_594"}],"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_653","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_653","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_653","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"],"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_653","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_653","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_654","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_654","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/Invalid request"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/400/content/application~1json/examples/Invalid request"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1fin~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_654","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_654","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/Invalid request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/400/content/application~1json/examples/Invalid request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1start/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"Please reach out to your accounts team to discuss access."},"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_594"}],"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_655","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_655","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_655","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"],"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_655","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_655","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_656","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_656","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/Invalid request"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Invalid request"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1fin~1reply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_656","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_656","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/Invalid request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Invalid request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1fin~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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 or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSE 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":"Please reach out to your accounts team to discuss access."},"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_594"}],"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_657","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_657","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_657","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","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_657","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_657","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_658","exampleIds":["paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"schema_658","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":"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_659","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_659","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_658","exampleIds":["paths/~1fin~1csat/post/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658","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":"422","schemaId":"schema_659","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_659","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"},{"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 Reply Chunk Event","link":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_reply_chunk_event","routeSlug":"/docs/references/rest-api/api.intercom.io/fin-agent/fin_agent_reply_chunk_event","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fin_agent_reply_chunk_event"},"seo":{"title":"Fin Agent Reply Chunk Event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fin Agent Reply Chunk Event","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fin_agent_reply_chunk_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":"Please reach out to your accounts team to discuss access and tailored, hands-on support."},"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 is centered around two endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/fin/reply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a set of events that notify your application of Fin's status and responses. Events can be delivered via webhooks or Server-Sent Events (SSE). 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, or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sse_subscription_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the API response to subscribe via SSE. 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":"fin_reply_chunk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SSE-only streaming event fired during reply generation (requires streaming enabled)"},"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 Reply Chunk Event","link":"/fin-agent/fin_agent_reply_chunk_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}]}]}]}]}},{"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 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."},"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_597","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_595","description":"The page of results to fetch. Defaults to the first page.","example":1},{"name":"per_page","in":"query","schemaId":"schema_595","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_594"}],"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_597"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_595"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_595"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}~1redirects/post/responses/422/content/application~1json/examples/Invalid data"]}],"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"],"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"]}}}],"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_597","description":"The unique identifier for the help center.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"26","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_597","description":"The unique identifier for the help center.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"26","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"Collections 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 collections first."},"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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":[]}]}]}]},{"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_594"}],"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.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/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/~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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections/post/responses/400/content/application~1json/examples/Bad Request"]}}},{"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":[]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/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/collections/<id>"},"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":"collection_id","in":"path","schemaId":"schema_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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/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/collections/<id>"},"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":"collection_id","in":"path","schemaId":"schema_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_center/<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_center/<id>"},"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":"help_center_id","in":"path","schemaId":"schema_595","description":"The unique identifier for the collection 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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"Collection 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/Collection found"]}},"schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{help_center_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~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":"Collection 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/Collection not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Collection 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/Collection 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/Collection 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/Collection 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/Collection 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":[]}]}]}]},{"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_594"}],"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.16","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":[]}]}]}]},{"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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"successful","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":[]}]}]}]},{"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_594"}],"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/bad_request"]}},"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/bad_request"],"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.16","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/bad_request"]}},"responseCodes":["200","400","401"],"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/bad_request"],"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/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":"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":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/400/content/application~1json/examples/Bad Request"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/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/~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"]}],"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/Bad Request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles/post/responses/400/content/application~1json/examples/Bad Request"]}}},{"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"]}}}],"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":[]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"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"]}],"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"]}}}],"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":[]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","401","404"],"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":"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 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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1internal_articles~1{internal_article_id}/put/responses/404/content/application~1json/examples/Internal article not found"]}],"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":"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"],"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"]}}}],"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":[]}]}]}]},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"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"]}],"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"]}}}],"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_595","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_594"}],"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_600","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_600","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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_600","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_600","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_595","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_595"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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":[]}]}]}]},{"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_597","description":"The ID of the folder to search in.","example":123}],"pointer":"/paths/~1internal_articles~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}],"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"]}}}],"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":"Retrieve the current IP allowlist configuration 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_594"}],"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.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"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_594"}],"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.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/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/~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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ip_allowlist/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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 are allowed to access the Intercom API and web application for your workspace. This is useful for restricting access to your Intercom workspace to specific corporate networks or VPNs."},"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":"Retrieve the status of job execution."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/jobs","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/200/content/application~1json/examples/job status retrieved"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1jobs~1status~1{job_id}/get/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_619","description":"The number of results per page","example":50},{"name":"starting_after","in":"query","schemaId":"schema_597","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_660","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_594"}],"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_619"},{"name":"starting_after","in":"query","example":"WzE3MTk0OTM3NTcuMCwgIjEyMyJd","schemaId":"schema_597"},{"name":"updated_since","in":"query","example":1719474966,"schemaId":"schema_660"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":[]}]}]}]}]},{"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_594"}],"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.16","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","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":"No body supplied for email message","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"]}},"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"]},{"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":"API plan restricted","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted"]},{"code":"422","description":"No subject supplied for email message","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message"]}],"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"],"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"]}}},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1messages/post/responses/422/content/application~1json/examples/No subject supplied for email message"],"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"]}}}],"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_597","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_594"}],"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_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","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":"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":"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_597","description":"The unique identifier for the set of messages to check status for","required":true},{"name":"per_page","in":"query","schemaId":"schema_661","description":"Number of results per page (default 50, max 100)"},{"name":"starting_after","in":"query","schemaId":"schema_597","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_594"}],"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_597"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_661"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"You can fetch a list of all news items"},{"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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can create a news item"},{"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_594"}],"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.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can fetch the details of a single news item."},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"News Item Not Found","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"],"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"]}}},{"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":"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":"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_595","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_594"}],"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/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/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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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~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","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/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/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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"News Item Not Found","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/404/content/application~1json/examples/News Item 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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/put/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}},{"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"],"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"]}}}],"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":"You can delete a single news item."},{"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_595","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_594"}],"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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{news_item_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"News Item Not Found","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"],"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"]}}},{"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":"You can fetch a list of all news items that are live on a given newsfeed"},{"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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}~1items/get/responses/401/content/application~1json/examples/Unauthorized"],"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"]}}}],"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":"You can fetch a list of all newsfeeds"},{"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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can fetch the details of a single newsfeed"},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{newsfeed_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"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"]}}}],"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":"You can fetch a list of notes that are associated to a 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_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can add a note to 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_597","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_594"}],"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_608","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_608","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_608","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","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_608","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_608","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":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"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":"You can fetch a list of notes 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_597","description":"The unique identifier of a contact.","required":true}],"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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"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":"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":"You can add a note to a single 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_595","description":"The unique identifier of a given contact.","required":true,"example":"123"}],"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_594"}],"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_610","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_610","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":"123","schemaId":"schema_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_610","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","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_610","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_610","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":"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":"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_595","description":"The unique identifier of a given note","required":true,"example":1}],"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_594"}],"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":1,"schemaId":"schema_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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}"},{"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}]}]}]}]}},{"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_597","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"456","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"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_597","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"456","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"]},{"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/ValidationError"]}},"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/ValidationError"]}],"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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"]}}},{"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/ValidationError"],"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/ValidationError"]}}}],"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_597","description":"The unique identifier for the office hours schedule.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"456","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_662","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_662","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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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_662","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_662","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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"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."}},"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."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/IntegrationNotFound"]},{"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/ValidationError"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/ValidationError"]}],"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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/IntegrationNotFound"],"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/ObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/IntegrationNotFound"]}}},{"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/ValidationError"],"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/ValidationError"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"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/ObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"]},{"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/ValidationError"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/ValidationError"]}],"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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/ValidationError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/ValidationError"]}}}],"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."}},"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."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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/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_663","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/200/content/application~1json/examples/Office hours schedule deleted"]}},"schemaId":"schema_663","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":"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/ObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}],"pointer":"/paths/~1office_hours_schedules~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_663","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_663","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/ObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/ObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound","paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"]}}}],"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_594"}],"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.16","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_594"}],"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.16","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","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":"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/ValidationError"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/ValidationError"]}],"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":"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/ValidationError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/ValidationError"]}}}],"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 this version onward 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":"For the conversation dataset, from this version onward 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."},{"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_594"}],"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_664"}},"schemaId":"schema_664","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_664"}},"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_664","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_664"}},"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_665"}},"schemaId":"schema_665"},{"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"]}},"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"]},{"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_665","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_665"}}},{"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"],"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"]}}},{"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":"Get export job status"}},"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":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"app_id","in":"query","schemaId":"schema_597","description":"The Intercom defined code of the workspace the company is associated to.","required":true},{"name":"client_id","in":"query","schemaId":"schema_597","required":true},{"name":"job_identifier","in":"query","schemaId":"schema_597","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_594"}],"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":[],"query":[{"name":"app_id","in":"query","required":true,"schemaId":"schema_597"},{"name":"client_id","in":"query","required":true,"schemaId":"schema_597"},{"name":"job_identifier","in":"query","required":true,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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_666","exampleIds":["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_666","exampleIds":["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":"404","description":"When job not found","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_666","exampleIds":["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_666","exampleIds":["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":"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":"List available datasets and attributes"}},"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":"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_594"}],"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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"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_667"}},"schemaId":"schema_667"}],"pointer":"/paths/~1export~1reporting_data~1get_datasets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_667","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_667"}}}],"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":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"app_id","in":"query","schemaId":"schema_597","required":true},{"name":"job_identifier","in":"query","schemaId":"schema_597","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_594"},{"name":"Accept","in":"header","schemaId":"schema_668","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":[],"query":[{"name":"app_id","in":"query","required":true,"schemaId":"schema_597"},{"name":"job_identifier","in":"query","required":true,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"},{"name":"Accept","in":"header","required":true,"example":"application/octet-stream","schemaId":"schema_668"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","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":"Export file downloaded"},{"code":"404","description":"When job not found","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1download~1reporting_data~1{job_identifier}/get/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1download~1reporting_data~1{job_identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1download~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/~1download~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/~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":"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":"You can fetch a list of segments 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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1segments/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}~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"],"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"]}}},{"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":"You can fetch a list of all segments."},{"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_599","description":"It includes the count of contacts that belong to each segment.","example":true}],"pointer":"/paths/~1segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_599"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can fetch the details of a single segment."},{"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_597","description":"The unique identified of a given segment.","required":true,"example":"123"}],"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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{segment_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"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:\n\n  1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n  2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n"},{"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_597","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_594"}],"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_611","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_611","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_611","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_611","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_611","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"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 will return a subscription type model for the subscription type that was removed from 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":"You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact."},{"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_597","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"subscription_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"subscription_id","in":"path","required":true,"example":"37846","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"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"]}}},{"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":"You can list all subscription types. A list of subscription type objects will be returned."},{"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_594"}],"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.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1subscription_types/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-types/listsubscriptiontypes"}],"panels":[]}]},"httpPath":"/subscription_types"},{"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}]}]}]}]}},{"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_594"}],"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"]}},"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"],"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.16","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"]}},"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"],"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"]}},"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":"bad request - invalid number","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"422","description":"unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity"]}},"exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1phone_call_redirects/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"422","exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity"]}}}],"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 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_595","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_594"}],"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_600","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_600","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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_600","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_600","exampleIds":["paths/~1articles~1{article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_595","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_595"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_595","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_594"}],"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_600","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_600","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_595"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_600","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_600","exampleIds":["paths/~1internal_articles~1{internal_article_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_595","description":"The unique identifier for the internal article which is given by Intercom.","required":true,"example":123},{"name":"id","in":"path","schemaId":"schema_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_595"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 for the 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":"You can tag a specific contact. This will return a tag object for the tag that was added to the 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_597","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_594"}],"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_612","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_612","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_612","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_612","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_612","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags/post/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/~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"],"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"]}}},{"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 a tag 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":"You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the 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_597","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"tag_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_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/~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"],"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"]}}},{"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_597","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_594"}],"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_600","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_600","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_600","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_600","exampleIds":["paths/~1content_snippets~1{content_snippet_id}~1tags/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_600","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_597","description":"The unique identifier for the content snippet.","required":true,"example":"123"},{"name":"id","in":"path","schemaId":"schema_597","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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 or tag 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"]}},"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"]}],"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"],"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"]}}}],"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_597","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_594"}],"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_634","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_634","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_634","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_634","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_634","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_597","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_597","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_594"}],"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_635","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_635","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_597"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_635","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_635","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_635","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":"You can fetch a list of all tags for a given workspace.\n\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_594"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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":"components/schemas/tag_list","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag_list","exampleIds":["paths/~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/~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_list","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_list","exampleIds":["paths/~1tags/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":[]}]}]}]},{"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_594"}],"pointer":"/paths/~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_669","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/company_not_found","paths/~1tags/post/requestBody/content/application~1json/examples/user_not_found"]}},"schemaId":"schema_669","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/company_not_found","paths/~1tags/post/requestBody/content/application~1json/examples/user_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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_669","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/company_not_found","paths/~1tags/post/requestBody/content/application~1json/examples/user_not_found"]}},"responseCodes":["200","400","401"],"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_669","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/company_not_found","paths/~1tags/post/requestBody/content/application~1json/examples/user_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_669","exampleIds":["paths/~1tags/post/requestBody/content/application~1json/examples/action_successful","paths/~1tags/post/requestBody/content/application~1json/examples/invalid_parameters","paths/~1tags/post/requestBody/content/application~1json/examples/company_not_found","paths/~1tags/post/requestBody/content/application~1json/examples/user_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"]}},"schemaId":"components/schemas/tag_create_response","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful"]},{"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_create_response","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful"]}}},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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":"You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n"},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/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/~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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"You can delete the details of tags that are on the workspace by passing in the id."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{tag_id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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_597","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_594"}],"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_634","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_634","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_634","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_634","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_634","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_597","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_597","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_594"}],"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_635","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_635","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_597"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_635","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_635","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_635","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":"/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_594"}],"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.16","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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_597","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_670","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_594"}],"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_597"}],"query":[{"name":"idle_threshold","in":"query","required":false,"example":1800,"schemaId":"schema_670"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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."}},"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":"You can get a list of all ticket states for a 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_594"}],"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.16","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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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","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":"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":"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_597","description":"The unique identifier for the ticket type which is given by Intercom.","required":true},{"name":"attribute_id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"attribute_id","in":"path","required":true,"schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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."}},"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."},{"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_594"}],"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.16","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_594"}],"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.16","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","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":"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":"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."}},"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."},{"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}],"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"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_671","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_594"}],"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_672","exampleIds":["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_672","exampleIds":["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_671"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_672","exampleIds":["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_672","exampleIds":["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_672","exampleIds":["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 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 note reply","paths/~1tickets~1{ticket_id}~1reply/post/responses/200/content/application~1json/examples/Admin quick_reply reply"]},{"code":"400","description":"User reply","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{ticket_id}~1reply/post/responses/400/content/application~1json/examples/User reply"]},{"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 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 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"],"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"]}}},{"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_597","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_594"}],"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_634","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_634","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_634","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_634","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_634","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_597","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_597","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_594"}],"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_635","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_635","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_597"},{"name":"tag_id","in":"path","required":true,"example":"7522907","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_635","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_635","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_635","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_597","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_594"}],"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_673","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_673","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_673","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_673","exampleIds":["paths/~1tickets~1{ticket_id}~1linked_conversations/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_673","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_597","description":"The unique identifier for the tracker ticket which is given by Intercom.","required":true,"example":"64619700005694"},{"name":"id","in":"path","schemaId":"schema_597","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_594"}],"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_597"},{"name":"id","in":"path","required":true,"example":"204","schemaId":"schema_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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_594"}],"pointer":"/paths/~1tickets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"]}},"schemaId":"schema_674","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"]}},"responseCodes":["200","401"],"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_674","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","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":"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"]}],"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":"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"]}}}],"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_594"}],"pointer":"/paths/~1tickets~1enqueue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"]}},"schemaId":"schema_674","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.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"]}},"responseCodes":["200","400","401"],"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_674","exampleIds":["paths/~1tickets~1enqueue/post/requestBody/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","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"]}],"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"]}}}],"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_597","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_594"}],"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_675","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_675","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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_675","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"],"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_675","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_675","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":"Ticket state id is not valid or is not associated with the ticket type.","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."]}},"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."]},{"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":"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"]}},"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"]}],"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."],"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."]}}},{"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"],"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"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}],"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"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"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"]}],"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"]}}}],"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_597","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_594"}],"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_597"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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."},"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":"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":"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":"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":"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":"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":"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":"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":"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/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_594"}],"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.16","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"],"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"]}],"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"]}}}],"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":[]}]}]}]},{"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_594"}],"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.16","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","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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized"]},{"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":"You can fetch the details of a single visitor."},{"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_597","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_594"}],"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_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized"]},{"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"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"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":[]}]}]}]}]},{"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_594"}],"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.16","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","401"],"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":"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"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized"]}],"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":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"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_597","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_594"}],"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_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","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":"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":"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_597","description":"The unique identifier for the set of messages to check status for","required":true},{"name":"per_page","in":"query","schemaId":"schema_661","description":"Number of results per page (default 50, max 100)"},{"name":"starting_after","in":"query","schemaId":"schema_597","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_594"}],"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_597"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_661"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_597"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","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":"Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.\n\nThis endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.\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_647","description":"The unique identifier for the workflow","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_594"}],"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_647"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.16","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404"],"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":"403","description":"Workflow export is not available for this app","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/403/content/application~1json/examples/Feature not available"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/403/content/application~1json/examples/Feature not available"]},{"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"]}],"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":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/403/content/application~1json/examples/Feature not available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1export~1workflows~1{id}/get/responses/403/content/application~1json/examples/Feature not available"]}}},{"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"]}}}],"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":"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":"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":"Assign 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":"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/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":"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":"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":"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":"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 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 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 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":"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":"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 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":"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 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 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":"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":"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":"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":"metadata","link":"/docs/references/rest-api/api.intercom.io/models/metadata","routeSlug":"/docs/references/rest-api/api.intercom.io/models/metadata","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"metadata"},"seo":{"title":"metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/metadata"},"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":"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":"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":"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 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":"Create 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":"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/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 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 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":"AI Call Response","link":"/models/ai_call_response","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":"Assign Conversation Request","link":"/models/attach_contact_to_conversation_request","deprecated":false},{"title":"Audience List","link":"/models/audience_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":"Calls","link":"/models/call_list","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":"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 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 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 Object Instance Deleted","link":"/models/custom_object_instance_deleted","deprecated":false},{"title":"Custom Object Instances","link":"/models/custom_object_instance_list","deprecated":false},{"title":"customer_request","link":"/models/customer_request","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 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":"Conversations","link":"/models/deleted_conversation_list","deprecated":false},{"title":"Deleted Data Connector Object","link":"/models/deleted_data_connector_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 Object","link":"/models/deleted_object","deprecated":false},{"title":"detach_contact_from_conversation_request","link":"/models/detach_contact_from_conversation_request","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":"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":"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":"metadata","link":"/models/metadata","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":"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":"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":"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 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":"Create 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 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 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":[]}]}]}],"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":"."},"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":"The request payload for creating an office hours schedule.","required":["name","time_zone_name","time_intervals"],"properties":{"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":[{"$$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."},"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":"The request payload for updating an office hours schedule. Only the provided fields are updated.","properties":{"name":{"type":"string","description":"The name of the office hours schedule.","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."},"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":"."},"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."},"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":"."},"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":"The request payload for updating an office hours exception. Only the provided fields are updated.","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."},"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":"."},"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":{"id":{"type":"string","description":"The id representing the activity.","example":"6"},"performed_by":{"type":"object","description":"Details about the Admin involved in the activity.","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_conversation_assignment_limit_change","admin_ticket_assignment_limit_change","admin_avatar_change","admin_away_mode_change","admin_deletion","admin_deprovisioned","admin_impersonation_end","admin_impersonation_start","admin_impersonation_consent_approved","admin_impersonation_consent_revoked","admin_invite_change","admin_invite_creation","admin_invite_deletion","admin_login_failure","admin_login_success","admin_logout","admin_password_reset_request","admin_password_reset_success","admin_permission_change","admin_provisioned","admin_two_factor_auth_change","admin_unauthorized_sign_in_method","app_admin_join","app_authentication_method_change","app_data_deletion","app_data_export","app_google_sso_domain_change","app_identity_verification_change","app_name_change","app_outbound_address_change","app_package_installation","app_package_token_regeneration","app_package_uninstallation","app_team_creation","app_team_deletion","app_team_membership_modification","app_timezone_change","app_webhook_creation","app_webhook_deletion","articles_in_messenger_enabled_change","automatic_away_mode_setting_change","bulk_delete","bulk_export","campaign_deletion","campaign_state_change","conversation_deletion_schedule_creation","conversation_deletion_schedule_deletion","conversation_deletion_schedule_state_change","conversation_deletion_schedule_update","conversation_part_deletion","conversation_pdf_export","conversation_topic_change","conversation_topic_creation","conversation_topic_deletion","content_redaction_rule_creation","content_redaction_rule_deletion","content_redaction_rule_update","csv_import_completion","csv_import_creation","custom_authentication_token_creation","help_center_settings_change","inbound_conversations_change","inbox_access_change","inbox_bulk_action","macro_creation","macro_deletion","macro_update","macro_usage_export","malicious_domains_setting_change","message_deletion","message_state_change","messenger_api_secret_creation","messenger_api_secret_deletion","messenger_look_and_feel_change","messenger_search_required_change","messenger_spaces_change","oauth_token_revocation","office_hours_change","role_change","role_creation","role_deletion","ruleset_activation_title_preview","ruleset_creation","ruleset_deletion","search_browse_enabled_change","search_browse_required_change","seat_change","seat_revoke","security_settings_change","series_creation","series_deletion","series_settings_update","series_status_change","series_update","strip_inbound_email_links_change","temporary_expectation_change","team_assignment_limit_change","trusted_domains_setting_change","unassign_unsnoozed_at_capacity_setting_change","unassign_unsnoozed_when_away_setting_change","upfront_email_collection_change","allowed_attachment_filetypes_setting_change","attach_uploads_inline_setting_change","teammate_gifs_setting_change","user_camera_attachments_setting_change","user_conversation_attachments_setting_change","user_file_attachments_setting_change","user_gifs_setting_change","user_media_attachments_setting_change","user_voice_notes_setting_change","welcome_message_change","workspace_deletion_request","hide_csat_from_agents_setting_change"],"example":"app_name_change"},"activity_description":{"type":"string","description":"A sentence or two describing the activity.","example":"Admin updated the app's name to \"My App\"."}}}},"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/cursor_pages"},"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"},"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","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":"This object represents the avatar associated with the admin.","example":[814865],"items":{"type":"integer"}},"avatar":{"type":"string","format":"uri","nullable":true,"description":"Image for the associated team or teammate","example":"https://picsum.photos/200/300"},"team_priority_level":{"$ref":"#/components/schemas/team_priority_level"},"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}},"required":["message_type","type","admin_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","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},"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"},"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":[]}}}},"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}}}},"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":"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.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"role","type":"role","comparison":"eq","value":"user"}]},"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":"A condition used to filter contacts in an audience.","properties":{"attribute":{"type":"string","description":"The attribute to filter on.","example":"company.name"},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"comparison":{"type":"string","description":"The comparison operator.","example":"contains"},"value":{"type":"string","description":"The value to compare against.","example":"Acme"}}}},"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},"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/cursor_pages"},"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/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/cursor_pages"},"total_count":{"type":"integer","description":"A count of the total number of articles.","example":1},"data":{"type":"array","description":"An array of Article objects","items":{"$ref":"#/components/schemas/article_list_item"}}}}},"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"},"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]},"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"}}}},"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":{"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":"internal_article"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["internal_article"],"default":"internal_article","example":"internal_article"},"id":{"type":"string","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."},"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}}}},"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.","properties":{"articles":{"type":"array","description":"An array of Article objects","items":{"$ref":"#/components/schemas/article"}},"highlights":{"type":"array","description":"A corresponding array of highlighted Article content","items":{"$ref":"#/components/schemas/article_search_highlights"}}}},"pages":{"$ref":"#/components/schemas/cursor_pages"}}}},"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},"data":{"type":"object","description":"An object containing the results of the search.","properties":{"internal_articles":{"type":"array","description":"An array of Internal Article objects","items":{"$ref":"#/components/schemas/internal_article"}}}},"pages":{"$ref":"#/components/schemas/cursor_pages"}}}},"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},"conversions":{"type":"integer","description":"The number of conversations started from the article.","example":0},"reactions":{"type":"integer","description":"The number of total reactions the article has received.","example":10},"happy_reaction_percentage":{"type":"number","format":"float","description":"The percentage of happy reactions the article has received against other types of reaction.","example":40},"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":"text","inline":true,"attributes":{"content":"Whether this version is the currently published version of the article ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an earlier non-live version ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"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/cursor_pages"},"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":"text","inline":true,"attributes":{"content":"Whether this version is the currently published version of the article ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an earlier non-live version ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"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."}},"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":"Assign Conversation Request","data":{"title":"Assign Conversation Request","type":"object","description":"Payload of the request to assign a conversation","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."},"children":[]}]}]}],"example":"12345"},"customer":{"type":"object","oneOf":[{"title":"Intercom User ID","properties":{"intercom_user_id":{"type":"string","description":"The identifier for the contact as given by Intercom.","example":"6329bd9ffe4e2e91dac76188"},"customer":{"$ref":"#/components/schemas/customer_request"}},"required":["intercom_user_id"]},{"title":"User ID","properties":{"user_id":{"type":"string","description":[{"$$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":"6329bd9ffe4e2e91dac76188"},"customer":{"$ref":"#/components/schemas/customer_request"}},"required":["user_id"]},{"title":"Email","properties":{"email":{"type":"string","description":"The email you have defined for the contact who is being added as a participant.","example":"winstonsmith@truth.org"},"customer":{"$ref":"#/components/schemas/customer_request"}},"required":["email"]}]}}}},"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/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},"created_at":{"type":"integer","description":"The Unix timestamp when the status reason was created","example":1734537243},"updated_at":{"type":"integer","description":"The Unix timestamp when the status reason was last updated","example":1734537243}}}},"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!"}},"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":{"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 or collection within a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"help center, so that links to old or external URLs resolve to 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":"The source URL that is redirected. An absolute URL within the help center's URL space.","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":"The type of the redirect target.","enum":["article","collection"],"example":"article"},"target_id":{"type":"string","description":"The unique identifier of the target article or collection. 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/cursor_pages"},"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":"The type of the redirect target.","enum":["article","collection"],"example":"article"},"target_id":{"type":"string","description":"The unique identifier of the target article or collection. The target must be a member of the help center.","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/cursor_pages"},"total_count":{"type":"integer","description":"A count of the total number of collections.","example":1},"data":{"type":"array","description":"An array of collection objects","items":{"$ref":"#/components/schemas/collection"}}}}},"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":"The name of the company.","example":"Blue Sun"},"app_id":{"type":"string","description":"The Intercom defined code of the workspace the company is associated to.","example":"ecahpwf5"},"plan":{"type":"object","properties":{"type":{"type":"string","description":"Value is always \"plan\"","example":"plan"},"id":{"type":"string","description":"The id of the plan","example":"269315"},"name":{"type":"string","description":"The name of the plan","example":"Pro"}}},"company_id":{"type":"string","description":"The company id you have defined for the company.","example":"6"},"remote_created_at":{"type":"integer","description":"The time the company was created by you.","example":1663597223},"created_at":{"type":"integer","description":"The time the company was added in Intercom.","example":1663597223},"updated_at":{"type":"integer","description":"The last time the company was updated.","example":1663597223},"last_request_at":{"type":"integer","description":"The time the company last recorded making a request.","example":1663597223},"size":{"type":"integer","description":"The number of employees in the company.","example":100},"website":{"type":"string","description":"The URL for the company website.","example":"https://www.intercom.com"},"industry":{"type":"string","description":"The industry that the company operates in.","example":"Software"},"monthly_spend":{"type":"integer","description":"How much revenue the company generates for your business.","example":100},"session_count":{"type":"integer","description":"How many sessions the company has recorded.","example":100},"user_count":{"type":"integer","description":"The number of users in the company.","example":100},"custom_attributes":{"type":"object","description":"The custom attributes you have set on the company.","additionalProperties":{"type":"string"},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"tags":{"type":"object","description":"The list of tags associated with the company","properties":{"type":{"type":"string","description":"The type of the object","enum":["tag.list"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/tag_basic"}}}},"segments":{"type":"object","description":"The list of segments associated with the company","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment.list"]},"segments":{"type":"array","items":{"$ref":"#/components/schemas/segment"}}}},"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"]},"notes":{"type":"array","items":{"$ref":"#/components/schemas/company_note"}}}}}}},"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":"Notes allow you to annotate and comment on 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":"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},"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":[]}]}]}],"example":"company"},"id":{"type":"string","description":"The id of the company.","example":"6329bd9ffe4e2e91dac76188"}}},"author":{"$ref":"#/components/schemas/admin","description":"Optional. Represents the Admin that created the note."},"body":{"type":"string","description":"The body text of the note.","example":"<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":"This will return a list of companies 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 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":{"$ref":"#/components/schemas/cursor_pages"},"total_count":{"type":"integer","description":"The total number of companies","nullable":true,"example":100},"scroll_param":{"type":"string","description":"The scroll parameter to use in the next request to fetch the next page of results.","example":"25b649f7-4d33-4ef6-88f5-60e5b8244309"}}}},"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"},"phone":{"type":"string","nullable":true,"description":"The contacts phone.","example":"+1123456789"},"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":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type of object","example":"avatar"},"image_url":{"type":"string","format":"uri","nullable":true,"description":"An image URL containing the avatar of a contact.","example":"https://example.org/128Wash.jpg"}}},"tags":{"$ref":"#/components/schemas/contact_tags"},"notes":{"$ref":"#/components/schemas/contact_notes"},"companies":{"$ref":"#/components/schemas/contact_companies"},"location":{"$ref":"#/components/schemas/contact_location"},"social_profiles":{"$ref":"#/components/schemas/contact_social_profiles"},"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. 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. 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."},"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"},"companies":{"type":"array","description":"An array containing Company Objects","items":{"$ref":"#/components/schemas/company"}},"total_count":{"type":"integer","description":"The total number of companies associated to this contact","example":100},"pages":{"$ref":"#/components/schemas/pages_link"}}}},"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_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/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"}}}},"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"}}}},"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."},"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","body"]}},"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"]}},"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"]}},"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"]}},"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":{"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/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 external_page"},"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":"The status of the content import source.","enum":["active","deactivated"],"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.","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"]},"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.","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":"# How to reset your password\n\nNavigate 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. Whether this snippet is available for Fin (1 = on, 0 = off)."},"children":[]}]}]}],"example":1},"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. Whether this snippet is available for Copilot (1 = on, 0 = off)."},"children":[]}]}]}],"example":1},"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 must 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."},"children":[]}]}]}],"nullable":false,"required":["title"],"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":"# 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 false.","default":false,"example":true},"ai_copilot_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Copilot. Defaults to false.","default":false,"example":true},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the content snippet should be available for AI Sales Agent. Defaults to false.","default":false,"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/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, or null when on the last page.","nullable":true,"example":"https://api.intercom.io/content/search?query=billing&page=2"},"prev":{"type":"string","format":"uri","description":"A link to the previous page of results, or null when on the first page.","nullable":true,"example":null}}},"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."},"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":"QA monitor evaluations that flagged this conversation. 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":"QA monitor evaluations that flagged this conversation. 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 that flagged 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":"The evaluation outcome reported by the monitor.","example":"flagged"},"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"},"scorecard_version_id":{"type":"string","description":"The unique identifier of the specific scorecard version that produced this result.","example":"67891"},"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"},"evaluators":{"type":"array","description":"Per-evaluator results within this scorecard.","items":{"$ref":"#/components/schemas/conversation_scorecard_evaluator"}}}}},"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"},"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"},"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."},"reason_ids":{"type":"array","nullable":true,"description":"Identifiers for structured reasons assigned to the result, if any.","items":{"type":"string"},"example":["101","102"]},"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":"reason_ids"},"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_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":"always conversation","enum":["conversation"],"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/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":"The type of conversation part.","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},"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 id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)"},"children":[]}]}]}]},"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},"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."}}}},"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":"The name of the author","example":"Operator"},"email":{"type":"string","format":"email","description":"The email of the author","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":"","example":1}}}},"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_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":{"$ref":"#/components/schemas/reference"}}}},"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/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"},"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"},"teammates":{"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":"The unique identifiers retained after converting or merging.","properties":{"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"user_id":{"type":"string","description":[{"$$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"]}]},"visitor":{"type":"object","description":"The unique identifiers to convert a single Visitor.","properties":{"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"user_id":{"type":"string","description":"A unique identifier for the contact which is given to Intercom.","example":"8a88a590-e1c3-41e2-a502-e0649dbf721c"},"email":{"type":"string","description":"The visitor's email.","example":"winstonsmith@truth.org"}},"anyOf":[{"required":["id"]},{"required":["user_id"]},{"required":["email"]}]}},"required":["type","user","visitor"]}},"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.","items":{"$ref":"#/components/schemas/predicate"},"example":[{"attribute":"role","type":"role","comparison":"eq","value":"user"}]}}}},"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":"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":"# Hello\n\nA paragraph with **bold** text.\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":". 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_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 parent, which can either be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"collection"},"translated_content":{"$ref":"#/components/schemas/article_translated_content"},"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. 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. 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. Rejected with 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the article has never been published. 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"}},"required":["title","author_id"]}},"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":"."},"children":[]}]}]}],"example":"# Internal Guide\n\nSome instructions.\n"},"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},"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":"The name of the collection. For multilingual collections, this will be the name of the default language's content.","example":"collection 51"},"description":{"type":"string","description":"The description of the collection. For multilingual collections, this will be the description of the default language's content.","example":"English description"},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"},"parent_id":{"type":"string","nullable":true,"description":[{"$$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"}},"required":["name"]}},"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":"The role of the contact.","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":"Whether the contact's email address has been verified. Set to true to indicate you have verified the contact owns this email address, or false to mark it as unverified. Must be supplied together with an email in the same request; sending it without an email returns a 400.","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},"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.","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","contact"],"description":"The role associated to the contact - user or lead.","example":"user"},"id":{"type":"string","description":"The identifier for the contact which is given by Intercom.","format":"uuid","minLength":24,"maxLength":24,"example":"536e564f316c83104c000020"}},"required":["type","id"]},"body":{"type":"string","description":"The content of the message. HTML is not supported.","example":"Hello"},"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","datetime","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":"Optional metadata about the event.","additionalProperties":{"type":"string"},"example":{"invite_code":"ADDAFRIEND"}}},"anyOf":[{"title":"id required","required":["event_name","created_at","id"]},{"title":"user_id required","required":["event_name","created_at","user_id"]},{"title":"email required","required":["event_name","created_at","email"]}]}},"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","properties":{"user_id":{"type":"string","description":"Your identifier for the user.","example":"314159"},"event_summaries":{"type":"object","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":[]}]}]}],"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},"locale":{"type":"string","description":"Always en","enum":["en"],"default":"en","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"}},"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":[]}]}]}],"enum":["in_app","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"}]}]},"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}},"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":"You can create or update a Company","nullable":true,"properties":{"name":{"type":"string","description":"The name of the Company","example":"Intercom"},"company_id":{"type":"string","description":"The company id you have defined for the company. Can't be updated","example":"625e90fc55ab113b6d92175f"},"plan":{"type":"string","description":"The name of the plan you have associated with the company.","example":"Enterprise"},"size":{"type":"integer","description":"The number of employees in this company.","example":"100"},"website":{"type":"string","description":"The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.","example":"https://www.example.com"},"industry":{"type":"string","description":"The industry that this company operates in.","example":"Manufacturing"},"custom_attributes":{"type":"object","description":"A hash of key/value pairs containing any other data about the company you want Intercom to store.","additionalProperties":{"type":"string"},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"remote_created_at":{"type":"integer","description":"The time the company was created by you.","example":1394531169},"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. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.."},"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","example":"Intercom"},"plan":{"type":"string","description":"The name of the plan you have associated with the company.","example":"Enterprise"},"size":{"type":"integer","description":"The number of employees in this company.","example":"100"},"website":{"type":"string","description":"The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.","example":"https://www.example.com"},"industry":{"type":"string","description":"The industry that this company operates in.","example":"Manufacturing"},"custom_attributes":{"type":"object","description":"A hash of key/value pairs containing any other data about the company you want Intercom to store.","additionalProperties":{"type":"string"},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"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. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.."},"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":"A unique identifier for the Custom Object instance in the external system it originated from."},"external_created_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time when the Custom Object instance was created in the external system it originated from.","example":1571672154},"external_updated_at":{"type":"integer","format":"date-time","nullable":true,"description":"The time when the Custom Object instance was last updated in the external system it originated from.","example":1571672154},"custom_attributes":{"type":"object","nullable":true,"description":"The custom attributes which are set for the Custom Object instance.","additionalProperties":{"type":"string"}}}}},"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.","type":"object","title":"Create or Update Tag Request Payload","properties":{"name":{"type":"string","description":"The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.","example":"Independent"},"id":{"type":"string","description":"The id of tag to updates.","example":"656452352"}},"required":["name"]}},"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":{"$ref":"#/components/schemas/custom_attributes"}},"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","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"}}}},"required":["ticket_type_id","contacts"]}},"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","description","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"]}},"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":{"$ref":"#/components/schemas/starting_after_paging"},"per_page":{"type":"integer","description":"Number of results per page","example":2},"total_pages":{"type":"integer","description":"Total number of pages","example":13}}}},"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":"completed"},"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":"completed"},"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."}}}},"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/cursor_pages"}}}},"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 different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models. System-defined attributes such as \"CX Score rating\" and \"CX Score explanation\" may also be included.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"$ref":"#/components/schemas/datetime"},{"$ref":"#/components/schemas/custom_object_instance_list"}]},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9,"start_date_iso8601":"2023-03-04T09:46:14Z","end_date_timestamp":1677923174,"CX Score rating":4,"CX Score explanation":"The conversation was resolved quickly and the customer expressed satisfaction with the outcome."}}},"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":"The custom attributes you have set on the custom object instance.","additionalProperties":{"type":"string"}}}}},"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_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":"The data type of the attribute.","enum":["string","integer","float","boolean","date"],"example":"boolean"},"options":{"type":"array","description":"List of predefined options for attribute value.","items":{"type":"string"},"example":["true","false"]},"api_writable":{"type":"boolean","description":"Can this attribute be updated through API","example":true},"messenger_writable":{"type":"boolean","description":"Can this attribute be updated by the Messenger","example":false},"ui_writable":{"type":"boolean","description":"Can this attribute be updated in the UI","example":true},"custom":{"type":"boolean","description":"Set to true if this is a CDA","example":true},"archived":{"type":"boolean","description":"Is this attribute archived. (Only applicable to CDAs)","example":false},"created_at":{"type":"integer","format":"date-time","description":"The time the attribute was created as a UTC Unix timestamp","example":1671028894},"updated_at":{"type":"integer","format":"date-time","description":"The time the attribute was last updated as a UTC Unix timestamp","example":1671028894},"admin_id":{"type":"string","description":"Teammate who created the attribute. Only applicable to CDAs","example":"5712945"}}}},"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","description":"ID of the admin who created the attribute.","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","properties":{"data_type":{"type":"string","enum":["list"]},"options":{"type":"array","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":"."},"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","properties":{"data_type":{"type":"string","enum":["relationship"]},"reference":{"type":"object","description":"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_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"},"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":"HTTP headers to include in the request.","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"}}}},"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."}}}},"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},"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"},"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":"HTTP headers to include in the request.","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"}}}},"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."}}}},"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},"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"},"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"},"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":"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"},"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","nullable":true,"description":"How the connector executes.","enum":["server_side","client_side"],"example":"server_side"},"configuration_response_type":{"type":"string","nullable":true,"description":"The expected response format from the connector.","enum":["test_response_type","mock_response_type"],"example":"test_response_type"},"data_transformation_type":{"type":"string","nullable":true,"description":"The type of data transformation applied to the response.","enum":["full_access","redacted_access","code_block_transformation"]},"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},"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"],"example":"3rd_party_error"},"error_message":{"type":"string","nullable":true,"description":"A human-readable error message. Query parameters, userinfo, and fragments in URLs are redacted.","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"],"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":"The request URL. Query parameters, userinfo, and fragments are redacted.","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":"WzE3MDc1OTQ3MTUuMCw5OTAwMF0="}}}}}}}},"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":"WzE3MDc1OTQ3MTUuMCwxMjM0NV0="}}}}}}}},"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.","additionalProperties":{"type":"string"},"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.","example":"1674917488"},"download_url":{"type":"string","description":"The location where you can download your data.","example":"https://api.intercom.test/download/messages/data/example"}}}},"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":"Whether the company was deleted successfully or not.","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/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/metadata":{"id":"components/schemas/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_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_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/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"}]}},"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":{"type":"string","description":"A string indicating the kind of error, used to further qualify the HTTP response code","example":"unauthorized"},"message":{"type":"string","nullable":true,"description":"Optional. Human readable description of the error.","example":"Access Token Invalid"},"field":{"type":"string","nullable":true,"description":"Optional. Used to identify a particular field or query parameter that was in error.","example":"email"}},"required":["code"]}}},"required":["type","errors"]}},"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":"Always en","enum":["en"],"default":"en","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"},"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}},"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":"The author that created the message.","example":"user"},"body":{"type":"string","description":"The body of the message. Accepts both plain text and HTML format.\nWhen sending a message to Fin, this should contain the user's message.\nFin's response will be returned as HTML.\n","example":"How can I see my account details?"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp when the message was created.\nUsed to deduplicate messages sent within a 5 minute window.\nIdeally should include milliseconds for higher precision.\n","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":"Only present in webhook event responses (fin_replied)."},"children":[]}]}]}],"example":"2025-01-24T10:01:20.456Z"}},"required":["author","body","timestamp"]}},"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":"An array of previous messages in the conversation before Fin is initialized.\nThis data provides context to Fin and helps generate a better answer.\nLimit to the last 10 messages.\n","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 10 attributes.\n","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 or SSE. 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":["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":"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, in which case the SSE stream is held open past complete until it is delivered or the token expires"},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values include:"},"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":[]}]}]}]}],"example":"Escalation requested by user"},"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 or SSE. 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":"The HTML body of Fin's response.","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>"},"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"}},"required":["author","body","timestamp_ms"]},"status":{"type":"string","enum":["replying","awaiting_user_reply"],"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":[]}]}]}]}],"example":"replying"},"stream_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. Present when the reply was generated via streaming."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correlates this event with the fin_reply_chunk events that preceded it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to know when to replace streamed chunk_text with the final message body."},"children":[]}]}]}],"example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"},"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_reply_chunk_event":{"id":"components/schemas/fin_agent_reply_chunk_event","kind":"json-schema","title":"Fin Agent Reply Chunk Event","data":{"title":"Fin Agent Reply Chunk Event","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSE-only event fired during streaming reply generation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each chunk contains the full accumulated plain text of Fin's answer so far (cumulative, not a delta)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only delivered over SSE when streaming is enabled. Not available via webhooks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the fin_replied event arrives with the same stream_id, replace streamed text with the final HTML body."},"children":[]}]}]}],"x-tags":["Fin Agent"],"properties":{"event_name":{"type":"string","enum":["fin_reply_chunk"],"description":"The name of the event.","example":"fin_reply_chunk"},"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"123456"},"stream_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 this streaming response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correlates chunks with each other and with the eventual fin_replied event."},"children":[]}]}]}],"example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"},"chunk_index":{"type":"integer","description":"0-based counter for this chunk within the stream. Contiguous.\n","example":3},"chunk_text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full accumulated plain text of Fin's answer so far."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each chunk supersedes the previous — replace rather than append."},"children":[]}]}]}],"example":"You can see your account details by clicking"},"status":{"type":"string","enum":["replying"],"description":"Fin's current status (always 'replying' for this event).","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","stream_id","chunk_index","chunk_text","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 or SSE. 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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Over SSE this event arrives after Fin reaches 'complete'. Because a survey is expected,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'complete' does not close the stream: the connection is held open so this event can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered, and the token is revoked once it is sent."},"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/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)","example":123,"nullable":true},"resource_url":{"type":"string","description":"The url of the resource created during job exeuction. Use this url to fetch the resource.","example":"http://api.intercom.io/tickets/123","nullable":true}},"required":["id"]}},"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":"By default, it's equal to the version set in the app package."},"children":[]}]}]}],"type":"string","example":"2.16","default":"2.16","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"]}},"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. Absent 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_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"],"description":"The type of message that was sent. Can be email, inapp, facebook or twitter.","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"}},"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.","items":{"type":"string","nullable":true,"description":"The label name.","example":"Product Update"}},"cover_image_url":{"type":"string","format":"uri","nullable":true,"description":"URL of the image used as cover. Must have .jpg or .png extension.","example":"https://example.com/cover.jpg"},"reactions":{"type":"array","description":"Ordered list of emoji reactions to the news item. When empty, reactions are disabled.","items":{"type":"string","nullable":true,"description":"The emoji reaction to the news item.","example":"👍"}},"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}}}},"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"]},"reactions":{"type":"array","description":"Ordered list of emoji reactions to the news item. When empty, reactions are disabled.","items":{"type":"string","nullable":true},"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/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":"The name of the newsfeed. This name will never be visible to your users.","example":"My Newsfeed"},"created_at":{"type":"integer","format":"timestamp","description":"Timestamp for when the newsfeed was created.","example":1674917488},"updated_at":{"type":"integer","format":"timestamp","description":"Timestamp for when the newsfeed was last updated.","example":1674917488}}}},"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. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).","example":198313},"published_at":{"type":"integer","format":"timestamp","description":"Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\".","example":1674917488}}}},"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":{"$ref":"#/components/schemas/admin","description":"Optional. Represents the Admin that created the note."},"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":"A paginated list of notes associated with a contact or a company.","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/cursor_pages"}}}},"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"}},"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":"A link to the next page of results. A response that does not contain a next link does not have further data to fetch.","nullable":true},"per_page":{"type":"integer","example":50},"total_pages":{"type":"integer","example":1}}}},"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","conversation.list"],"example":"list"},"pages":{"$ref":"#/components/schemas/cursor_pages"},"total_count":{"type":"integer","description":"A count of the total number of objects.","example":1},"data":{"type":"array","description":"An array of Objects","items":{"anyOf":[{"$ref":"#/components/schemas/news_item"},{"$ref":"#/components/schemas/newsfeed"}]}}}}},"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"},"phone":{"type":"string","description":"Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.","example":"+1 1234567890"}}}},"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\", or defaults to \"aws_connect\""},"children":[]}]}]}],"enum":["five9","zoom_phone","aws_connect"],"example":"aws_connect"},"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"}]}},"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"}},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_count=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the request."},"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 result may also have a pages object if the response is paginated.","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment.list"],"example":"segment.list"},"segments":{"type":"array","description":"A list of Segment objects","items":{"$ref":"#/components/schemas/segment"}},"pages":{"type":"object","description":"A pagination object, which may be empty, indicating no further pages to fetch."}}}},"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":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields (all standard timestamp attributes and 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":", "},"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":" are not supported and return an error."},"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","cancelled","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, and conversations and list them using that tag.","properties":{"type":{"type":"string","description":"value is \"tag\"","example":"tag"},"id":{"type":"string","description":"The id of the tag","example":"123456"},"name":{"type":"string","description":"The name of the tag","example":"Test tag"},"applied_at":{"type":"integer","format":"date-time","nullable":true,"description":"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, or ticket.","example":1663597223},"applied_by":{"type":"object","nullable":true,"description":"The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.","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","description":"The name of the tag, which will be created if not found.","example":"Independent"},"companies":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The Intercom defined id representing the company.","example":"531ee472cce572a6ec000006"},"company_id":{"type":"string","description":"The company id you have defined for the company.","example":"6"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id or company_id of the company can be passed as input parameters."},"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 a list of users.","type":"object","title":"Tag Users Request Payload","properties":{"name":{"type":"string","description":"The name of the tag, which will be created if not found.","example":"Independent"},"users":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The Intercom defined id representing the user.","example":"5f7f0d217289f8d2f4262080"}}}}},"required":["name","users"]}},"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","properties":{"type":{"type":"string","description":"The type of the object","enum":["tag.list"],"example":"tag.list"},"tags":{"type":"array","description":"A list of tags objects associated with the conversation.","items":{"$ref":"#/components/schemas/tag"}}}}},"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},"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"},{"$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 id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)"},"children":[]}]}]}]},"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."},"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}}}},"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":")."},"children":[]}]}]}],"additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"number"},{"type":"boolean"},{"type":"array"}]},"example":{"_default_title_":"Found a bug","_default_description_":"The button is not working"}}},"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 ticket types associated with a given 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 list of ticket type attributes associated with a given ticket type.","items":{"$ref":"#/components/schemas/ticket_type"}}}}}}},"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},"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","description":"Input options for the attribute","example":"multiline: true"},"order":{"type":"integer","description":"The order of the attribute against other attributes","example":1},"required_to_create":{"type":"boolean","description":"Whether the attribute is required or not for teammates.","default":false,"example":false},"required_to_create_for_contacts":{"type":"boolean","description":"Whether the attribute is required or not for contacts.","default":false,"example":false},"visible_on_create":{"type":"boolean","description":"Whether the attribute is visible or not to teammates.","default":true,"example":false},"visible_to_contacts":{"type":"boolean","description":"Whether the attribute is visible or not to contacts.","default":true,"example":false},"default":{"type":"boolean","description":"Whether the attribute is built in or not.","example":true},"ticket_type_id":{"type":"integer","description":"The id of the ticket type that the attribute belongs to.","example":42},"archived":{"type":"boolean","description":"Whether the ticket type attribute is archived or not.","example":false},"created_at":{"type":"integer","format":"timestamp","description":"The date and time the ticket type attribute was created."},"updated_at":{"type":"integer","format":"timestamp","description":"The date and time the ticket type attribute was last updated."}}}},"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":"ticket_type_attributes.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ticket_type_attributes":{"type":"array","description":"A list of ticket type attributes associated with a given ticket type.","items":{"$ref":"#/components/schemas/ticket_type_attribute"}}}}},"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","description":"The name of the tag which will be untagged from the company","example":"Independent"},"companies":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The Intercom defined id representing the company.","example":"531ee472cce572a6ec000006"},"company_id":{"type":"string","description":"The company id you have defined for the company.","example":"6"},"untag":{"type":"boolean","description":"Always set to true","example":"true"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id or company_id of the company can be passed as input parameters."},"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":"eq","value":"user"}]}}}},"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"]}}}},"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":". 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":"string","description":"The id of the article's parent collection or section. An article without this field stands alone.","example":"18"},"parent_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of parent, which can either be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"collection"},"translated_content":{"$ref":"#/components/schemas/article_translated_content"},"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. 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. 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. Rejected with 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter_invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the article has never been published. 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":"."},"children":[]}]}]}],"example":"## Updated\n\nNew content.\n"},"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},"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"},"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 updated as the first level collection."},"children":[]}]}]}],"example":"6871118"}}}},"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":"The role of the contact."},"external_id":{"type":"string","description":"A unique identifier for the contact which is given to Intercom"},"email":{"type":"string","description":"The contacts email","example":"jdoe@example.com"},"email_verified":{"type":"boolean","nullable":true,"description":"Whether the contact's email address has been verified. Set to true to indicate you have verified the contact owns this email address, or false to mark it as unverified. Must be supplied together with an email in the same request; sending it without an email returns a 400.","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},"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":"Create Content Import Source Payload","data":{"title":"Create 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","automated","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. 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"},"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.","example":"https://help.example.com/en/articles/1234-getting-started"},"fin_availability":{"type":"boolean","description":"Whether the external page should be used to answer questions by Fin.","default":true,"example":true},"locale":{"type":"string","description":"Always en","enum":["en"],"default":"en","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"}},"required":["title","html","url","locale","source_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":"Specify whether the ticket is visible to users.","example":true},"snoozed_until":{"type":"integer","format":"timestamp","description":"The time you want the ticket to reopen.","example":1673609604},"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.","example":"8a88a590-e"},"user_id":{"type":"string","description":"A unique identified for the visitor which is given by you.","example":"123"},"name":{"type":"string","description":"The visitor's name.","example":"Christian Bale"},"custom_attributes":{"type":"object","description":"The custom attributes which are set for the visitor.","additionalProperties":{"type":"string"},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}}},"anyOf":[{"required":["id"]},{"required":["user_id"]}]}},"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","items":{"$ref":"#/components/schemas/company"}}}},"location_data":{"type":"object","properties":{"type":{"type":"string","description":"","default":"location_data","example":"location_data"},"city_name":{"type":"string","description":"The city name of the visitor.","example":"Dublin"},"continent_code":{"type":"string","description":"The continent code of the visitor.","example":"EU"},"country_code":{"type":"string","description":"The country code of the visitor.","example":"IRL"},"country_name":{"type":"string","description":"The country name of the visitor.","example":"Ireland"},"postal_code":{"type":"string","description":"The postal code of the visitor.","example":"D02 N960"},"region_name":{"type":"string","description":"The region name of the visitor.","example":"Leinster"},"timezone":{"type":"string","description":"The timezone of the visitor.","example":"Europe/Dublin"}}},"las_request_at":{"type":"integer","description":"The time the Lead last recorded making a request.","example":1663597260},"created_at":{"type":"integer","description":"The time the Visitor was added to Intercom.","example":1663597223},"remote_created_at":{"type":"integer","description":"The time the Visitor was added to Intercom.","example":1663597223},"signed_up_at":{"type":"integer","description":"The time the Visitor signed up for your product.","example":1663597223},"updated_at":{"type":"integer","description":"The last time the Visitor was updated.","example":1663597260},"session_count":{"type":"integer","description":"The number of sessions the Visitor has had.","example":1},"social_profiles":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["social_profile.list"],"example":"social_profile.list"},"social_profiles":{"type":"array","items":{"type":"string"}}}},"owner_id":{"type":"string","nullable":true,"description":"The id of the admin that owns the Visitor.","example":"5169261"},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the Visitor is unsubscribed from emails.","example":false},"marked_email_as_spam":{"type":"boolean","description":"Identifies if this visitor has marked an email as spam.","example":false},"has_hard_bounced":{"type":"boolean","description":"Identifies if this visitor has had a hard bounce.","example":false},"tags":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["tag.list"],"example":"tag.list"},"tags":{"type":"array","items":{"properties":{"type":{"type":"string","description":"The type of the object","enum":["tag"],"example":"tag"},"id":{"type":"string","description":"The id of the tag.","example":"8482"},"name":{"type":"string","description":"The name of the tag.","example":"tag_name"}}}}}},"segments":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object","enum":["segment.list"],"example":"segment.list"},"segments":{"type":"array","items":{"type":"string"}}}},"custom_attributes":{"type":"object","description":"The custom attributes you have set on the Visitor.","additionalProperties":{"type":"string"}},"referrer":{"type":"string","nullable":true,"description":"The referer of the visitor.","example":"https://www.google.com/"},"utm_campaign":{"type":"string","nullable":true,"description":[{"$$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":"The unique identifier for the workflow.","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."}}}}}},"schema_594":{"kind":"json-schema","data":{"$ref":"#/components/schemas/intercom_version"},"id":"schema_594"},"schema_595":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_595"},"schema_596":{"kind":"json-schema","data":{"type":"object","required":["away_mode_enabled","away_mode_reassign"],"properties":{"away_mode_enabled":{"type":"boolean","description":"Set to \"true\" to change the status of the admin to away.","example":true,"default":true},"away_mode_reassign":{"type":"boolean","description":"Set to \"true\" to assign any new conversation replies to your default inbox.","example":false,"default":false},"away_status_reason_id":{"type":"integer","description":"The unique identifier of the away status reason","example":12345}}},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"type":"string"},"id":"schema_597"},"schema_598":{"kind":"json-schema","data":{"type":"object","required":["created_at_after"],"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.","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.","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_598"},"schema_599":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_599"},"schema_600":{"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_600"},"schema_601":{"kind":"json-schema","data":{"type":"integer","maximum":50},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":"The signed recording URL"}}},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"type":"string","description":"Transcript text"},"id":"schema_603"},"schema_604":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","example":"attachment; filename=transcription_data-2025-07-17.txt","description":"File attachment directive and suggested filename for the transcript"}}},"id":"schema_604"},"schema_605":{"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_605"},"schema_606":{"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_606"},"schema_607":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ai_call_response"}},"id":"schema_607"},"schema_608":{"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_608"},"schema_609":{"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_609"},"schema_610":{"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_610"},"schema_611":{"kind":"json-schema","data":{"type":"object","required":["id","consent_type"],"properties":{"id":{"type":"string","description":"The unique identifier for the subscription which is given by Intercom","example":"37846"},"consent_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The consent_type of a subscription, opt_out or opt_in."},"children":[]}]}]}],"example":"opt_in"}}},"id":"schema_611"},"schema_612":{"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_612"},"schema_613":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_613"},"schema_614":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/update_contact_request"}]},"id":"schema_614"},"schema_615":{"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_615"},"schema_616":{"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_616"},"schema_617":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/create_contact_request"}]},"id":"schema_617"},"schema_618":{"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_618"},"schema_619":{"kind":"json-schema","data":{"type":"integer","default":50,"minimum":1,"maximum":150},"id":"schema_619"},"schema_620":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"]},"id":"schema_620"},"schema_621":{"kind":"json-schema","data":{"type":"string","maxLength":500},"id":"schema_621"},"schema_622":{"kind":"json-schema","data":{"type":"integer","default":1,"minimum":1},"id":"schema_622"},"schema_623":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":50},"id":"schema_623"},"schema_624":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["published","draft"]}},"id":"schema_624"},"schema_625":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_625"},"schema_626":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_626"},"schema_627":{"kind":"json-schema","data":{"type":"string","enum":["IN","NIN"]},"id":"schema_627"},"schema_628":{"kind":"json-schema","data":{"type":"string","enum":["folder"]},"id":"schema_628"},"schema_629":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["snippet","external_content","file_source_content","internal_article","article"]}},"id":"schema_629"},"schema_630":{"kind":"json-schema","data":{"type":"string","enum":["on","off"]},"id":"schema_630"},"schema_631":{"kind":"json-schema","data":{"type":"integer","example":1},"id":"schema_631"},"schema_632":{"kind":"json-schema","data":{"type":"integer","example":20},"id":"schema_632"},"schema_633":{"kind":"json-schema","data":{"type":"string","example":"123"},"id":"schema_633"},"schema_634":{"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_634"},"schema_635":{"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_635"},"schema_636":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":150},"id":"schema_636"},"schema_637":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/message"}],"required":["conversation_id"]},"id":"schema_637"},"schema_638":{"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_638"},"schema_639":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_639"},"schema_640":{"kind":"json-schema","data":{"type":"integer","default":25,"maximum":50},"id":"schema_640"},"schema_641":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":60},"id":"schema_641"},"schema_642":{"kind":"json-schema","data":{"type":"integer","maximum":150},"id":"schema_642"},"schema_643":{"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_643"},"schema_644":{"kind":"json-schema","data":{"type":"string","enum":["contact","company"]},"id":"schema_644"},"schema_645":{"kind":"json-schema","data":{"type":"integer","default":20,"minimum":1,"maximum":50},"id":"schema_645"},"schema_646":{"kind":"json-schema","data":{"type":"string","enum":["draft","live"],"default":"live"},"id":"schema_646"},"schema_647":{"kind":"json-schema","data":{"type":"string","example":"12345"},"id":"schema_647"},"schema_648":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":30},"id":"schema_648"},"schema_649":{"kind":"json-schema","data":{"type":"string","enum":["true","false"]},"id":"schema_649"},"schema_650":{"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"]},"id":"schema_650"},"schema_651":{"kind":"json-schema","data":{"type":"string","example":"99001"},"id":"schema_651"},"schema_652":{"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}]},"id":"schema_652"},"schema_653":{"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"}},"required":["conversation_id","message","user"]},"id":"schema_653"},"schema_654":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"ext-123"},"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":"Fin's current status in the conversation workflow.\n","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"},"sse_subscription_url":{"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 URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. When CSAT is enabled and a survey will follow the resolution, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" revocation is deferred until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csat_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event is delivered or the token expires."},"children":[]}]}]}],"example":"https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m"}}},"id":"schema_654"},"schema_655":{"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"}}},"required":["conversation_id","message","user"]},"id":"schema_655"},"schema_656":{"kind":"json-schema","data":{"type":"object","properties":{"conversation_id":{"type":"string","description":"The ID of the conversation.","example":"ext-123"},"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":"Fin's current status in the conversation workflow.\n","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"},"sse_subscription_url":{"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 URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status. When CSAT is enabled and a survey will follow the resolution, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" revocation is deferred until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csat_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event is delivered or the token expires."},"children":[]}]}]}],"example":"https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG..."}}},"id":"schema_656"},"schema_657":{"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_657"},"schema_658":{"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_658"},"schema_659":{"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_659"},"schema_660":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_660"},"schema_661":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":100},"id":"schema_661"},"schema_662":{"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_662"},"schema_663":{"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_663"},"schema_664":{"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","items":{"type":"string"},"example":["conversation_id","conversation_started_at"]},"start_time":{"type":"integer","format":"int64","example":1717490000},"end_time":{"type":"integer","format":"int64","example":1717510000}}},"id":"schema_664"},"schema_665":{"kind":"json-schema","data":{"type":"object","properties":{"job_identifier":{"type":"string","example":"job1"},"status":{"type":"string","example":"pending"},"download_url":{"type":"string"},"download_expires_at":{"type":"string"}}},"id":"schema_665"},"schema_666":{"kind":"json-schema","data":{"type":"object","properties":{"job_identifier":{"type":"string"},"status":{"type":"string"},"download_url":{"type":"string"},"download_expires_at":{"type":"string"}}},"id":"schema_666"},"schema_667":{"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_started_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\"). Required when calling the enqueue endpoint.","example":"conversation.conversation_id"},"name":{"type":"string","example":"Conversation ID"}}}}}}}}},"id":"schema_667"},"schema_668":{"kind":"json-schema","data":{"type":"string","example":"application/octet-stream","enum":["application/octet-stream"]},"id":"schema_668"},"schema_669":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/create_or_update_tag_request"},{"$ref":"#/components/schemas/tag_company_request"},{"$ref":"#/components/schemas/untag_company_request"},{"$ref":"#/components/schemas/tag_multiple_users_request"}]},"id":"schema_669"},"schema_670":{"kind":"json-schema","data":{"type":"integer","default":1800,"example":1800},"id":"schema_670"},"schema_671":{"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_671"},"schema_672":{"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_672"},"schema_673":{"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_673"},"schema_674":{"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_674"},"schema_675":{"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_675"}},"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/~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":[]},"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","errors":[{"code":"parameter_invalid","message":"Away status reason is deleted"}]},"key":"parameter_invalid","summary":"Example of an invalid 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_mandatory":{"value":{"type":"error.list","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/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/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~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":[{"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."},{"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/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~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":[{"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/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_log_event_types/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"activity_log_event_type.list","event_types":["admin_conversation_assignment_limit_change","admin_ticket_assignment_limit_change","admin_avatar_change","admin_away_mode_change","admin_deletion","admin_deprovisioned","admin_impersonation_end","admin_impersonation_start","admin_invite_change","admin_invite_creation","admin_invite_deletion","admin_login_failure","admin_login_success","admin_logout","admin_password_reset_request","admin_password_reset_success","admin_permission_change","admin_provisioned","admin_two_factor_auth_change","admin_unauthorized_sign_in_method","app_admin_join","app_authentication_method_change","app_data_deletion","app_data_export","app_google_sso_domain_change","app_identity_verification_change","app_name_change","app_outbound_address_change","app_package_installation","app_package_token_regeneration","app_package_uninstallation","app_team_creation","app_team_deletion","app_team_membership_modification","app_timezone_change","app_webhook_creation","app_webhook_deletion","articles_in_messenger_enabled_change","bulk_delete","bulk_export","campaign_deletion","campaign_state_change","conversation_part_deletion","conversation_pdf_export","conversation_topic_change","conversation_topic_creation","conversation_topic_deletion","help_center_settings_change","inbound_conversations_change","inbox_access_change","inbox_bulk_action","message_deletion","message_state_change","messenger_look_and_feel_change","messenger_search_required_change","messenger_spaces_change","office_hours_change","role_change","role_creation","role_deletion","ruleset_activation_title_preview","ruleset_creation","ruleset_deletion","search_browse_enabled_change","search_browse_required_change","seat_change","seat_revoke","security_settings_change","temporary_expectation_change","upfront_email_collection_change","welcome_message_change","hide_csat_from_agents_setting_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/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~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":[]},"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/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/~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/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/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/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~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}/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}/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/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~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","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","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","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/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/post/requestBody/content/application~1json/examples/successful":{"value":{"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","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/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~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","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}/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","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}/put/requestBody/content/application~1json/examples/successful":{"value":{"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","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/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/~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":[],"tags":{"type":"tag.list","tags":[]},"title":"This is the article title","description":"","body":"","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"}]},"key":"successful","summary":"successful","id":"paths/~1articles/get/responses/200/content/application~1json/examples/successful"},"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,"parent_type":"collection","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":[],"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0},"tags":{"type":"tag.list","tags":[]},"title":"Thanks for everything","description":"Description of the Article","body":"<p class=\"no-margin\">Body of the Article</p>","author_id":991267497,"state":"published","created_at":1734537288,"updated_at":1734537288,"url":"http://help-center.test/myapp-68/en/articles/42-thanks-for-everything"},"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/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~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":[],"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0},"tags":{"type":"tag.list","tags":[]},"title":"This is the article title","description":"","body":"","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"},"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":[],"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0},"tags":{"type":"tag.list","tags":[]},"title":"Christmas is here!","description":"","body":"<p class=\"no-margin\">New gifts in store for the jolly season</p>","author_id":991267508,"state":"published","created_at":1734537297,"updated_at":1734537298,"url":"http://help-center.test/myapp-80/en/articles/48-christmas-is-here"},"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/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/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}/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{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":[],"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,"has_unpublished_changes":true,"draft_updated_at":1734537292,"url":"http://help-center.test/myapp-74/en/articles/45-this-is-the-article-title","ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true},"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":"data_invalid","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":[],"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,"has_unpublished_changes":true,"draft_updated_at":1734537298,"url":"http://help-center.test/myapp-80/en/articles/48-christmas-is-here","ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true},"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":"data_invalid","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":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"Article must be published before a draft can be staged"}]},"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~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":[],"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,"has_unpublished_changes":false,"draft_updated_at":null,"url":"http://help-center.test/myapp-80/en/articles/48-christmas-is-here","ai_chatbot_availability":true,"ai_copilot_availability":true,"ai_sales_agent_availability":true},"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":"data_invalid","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":{"type":"error.list","request_id":"8a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d","errors":[{"code":"parameter_invalid","message":"Article has no draft to publish"}]},"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~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":25,"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/Unknown locale":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"Unknown locale"}]},"key":"Unknown locale","summary":"Unknown locale","id":"paths/~1articles~1{article_id}~1versions/get/responses/400/content/application~1json/examples/Unknown 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":"data_invalid","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/Unknown locale":{"value":{"type":"error.list","request_id":"6f3c2b1a-2d4e-4f6a-9b8c-1a2b3c4d5e6f","errors":[{"code":"parameter_invalid","message":"Unknown locale"}]},"key":"Unknown locale","summary":"Unknown locale","id":"paths/~1articles~1{article_id}~1versions~1{id}/get/responses/400/content/application~1json/examples/Unknown 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":"data_invalid","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":[],"tags":{"type":"tag.list","tags":[]},"title":"Title 1","description":"","body":"","author_id":991267521,"state":"draft","created_at":1734537306,"updated_at":1734537306,"url":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/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":"eq","value":"user"}],"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":"eq","value":"user"}],"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/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":"eq","value":"user"}]},"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":"eq","value":"user"}],"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/422/content/application~1json/examples/Validation error":{"value":{"type":"error.list","request_id":"a3e6b0c1-4f2d-4e8a-9c7b-1d2e3f4a5b6c","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":"eq","value":"user"}],"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/404/content/application~1json/examples/Audience not found":{"value":{"type":"error.list","request_id":"d5e6f7a8-1b2c-3d4e-5f6a-7b8c9d0e1f2a","errors":[{"code":"not_found","message":"Resource 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":"eq","value":"user"}],"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/404/content/application~1json/examples/Audience not found":{"value":{"type":"error.list","request_id":"e7f8a9b0-1c2d-3e4f-5a6b-7c8d9e0f1a2b","errors":[{"code":"not_found","message":"Resource 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/Validation error":{"value":{"type":"error.list","request_id":"f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c","errors":[{"code":"validation_error","message":"Name must not be blank"}]},"key":"Validation error","summary":"Validation error","id":"paths/~1audiences~1{id}/put/responses/422/content/application~1json/examples/Validation error"},"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/404/content/application~1json/examples/Audience not found":{"value":{"type":"error.list","request_id":"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d","errors":[{"code":"not_found","message":"Resource 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/~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/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/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/~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~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/404/content/application~1json/examples/Brand not found":{"value":{"type":"error.list","request_id":"req_12345","errors":[{"code":"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/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~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":"completed","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":"answered","phone":"+15551234567","fin_recording_url":"https://api.intercom.io/calls/124/recording","fin_transcription_url":"https://api.intercom.io/calls/124/transcript"},"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/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/404/content/application~1json/examples/Not Found":{"value":{"type":"error.list","request_id":"9bc4fc62-7cdf-4f72-a56e-02af4836d499","errors":[{"code":"not_found","message":"Recording Not Found"}]},"key":"Not Found","summary":"Not Found","id":"paths/~1calls~1{call_id}~1recording/get/responses/404/content/application~1json/examples/Not Found"},"paths/~1calls~1{call_id}~1transcript/get/responses/200/content/text~1plain/examples/transcript_txt":{"value":"[00:00:03] Teammate 1: \"Hello, thanks for calling. How can I help today?\"\n[00:00:09] User: \"I need help recovering access to my account.\"\n[00:00:15] Teammate 1: \"I can help with that. For security, I’ll ask a few generic verification questions.\"\n[00:00:22] User: \"Okay.\"\n[00:00:28] Teammate 1: \"Please confirm general details on the account (no sensitive data over this call).\"\n[00:00:35] User: \"I can provide non-sensitive info.\"\n[00:00:41] Teammate 1: \"Thank you. I’ll initiate a standard account recovery process and send the next steps.\"\n[00:00:48] User: \"Great, thanks.\"\n[00:00:53] Teammate 1: \"You should receive a message shortly with instructions to complete recovery.\"","key":"transcript_txt","summary":"transcript_txt","id":"paths/~1calls~1{call_id}~1transcript/get/responses/200/content/text~1plain/examples/transcript_txt"},"paths/~1calls~1{call_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{call_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":[{}],"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/~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"}},"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/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/get/responses/200/content/application~1json/examples/Successful":{"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":{}}],"pages":{"type":"pages","next":null,"page":1,"per_page":15,"total_pages":1},"total_count":1},"key":"Successful","summary":"Successful","id":"paths/~1companies/get/responses/200/content/application~1json/examples/Successful"},"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~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":{}},"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/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":{}},"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/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/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}/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/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/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/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/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/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/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~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":{}}],"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/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~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":{}}],"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/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/~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":{}},"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/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/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":{}}],"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/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":{}},"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/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}~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/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":{"contact_id":"6762f0ad1bb69f9f2193bb62","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":{"contact_id":"6762f0af1bb69f9f2193bb63","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":{"contact_id":123,"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/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/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/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/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/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/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~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","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,"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","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,"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/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}/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","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,"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/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~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","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,"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~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/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/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/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/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","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,"enabled_push_messaging":null},"key":"successful","summary":"successful","id":"paths/~1contacts/post/responses/200/content/application~1json/examples/successful"},"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~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","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,"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/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{id}~1merge_history/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_history/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}~1merge_history/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_history/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1merge_history/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":"Contact not found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1merge_history/get/responses/404/content/application~1json/examples/Contact 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":"2e760b85-9020-471b-89dc-f579ec8a0104","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~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,"next":null,"prev":null},"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/422/content/application~1json/examples/ValidationError":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Invalid or duplicated record reference"}]},"key":"ValidationError","summary":"ValidationError","id":"paths/~1content~1search/get/responses/422/content/application~1json/examples/ValidationError"},"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":"# How to reset your password\n\nNavigate to Settings > Security > Reset password.\n","chatbot_availability":1,"copilot_availability":1,"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/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":"# How to reset your password\n\nNavigate to Settings > Security > Reset password.\n","chatbot_availability":1,"copilot_availability":1,"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/404/content/application~1json/examples/Unknown audience IDs":{"value":{"type":"error.list","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","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~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":"# How to reset your password\n\nNavigate to Settings > Security > Reset password.\n","chatbot_availability":1,"copilot_availability":1,"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/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","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":"# How to reset your password (updated)\n\nGo to Settings > Security > Reset password and follow the steps.\n","chatbot_availability":1,"copilot_availability":1,"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/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","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","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","errors":[{"code":"validation_error","message":"The language is not currently supported for Fin"}]},"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}/delete/responses/404/content/application~1json/examples/Content snippet not found":{"value":{"type":"error.list","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","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{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~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/~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}]},"key":"successful","summary":"successful","id":"paths/~1conversations/get/responses/200/content/application~1json/examples/successful"},"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/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~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":{"type":"contact","id":"1a2b3c"},"author":{"type":"admin","id":"274","name":"Operator","email":"operator+abcd1234@intercom.io"},"attachments":[],"external_id":"abcd1234","redacted":false,"email_message_metadata":null,"state":"open","tags":[{"type":"tag","id":"123456","name":"Test tag"}],"event_details":null,"app_package_code":null},{"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/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/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}]},"key":"successful","summary":"successful","id":"paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"},"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/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/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}~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}],"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/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/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}~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/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,"customer":{"intercom_user_id":"6762f1a61bb69f9f2193bbd8"}},"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,"customer":{"intercom_user_id":"6762f1b61bb69f9f2193bbe1"}},"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,"customer":{"intercom_user_id":"6762f1c41bb69f9f2193bbe9"}},"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,"customer":{"intercom_user_id":"6762f1d11bb69f9f2193bbf1"}},"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/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}~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~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":null,"team_assignee_id":null,"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_topics":null,"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":"forbidden","message":"Forbidden request"}]},"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~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~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~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}/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}~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":"A list attribute must have at least 2 active options"}]},"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/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/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/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/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/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/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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/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/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_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/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/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/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1custom_object_instances~1{custom_object_type_identifier}~1{custom_object_instance_id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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~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/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","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":20,"next":{"starting_after":"WzE3MDc1OTQ3MTUuMCwxMjM0NV0="}}},"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/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","state":"draft","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,"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/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/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","http_method":"post","direct_fin_usage":false,"audiences":["users","leads"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":null,"client_function_name":null,"client_function_timeout_ms":null,"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,"validate_missing_attributes":null,"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: live, draft"}]},"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/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/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","http_method":"post","direct_fin_usage":false,"audiences":["users","leads"],"execution_type":"server_side","configuration_response_type":"test_response_type","data_transformation_type":null,"client_function_name":null,"client_function_timeout_ms":null,"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,"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/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/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_status":null,"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":10,"next":{"starting_after":"WzE3MDc1OTQ3MTUuMCw5OTAwMF0="}}},"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"}]},"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/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/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/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/~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/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"event.summary","events":[],"pages":{"next":"http://api.intercom.test/events?next page"},"email":"user26@email.com","intercom_user_id":"6762f22b1bb69f9f2193bc12","user_id":"3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"},"key":"Successful response","summary":"Successful response","id":"paths/~1events/get/responses/200/content/application~1json/examples/Successful response"},"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~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/~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~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~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/~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~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/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","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","sse_subscription_url":"https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m"},"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","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","sse_subscription_url":"https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m","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/Invalid request":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"parameter_invalid","message":"conversation_id is required"}]},"key":"Invalid request","summary":"Invalid request","id":"paths/~1fin~1start/post/responses/400/content/application~1json/examples/Invalid request"},"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~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","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","sse_subscription_url":"https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG..."},"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","user_id":"user-456","status":"thinking","created_at_ms":"2025-01-24T10:00:00.123Z","sse_subscription_url":"https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...","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/Invalid request":{"value":{"type":"error.list","request_id":"b68959ea-6328-4f70-83cb-e7913dba1542","errors":[{"code":"parameter_invalid","message":"conversation_id is required"}]},"key":"Invalid request","summary":"Invalid request","id":"paths/~1fin~1reply/post/responses/400/content/application~1json/examples/Invalid request"},"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~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/422/content/application~1json/examples/Conversation not found":{"value":{"errors":{"external_conversation_id":"Conversation not found for the given external_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/~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' or 'collection'"}]},"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~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","workspace_id":"this_is_an_id96_that_should_be_at_least_4","name":"English collection title","url":"http://help-center.test/myapp-96/collection-17","order":17,"created_at":1734537309,"updated_at":1734537309,"description":"english collection description","icon":"bookmark","parent_id":null,"help_center_id":79},{"id":"160","workspace_id":"this_is_an_id96_that_should_be_at_least_4","name":"English section title","url":"http://help-center.test/myapp-96/section-1","order":1,"created_at":1734537309,"updated_at":1734537309,"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/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","workspace_id":"this_is_an_id100_that_should_be_at_least_","name":"Thanks for everything","url":"http://help-center.test/myapp-100/","order":1,"created_at":1734537312,"updated_at":1734537312,"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/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","workspace_id":"this_is_an_id106_that_should_be_at_least_","name":"English collection title","url":"http://help-center.test/myapp-106/collection-22","order":22,"created_at":1734537315,"updated_at":1734537315,"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","workspace_id":"this_is_an_id112_that_should_be_at_least_","name":"Update collection name","url":"http://help-center.test/myapp-112/collection-25","order":25,"created_at":1734537318,"updated_at":1734537319,"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/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/Collection 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"},"key":"Collection found","summary":"Collection found","id":"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/200/content/application~1json/examples/Collection 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/Collection not found":{"value":{"type":"error.list","request_id":"bbd5de60-49c4-4850-afff-1226cdaa0beb","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Collection not found","summary":"Collection not found","id":"paths/~1help_center~1help_centers~1{help_center_id}/get/responses/404/content/application~1json/examples/Collection 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":25,"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/bad_request":{"value":{"title":"Thanks for everything","body":"Body of the Internal Article"},"key":"bad_request","summary":"Bad Request","id":"paths/~1internal_articles/post/requestBody/content/application~1json/examples/bad_request"},"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/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/~1internal_articles/post/responses/400/content/application~1json/examples/Bad Request"},"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~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":"79abd27a-1bfb-42ec-a404-5728c76ba773","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}/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","body":"Body of the Article","owner_id":991266252,"author_id":991266252,"locale":"en"},"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/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":"f9adccb2-9fca-4b87-bbb7-65f2af5e1d78","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}/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":"afe37506-cc48-4727-8068-ae7ff0e7b0e3","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}~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~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~1search/get/responses/200/content/application~1json/examples/Search successful":{"value":{"type":"list","total_count":1,"data":{"internal_articles":[{"id":"55","body":"Body of the Article","owner_id":991266252,"author_id":991266252,"locale":"en"}]},"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/~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/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/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","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/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/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":"conversation","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/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/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~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","request_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","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/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","request_id":"req_123","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","request_id":"591a0c2f-78b3-41bb-bfa7-f1fae15107b2","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":[null,null,null,null],"deliver_silently":false,"created_at":1734537793,"updated_at":1734537793,"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":[null,null,null,null],"deliver_silently":false,"created_at":1734537793,"updated_at":1734537793,"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/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/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,"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/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~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":[null,null,null,null],"deliver_silently":false,"created_at":1734537800,"updated_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/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,"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/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/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}/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/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/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/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/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~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/~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/~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/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/ValidationError":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Invalid or duplicated record reference"}]},"key":"ValidationError","summary":"ValidationError","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/put/responses/422/content/application~1json/examples/ValidationError"},"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/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"},"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":"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},{"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}]},"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/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/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/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/ValidationError":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Invalid or duplicated record reference"}]},"key":"ValidationError","summary":"ValidationError","id":"paths/~1office_hours_schedules~1{office_hours_schedule_id}~1office_hours_exceptions/post/responses/422/content/application~1json/examples/ValidationError"},"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/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/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~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/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{id}/get/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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/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/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{id}/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/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{id}/put/responses/404/content/application~1json/examples/IntegrationNotFound"},"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/ValidationError":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Invalid or duplicated record reference"}]},"key":"ValidationError","summary":"ValidationError","id":"paths/~1office_hours_schedules~1{id}/put/responses/422/content/application~1json/examples/ValidationError"},"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/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/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/ObjectNotFound"},"paths/~1office_hours_schedules~1{id}/delete/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/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/CustomObjectNotFound"},"paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Integration not found"}]},"key":"IntegrationNotFound","summary":"IntegrationNotFound","id":"paths/~1office_hours_schedules~1{id}/delete/responses/404/content/application~1json/examples/IntegrationNotFound"},"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/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/ValidationError":{"value":{"type":"error.list","request_id":"12a938a3-314e-4939-b773-5cd45738bd21","errors":[{"code":"data_invalid","message":"Invalid or duplicated record reference"}]},"key":"ValidationError","summary":"ValidationError","id":"paths/~1office_hours_schedules/post/responses/422/content/application~1json/examples/ValidationError"},"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/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 complete status":{"value":{"job_identifier":"job1","status":"complete","download_url":"","download_expires_at":""},"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/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/~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/~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~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/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/~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/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/422/content/application~1json/examples/unprocessable entity":{"value":{"error_key":"some_error"},"key":"unprocessable entity","summary":"unprocessable entity","id":"paths/~1phone_call_redirects/post/responses/422/content/application~1json/examples/unprocessable entity"},"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/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/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/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/company_not_found":{"value":{"name":"test","companies":[{"company_id":"123"}]},"key":"company_not_found","summary":"Company not found","id":"paths/~1tags/post/requestBody/content/application~1json/examples/company_not_found"},"paths/~1tags/post/requestBody/content/application~1json/examples/user_not_found":{"value":{"name":"test","users":[{"id":"123"}]},"key":"user_not_found","summary":"User  not found","id":"paths/~1tags/post/requestBody/content/application~1json/examples/user_not_found"},"paths/~1tags/post/responses/200/content/application~1json/examples/Action successful":{"value":{"type":"tag","id":"105","name":"test","users":[],"companies":[{"id":"valid-123","tagged":true}]},"key":"Action successful","summary":"Action successful","id":"paths/~1tags/post/responses/200/content/application~1json/examples/Action successful"},"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~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/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/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":[],"assignment_limit":10,"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/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/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}/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/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 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/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},"key":"Successful response","summary":"Successful response","id":"paths/~1tickets/post/responses/200/content/application~1json/examples/Successful response"},"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~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":"Missing required ticket attributes"}]},"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~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/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":"assignee_not_found","message":"Assignee 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}/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},"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}/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":"ticket_not_found","message":"Ticket 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}~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":"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,"ticket_state_internal_label":"Submitted","ticket_state_external_label":"Submitted"},"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/~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/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/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/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","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,"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/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/~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/403/content/application~1json/examples/Feature not available":{"value":{"type":"error.list","request_id":"d92f7e84-5c31-4a2b-b8e6-9f4c3d2a1b0e","errors":[{"code":"api_plan_restricted","message":"Workflow export is not available for this app"}]},"key":"Feature not available","summary":"Feature not available","id":"paths/~1export~1workflows~1{id}/get/responses/403/content/application~1json/examples/Feature not available"},"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"}]},"key":"Workflow not found","summary":"Workflow not found","id":"paths/~1export~1workflows~1{id}/get/responses/404/content/application~1json/examples/Workflow not found"}},"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.16/rest-api/api.intercom.io.json?download"},{"url":"/_bundle/docs/references/@2.16/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":{}}