{"items":[{"type":"link","label":"Intercom API","link":"/docs/references/2.9/rest-api/api.intercom.io","routeSlug":"/docs/references/2.9/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.9/rest-api/api.intercom.io.json?download"},{"kind":"download","label":"api.intercom.io.yaml","url":"/_bundle/docs/references/@2.9/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.9)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The intercom API reference."}],"sectionId":"/docs/references/2.9/rest-api/api.intercom.io"}],"sectionId":"/docs/references/2.9/rest-api/api.intercom.io"}]}]}},{"type":"group","label":"Admins","link":"/docs/references/2.9/rest-api/api.intercom.io/admins","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/admins","items":[{"label":"Identify an admin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/admins/identifyadmin","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/admins/setawayadmin","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a given admin","required":true}],"pointer":"/paths/~1admins~1{id}~1away/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1admins~1{id}~1away/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/unauthorized"]}},"schemaId":"schema_714","exampleIds":["paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/unauthorized"],"pointer":"/paths/~1admins~1{id}~1away/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/admins/{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":"id","in":"path","required":true,"schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/unauthorized"]}},"responseCodes":["200","401","404"],"pointer":"/admins/{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_714","exampleIds":["paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/successful_response","paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1admins~1{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{id}~1away/put/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{id}~1away/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/~1admins~1{id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{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{id}~1away/put/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{id}~1away/put/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1admins~1{id}~1away/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{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{id}~1away/put/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{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{id}~1away/put/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/setawayadmin"}],"panels":[]}]},"httpPath":"/admins/{id}/away"},{"label":"List all activity logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/admins/listactivitylogs","routeSlug":"/docs/references/2.9/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_715","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_715","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_712"}],"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_715"},{"name":"created_at_before","in":"query","required":false,"example":"1677861493","schemaId":"schema_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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":"List all admins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/admins/listadmins","routeSlug":"/docs/references/2.9/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_716","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_712"}],"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_716"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/admins/retrieveadmin","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a given admin","required":true,"example":123}],"pointer":"/paths/~1admins~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1admins~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admins/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/admins/{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{id}/get/responses/200/content/application~1json/examples/Admin found"]}},"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{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{id}/get/responses/404/content/application~1json/examples/Admin not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{id}/get/responses/404/content/application~1json/examples/Admin not found"]}],"pointer":"/paths/~1admins~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{id}/get/responses/200/content/application~1json/examples/Admin found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/admin","exampleIds":["paths/~1admins~1{id}/get/responses/200/content/application~1json/examples/Admin found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1admins~1{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{id}/get/responses/404/content/application~1json/examples/Admin not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admins/retrieveadmin"}],"panels":[]}]},"httpPath":"/admins/{id}"},{"type":"link","label":"Admin","link":"/docs/references/2.9/rest-api/api.intercom.io/admins/admin","routeSlug":"/docs/references/2.9/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":"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/{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","summary":"List all admins","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/listadmins","deprecated":false},{"title":"/admins/{id}","summary":"Retrieve an admin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admins/retrieveadmin","deprecated":false}]}]}]}]}},{"type":"group","label":"Articles","link":"/docs/references/2.9/rest-api/api.intercom.io/articles","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/articles","items":[{"label":"List all articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/articles/listarticles","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/articles/createarticle","routeSlug":"/docs/references/2.9/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":[]}]}]}]},{"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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/articles/retrievearticle","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1articles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/articles/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/articles/{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{id}/get/responses/200/content/application~1json/examples/Article found"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{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{id}/get/responses/404/content/application~1json/examples/Article not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/get/responses/404/content/application~1json/examples/Article not found"]}],"pointer":"/paths/~1articles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}/get/responses/200/content/application~1json/examples/Article found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}/get/responses/200/content/application~1json/examples/Article found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{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{id}/get/responses/404/content/application~1json/examples/Article not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/retrievearticle"}],"panels":[]}]},"httpPath":"/articles/{id}"},{"label":"Update an article","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/articles/updatearticle","routeSlug":"/docs/references/2.9/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{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":[]}]}]}]},{"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_713","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1articles~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{id}/put/requestBody/content/application~1json/examples/article_not_found"]}},"schemaId":"components/schemas/update_article_request","exampleIds":["paths/~1articles~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{id}/put/requestBody/content/application~1json/examples/article_not_found"],"pointer":"/paths/~1articles~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/articles/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{id}/put/requestBody/content/application~1json/examples/article_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/articles/{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1articles~1{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{id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{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{id}/put/responses/404/content/application~1json/examples/Article Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/put/responses/404/content/application~1json/examples/Article Not Found"]}],"pointer":"/paths/~1articles~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/article","exampleIds":["paths/~1articles~1{id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{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{id}/put/responses/404/content/application~1json/examples/Article Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/updatearticle"}],"panels":[]}]},"httpPath":"/articles/{id}"},{"label":"Delete an article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/articles/deletearticle","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the article which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1articles~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1articles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/articles/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/articles/{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_article_object","exampleIds":["paths/~1articles~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{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{id}/delete/responses/404/content/application~1json/examples/Article Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/delete/responses/404/content/application~1json/examples/Article Not Found"]}],"pointer":"/paths/~1articles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_article_object","exampleIds":["paths/~1articles~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1articles~1{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{id}/delete/responses/404/content/application~1json/examples/Article Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/deletearticle"}],"panels":[]}]},"httpPath":"/articles/{id}"},{"type":"link","label":"Article","link":"/docs/references/2.9/rest-api/api.intercom.io/articles/article","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/articles/article_list_item","routeSlug":"/docs/references/2.9/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":[]}]}]}}],"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}]},{"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/{id}","summary":"Retrieve an article","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/retrievearticle","deprecated":false},{"title":"/articles/{id}","summary":"Update an article","prefix":{"name":"put","color":"put"},"badges":[],"link":"/articles/updatearticle","deprecated":false},{"title":"/articles/{id}","summary":"Delete an article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/articles/deletearticle","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/docs/references/2.9/rest-api/api.intercom.io/companies","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/companies/createorupdatecompany","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/companies/retrievecompany","routeSlug":"/docs/references/2.9/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_715","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_715","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_715","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_715","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_713","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_713","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_712"}],"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_715"},{"name":"company_id","in":"query","required":false,"example":"12345","schemaId":"schema_715"},{"name":"tag_id","in":"query","required":false,"example":"678910","schemaId":"schema_715"},{"name":"segment_id","in":"query","required":false,"example":"98765","schemaId":"schema_715"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_713"},{"name":"per_page","in":"query","required":false,"example":15,"schemaId":"schema_713"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/companies/retrieveacompanybyid","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1companies~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{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":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{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{id}/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~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/~1companies~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{id}/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{id}/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/retrieveacompanybyid"}],"panels":[]}]},"httpPath":"/companies/{id}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/updatecompany","routeSlug":"/docs/references/2.9/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{id}/put","hasSamples":false},"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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1companies~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{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":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{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"}],"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{id}/put/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}/put/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/put/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{id}/put/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1companies~1{id}/put/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}/put/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/updatecompany"}],"panels":[]}]},"httpPath":"/companies/{id}"},{"label":"Delete a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/deletecompany","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1companies~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{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":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/deleted_company_object","exampleIds":["paths/~1companies~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}/delete/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_company_object","exampleIds":["paths/~1companies~1{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}/delete/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/deletecompany"}],"panels":[]}]},"httpPath":"/companies/{id}"},{"label":"List attached contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/listattachedcontacts","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{id}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1companies~1{id}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{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":"id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{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{id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{id}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listattachedcontacts"}],"panels":[]}]},"httpPath":"/companies/{id}/contacts"},{"label":"List attached segments for companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/listattachedsegmentsforcompanies","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{id}~1segments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1companies~1{id}~1segments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{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":"id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{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{id}~1segments/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_attached_segments","exampleIds":["paths/~1companies~1{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{id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{id}~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_attached_segments","exampleIds":["paths/~1companies~1{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{id}~1segments/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listattachedsegmentsforcompanies"}],"panels":[]}]},"httpPath":"/companies/{id}/segments"},{"label":"List all companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/listallcompanies","routeSlug":"/docs/references/2.9/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_713","description":"The page of results to fetch. Defaults to first page","example":1},{"name":"per_page","in":"query","schemaId":"schema_713","description":"How many results to return per page. Defaults to 15","example":15},{"name":"order","in":"query","schemaId":"schema_715","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_712"}],"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_713"},{"name":"per_page","in":"query","required":false,"example":15,"schemaId":"schema_713"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/companies/scrolloverallcompanies","routeSlug":"/docs/references/2.9/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_715","description":""}],"pointer":"/paths/~1companies~1scroll/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"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_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/companies/attachcontacttoacompany","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the contact which is given by Intercom","required":true}],"pointer":"/paths/~1contacts~1{id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"pointer":"/paths/~1contacts~1{id}~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{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":"id","in":"path","required":true,"schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/contacts/{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_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{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{id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{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{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{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{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1contacts~1{id}~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{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{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/attachcontacttoacompany"}],"panels":[]}]},"httpPath":"/contacts/{id}/companies"},{"label":"List attached companies for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/listcompaniesforacontact","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{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":"id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{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{id}~1companies/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/listcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{id}/companies"},{"label":"Detach a contact from a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/detachcontactfromacompany","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"},{"name":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/companies/{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_715"},{"name":"id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/companies/{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{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/{id}"},{"type":"link","label":"Company","link":"/docs/references/2.9/rest-api/api.intercom.io/companies/company","routeSlug":"/docs/references/2.9/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/{id}","summary":"Retrieve a company by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/retrieveacompanybyid","deprecated":false},{"title":"/companies/{id}","summary":"Update a company","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/updatecompany","deprecated":false},{"title":"/companies/{id}","summary":"Delete a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/companies/deletecompany","deprecated":false},{"title":"/companies/{id}/contacts","summary":"List attached contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listattachedcontacts","deprecated":false},{"title":"/companies/{id}/segments","summary":"List attached segments for companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listattachedsegmentsforcompanies","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/{id}/companies","summary":"Attach a Contact to a Company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/attachcontacttoacompany","deprecated":false},{"title":"/contacts/{id}/companies","summary":"List attached companies for contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/companies/{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/2.9/rest-api/api.intercom.io/contacts","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/contacts","items":[{"label":"List attached contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/listattachedcontacts","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"}],"pointer":"/paths/~1companies~1{id}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1companies~1{id}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{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":"id","in":"path","required":true,"example":"5f4d3c1c-7b1b-4d7d-a97e-6095715c6632","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/companies/{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{id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1companies~1{id}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_attached_contacts","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1companies~1{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{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listattachedcontacts"}],"panels":[]}]},"httpPath":"/companies/{id}/contacts"},{"label":"Attach a Contact to a Company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/attachcontacttoacompany","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the contact which is given by Intercom","required":true}],"pointer":"/paths/~1contacts~1{id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"pointer":"/paths/~1contacts~1{id}~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{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":"id","in":"path","required":true,"schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"]}},"responseCodes":["200","400","401","404"],"pointer":"/contacts/{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_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_717","exampleIds":["paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful","paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request","paths/~1contacts~1{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{id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{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{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{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{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}],"pointer":"/paths/~1contacts~1{id}~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{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{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request","paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/attachcontacttoacompany"}],"panels":[]}]},"httpPath":"/contacts/{id}/companies"},{"label":"List attached companies for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/listcompaniesforacontact","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{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":"id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{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{id}~1companies/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_attached_companies","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcompaniesforacontact"}],"panels":[]}]},"httpPath":"/contacts/{id}/companies"},{"label":"Detach a contact from a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/detachcontactfromacompany","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"},{"name":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the company which is given by Intercom","required":true,"example":"58a430d35458202d41b1e65b"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/companies/{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_715"},{"name":"id","in":"path","required":true,"example":"58a430d35458202d41b1e65b","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/companies/{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Contact Not Found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{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{id}/delete/responses/404/content/application~1json/examples/Company Not Found","paths/~1contacts~1{contact_id}~1companies~1{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/{id}"},{"label":"List all notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/listnotes","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a contact.","required":true}],"pointer":"/paths/~1contacts~1{id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{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":"id","in":"path","required":true,"schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/contacts/{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{id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{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{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{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{id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listnotes"}],"panels":[]}]},"httpPath":"/contacts/{id}/notes"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/createnote","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a given contact.","required":true,"example":"123"}],"pointer":"/paths/~1contacts~1{id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"pointer":"/paths/~1contacts~1{id}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{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":"id","in":"path","required":true,"example":"123","schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"responseCodes":["200","404"],"pointer":"/contacts/{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_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{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{id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{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{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{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{id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{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{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/createnote"}],"panels":[]}]},"httpPath":"/contacts/{id}/notes"},{"label":"List attached segments for contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/listsegmentsforacontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/contacts/listsubscriptionsforacontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/contacts/attachsubscriptiontypetocontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_719","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_719","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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_719","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_719","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_719","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/2.9/rest-api/api.intercom.io/contacts/detachsubscriptiontypetocontact","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"id","in":"path","schemaId":"schema_715","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{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/subscriptions/{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_715"},{"name":"id","in":"path","required":true,"example":"37846","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions/{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{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{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{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/{id}"},{"label":"List tags attached to a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/listtagsforacontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/contacts/attachtagtocontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_720","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_720","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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_720","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_720","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_720","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/2.9/rest-api/api.intercom.io/contacts/detachtagfromcontact","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the tag which is given by Intercom","required":true,"example":"7522907"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_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":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_715"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags/{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_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/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{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/{id}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/updatecontact","routeSlug":"/docs/references/2.9/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{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":"You can update an existing contact (ie. user or lead)."},{"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_715","description":"id","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721","exampleIds":["paths/~1contacts~1{id}/put/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_721","exampleIds":["paths/~1contacts~1{id}/put/requestBody/content/application~1json/examples/successful"],"pointer":"/paths/~1contacts~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{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":"63a07ddf05a32042dffac965","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_721","exampleIds":["paths/~1contacts~1{id}/put/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","401"],"pointer":"/contacts/{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_721","exampleIds":["paths/~1contacts~1{id}/put/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721","exampleIds":["paths/~1contacts~1{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/contact","exampleIds":["paths/~1contacts~1{id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1{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/~1contacts~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1{id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1{id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/updatecontact"}],"panels":[]}]},"httpPath":"/contacts/{id}"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/showcontact","routeSlug":"/docs/references/2.9/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{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":"warning","name":"Merged contacts"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a contact has been merged into another contact via the Merge endpoint (POST /contacts/merge), requesting it 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. Use the merged-into contact's ID instead."},"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_715","description":"id","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{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":"63a07ddf05a32042dffac965","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/contacts/{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":"components/schemas/contact","exampleIds":["paths/~1contacts~1{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1{id}/get/responses/200/content/application~1json/examples/successful"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/showcontact"}],"panels":[]}]},"httpPath":"/contacts/{id}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/deletecontact","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"id","required":true}],"pointer":"/paths/~1contacts~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/contacts/{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","exampleIds":["paths/~1contacts~1{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_deleted","exampleIds":["paths/~1contacts~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1contacts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_deleted","exampleIds":["paths/~1contacts~1{id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_deleted","exampleIds":["paths/~1contacts~1{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/deletecontact"}],"panels":[]}]},"httpPath":"/contacts/{id}"},{"label":"Merge a lead and a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/mergecontact","routeSlug":"/docs/references/2.9/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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"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"]}},"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful"],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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"]}},"responseCodes":["200","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"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/merge_contacts_request","exampleIds":["paths/~1contacts~1merge/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/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1merge/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~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":"components/schemas/contact","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact","exampleIds":["paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"]}}},{"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/2.9/rest-api/api.intercom.io/contacts/searchcontacts","routeSlug":"/docs/references/2.9/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":"Integer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email_domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signed_up_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_seen_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_contacted_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_replied_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_email_opened_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_email_clicked_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date (Unix timestamp in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language_override"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"browser"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"browser_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 in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_app_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_device"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ios_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 in seconds)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_app_version"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_device"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"android_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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"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/search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"]}},"responseCodes":["200","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/search_request","exampleIds":["paths/~1contacts~1search/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/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":"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":"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/2.9/rest-api/api.intercom.io/contacts/listcontacts","routeSlug":"/docs/references/2.9/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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/contacts/createcontact","routeSlug":"/docs/references/2.9/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_712"}],"pointer":"/paths/~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_722","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"]}},"schemaId":"schema_722","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.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_722","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_722","exampleIds":["paths/~1contacts/post/requestBody/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_722","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":"components/schemas/contact","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact","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":"components/schemas/contact","exampleIds":["paths/~1contacts/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact","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":"Archive contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/archivecontact","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"id","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1archive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{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":"id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/contacts/{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","exampleIds":["paths/~1contacts~1{id}~1archive/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_archived","exampleIds":["paths/~1contacts~1{id}~1archive/post/responses/200/content/application~1json/examples/successful"]}],"pointer":"/paths/~1contacts~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_archived","exampleIds":["paths/~1contacts~1{id}~1archive/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_archived","exampleIds":["paths/~1contacts~1{id}~1archive/post/responses/200/content/application~1json/examples/successful"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/archivecontact"}],"panels":[]}]},"httpPath":"/contacts/{id}/archive"},{"label":"Unarchive contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/unarchivecontact","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"id","required":true,"example":"63a07ddf05a32042dffac965"}],"pointer":"/paths/~1contacts~1{id}~1unarchive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1unarchive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{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":"id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/contacts/{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","exampleIds":["paths/~1contacts~1{id}~1unarchive/post/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/contact_unarchived","exampleIds":["paths/~1contacts~1{id}~1unarchive/post/responses/200/content/application~1json/examples/successful"]}],"pointer":"/paths/~1contacts~1{id}~1unarchive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/contact_unarchived","exampleIds":["paths/~1contacts~1{id}~1unarchive/post/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/contact_unarchived","exampleIds":["paths/~1contacts~1{id}~1unarchive/post/responses/200/content/application~1json/examples/successful"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/unarchivecontact"}],"panels":[]}]},"httpPath":"/contacts/{id}/unarchive"},{"type":"link","label":"Contact","link":"/docs/references/2.9/rest-api/api.intercom.io/contacts/contact","routeSlug":"/docs/references/2.9/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/{id}/contacts","summary":"List attached contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listattachedcontacts","deprecated":false},{"title":"/contacts/{id}/companies","summary":"Attach a Contact to a Company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/attachcontacttoacompany","deprecated":false},{"title":"/contacts/{id}/companies","summary":"List attached companies for contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcompaniesforacontact","deprecated":false},{"title":"/contacts/{contact_id}/companies/{id}","summary":"Detach a contact from a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/detachcontactfromacompany","deprecated":false},{"title":"/contacts/{id}/notes","summary":"List all notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listnotes","deprecated":false},{"title":"/contacts/{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/{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/{id}","summary":"Remove tag from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/detachtagfromcontact","deprecated":false},{"title":"/contacts/{id}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/updatecontact","deprecated":false},{"title":"/contacts/{id}","summary":"Get a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/showcontact","deprecated":false},{"title":"/contacts/{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/{id}/archive","summary":"Archive contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/archivecontact","deprecated":false},{"title":"/contacts/{id}/unarchive","summary":"Unarchive contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/unarchivecontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Conversations","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/conversations/attachtagtoconversation","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_723","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_723","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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_723","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_723","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_723","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/2.9/rest-api/api.intercom.io/conversations/detachtagfromconversation","routeSlug":"/docs/references/2.9/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{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_715","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":"id","in":"path","schemaId":"schema_715","description":"id","required":true,"example":"7522907"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/{conversation_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":"conversation_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_715"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/{conversation_id}/tags/{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_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_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/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{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/{id}"},{"label":"List all conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/listconversations","routeSlug":"/docs/references/2.9/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_725","description":"How many results per page"},{"name":"starting_after","in":"query","schemaId":"schema_715","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_712"}],"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_725"},{"name":"starting_after","in":"query","required":false,"schemaId":"schema_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/conversations/createconversation","routeSlug":"/docs/references/2.9/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)."}},"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":"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_712"}],"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.9","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":"components/schemas/message","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"]}},"schemaId":"components/schemas/message","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":"components/schemas/message","exampleIds":["paths/~1conversations/post/responses/200/content/application~1json/examples/conversation created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","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/2.9/rest-api/api.intercom.io/conversations/retrieveconversation","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The id of the conversation to target","required":true,"example":123}],"pointer":"/paths/~1conversations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"display_as","in":"query","schemaId":"schema_715","description":"Set to plaintext to retrieve conversation messages in plain text.","example":"plaintext"}],"pointer":"/paths/~1conversations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/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":"id","in":"path","required":true,"example":123,"schemaId":"schema_713"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/conversations/{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{id}/get/responses/200/content/application~1json/examples/conversation found"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}/get/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/get/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}/get/responses/200/content/application~1json/examples/conversation found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}/get/responses/200/content/application~1json/examples/conversation found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}/get/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/get/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/retrieveconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}"},{"label":"Update a conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/updateconversation","routeSlug":"/docs/references/2.9/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{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":"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":"id","in":"path","schemaId":"schema_713","description":"The id of the conversation to target","required":true,"example":123}],"pointer":"/paths/~1conversations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"display_as","in":"query","schemaId":"schema_715","description":"Set to plaintext to retrieve conversation messages in plain text.","example":"plaintext"}],"pointer":"/paths/~1conversations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{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{id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/update_conversation_request","exampleIds":["paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/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":"id","in":"path","required":true,"example":123,"schemaId":"schema_713"}],"query":[{"name":"display_as","in":"query","required":false,"example":"plaintext","schemaId":"schema_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","401","403","404"],"pointer":"/conversations/{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{id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{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{id}/put/requestBody/content/application~1json/examples/conversation_found","paths/~1conversations~1{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":"conversation found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}/put/responses/200/content/application~1json/examples/conversation found"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}/put/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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}/put/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/put/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}/put/responses/200/content/application~1json/examples/conversation found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}/put/responses/200/content/application~1json/examples/conversation found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}/put/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}/put/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/updateconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}"},{"label":"Search conversations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/searchconversations","routeSlug":"/docs/references/2.9/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 is 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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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 in seconds)"},"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_712"}],"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":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/conversations/replyconversation","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","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{id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{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{id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{id}~1reply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{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":"id","in":"path","required":true,"example":"123 or \"last\"","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","401","403","404"],"pointer":"/conversations/{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{id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reply_conversation_request","exampleIds":["paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply","paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply","paths/~1conversations~1{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":"User last conversation reply","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1conversations~1{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{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{id}~1reply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1conversations~1{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{id}~1reply/post/responses/200/content/application~1json/examples/User reply","paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply","paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1reply/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/replyconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}/reply"},{"label":"Manage a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/manageconversation","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1parts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{id}~1parts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_726","exampleIds":["paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"schema_726","exampleIds":["paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{id}~1parts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{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":"id","in":"path","required":true,"example":"123","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_726","exampleIds":["paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","401","403","404"],"pointer":"/conversations/{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_726","exampleIds":["paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_726","exampleIds":["paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation","paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation","paths/~1conversations~1{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{id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{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{id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1parts/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1parts/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{id}~1parts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{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{id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation","paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1parts/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/manageconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}/parts"},{"label":"Run Assignment Rules on a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/autoassignconversation","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/conversations/autoassignconversation","metadata":{"seo":{"title":"Run Assignment Rules on a conversation","description":"Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"autoAssignConversation","name":"Run Assignment Rules on a conversation","isWebhook":false,"pointer":"/paths/~1conversations~1{id}~1run_assignment_rules/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run Assignment Rules on 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":"danger","name":"Deprecation of Run Assignment Rules"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can let a conversation be automatically assigned following assignment rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"When using workflows"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not possible to use this endpoint with Workflows."},"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_715","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1run_assignment_rules/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{id}~1run_assignment_rules/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{id}/run_assignment_rules","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/conversations/{id}/run_assignment_rules","href":"conversations/autoassignconversation","openApiOperationId":"autoAssignConversation","summary":"Run Assignment Rules on 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":"Assign a conversation using assignment rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/200/content/application~1json/examples/Assign a conversation using assignment rules"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/200/content/application~1json/examples/Assign a conversation using assignment rules"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/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{id}~1run_assignment_rules/post/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/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{id}~1run_assignment_rules/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{id}~1run_assignment_rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/200/content/application~1json/examples/Assign a conversation using assignment rules"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/200/content/application~1json/examples/Assign a conversation using assignment rules"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/403/content/application~1json/examples/API plan restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1run_assignment_rules/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/autoassignconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}/run_assignment_rules"},{"label":"Attach a contact to a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/attachcontacttoconversation","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1conversations~1{id}~1customers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{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{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/not_found"]}},"schemaId":"components/schemas/attach_contact_to_conversation_request","exampleIds":["paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/not_found"],"pointer":"/paths/~1conversations~1{id}~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conversations/{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":"id","in":"path","required":true,"example":"123","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/not_found"]}},"responseCodes":["200","401","403","404"],"pointer":"/conversations/{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{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{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{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation","paths/~1conversations~1{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{id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"]}},"schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{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{id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1customers/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1customers/post/responses/404/content/application~1json/examples/Not found"]}],"pointer":"/paths/~1conversations~1{id}~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/conversation","exampleIds":["paths/~1conversations~1{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{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{id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{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{id}~1customers/post/responses/404/content/application~1json/examples/Not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/attachcontacttoconversation"}],"panels":[]}]},"httpPath":"/conversations/{id}/customers"},{"label":"Detach a contact from a group conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/detachcontactfromconversation","routeSlug":"/docs/references/2.9/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_715","description":"The identifier for the conversation as given by Intercom.","required":true,"example":"123"},{"name":"contact_id","in":"path","schemaId":"schema_715","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_712"}],"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_715"},{"name":"contact_id","in":"path","required":true,"example":"123","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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":"Redact a conversation part","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/redactconversation","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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"},{"type":"link","label":"Conversation","link":"/docs/references/2.9/rest-api/api.intercom.io/conversations/conversation","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/conversations/conversation_list_item","routeSlug":"/docs/references/2.9/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":[]}]}]}}],"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}]},{"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/{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/{id}","summary":"Retrieve a conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/retrieveconversation","deprecated":false},{"title":"/conversations/{id}","summary":"Update a conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/updateconversation","deprecated":false},{"title":"/conversations/search","summary":"Search conversations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/searchconversations","deprecated":false},{"title":"/conversations/{id}/reply","summary":"Reply to a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/replyconversation","deprecated":false},{"title":"/conversations/{id}/parts","summary":"Manage a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/manageconversation","deprecated":false},{"title":"/conversations/{id}/run_assignment_rules","summary":"Run Assignment Rules on a conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/autoassignconversation","deprecated":false},{"title":"/conversations/{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/redact","summary":"Redact a conversation part","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/redactconversation","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Attributes","link":"/docs/references/2.9/rest-api/api.intercom.io/data-attributes","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/data-attributes/lisdataattributes","routeSlug":"/docs/references/2.9/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, companies or conversations."}},"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":"You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations."},{"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_727","description":"Specify the data attribute model to return.","example":"company"},{"name":"include_archived","in":"query","schemaId":"schema_716","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_712"}],"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_727"},{"name":"include_archived","in":"query","required":false,"example":false,"schemaId":"schema_716"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"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"]}],"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"]}}}],"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/2.9/rest-api/api.intercom.io/data-attributes/createdataattribute","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/data-attributes/updatedataattribute","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The data attribute id","required":true,"example":1}],"pointer":"/paths/~1data_attributes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1data_attributes~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/has_dependant_object"]}},"schemaId":"components/schemas/update_data_attribute_request","exampleIds":["paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/has_dependant_object"],"pointer":"/paths/~1data_attributes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/data_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":1,"schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/has_dependant_object"]}},"responseCodes":["200","400","401","404","422"],"pointer":"/data_attributes/{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/too_few_options_in_list","paths/~1data_attributes~1{id}/put/requestBody/content/application~1json/examples/attribute_not_found","paths/~1data_attributes~1{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{id}/put/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/400/content/application~1json/examples/Too few options in list"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/404/content/application~1json/examples/Attribute Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/422/content/application~1json/examples/Has Dependant Object"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{id}/put/responses/422/content/application~1json/examples/Has Dependant Object"]}],"pointer":"/paths/~1data_attributes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data_attribute","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/200/content/application~1json/examples/Successful"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/400/content/application~1json/examples/Too few options in list"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{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{id}/put/responses/404/content/application~1json/examples/Attribute Not Found"]}}},{"code":"422","schemaId":"components/schemas/error","exampleIds":["paths/~1data_attributes~1{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{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/{id}"},{"type":"link","label":"Data Attribute","link":"/docs/references/2.9/rest-api/api.intercom.io/data-attributes/data_attribute","routeSlug":"/docs/references/2.9/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/{id}","summary":"Update a data attribute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-attributes/updatedataattribute","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Events","link":"/docs/references/2.9/rest-api/api.intercom.io/data-events","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/data-events/createdataevent","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/data-events/lisdataevents","routeSlug":"/docs/references/2.9/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_728","required":true},{"name":"type","in":"query","schemaId":"schema_715","description":"The value must be user","required":true},{"name":"summary","in":"query","schemaId":"schema_716","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_712"}],"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_728","style":"form","explode":true},{"name":"type","in":"query","required":true,"schemaId":"schema_715"},{"name":"summary","in":"query","required":false,"schemaId":"schema_716"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/data-events/dataeventsummaries","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/data-events/data_event","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/data-export","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/data-export/createdataexport","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/data-export/getdataexport","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/data-export/canceldataexport","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/data-export/downloaddataexport","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/data-export/data_export","routeSlug":"/docs/references/2.9/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":"Help Center","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center","items":[{"label":"List all collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/listallcollections","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/help-center/createcollection","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/help-center/retrievecollection","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1collections~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1collections~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/collections/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/collections/{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{id}/get/responses/200/content/application~1json/examples/Collection found"]}},"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{id}/get/responses/404/content/application~1json/examples/Collection not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{id}/get/responses/404/content/application~1json/examples/Collection not found"]}],"pointer":"/paths/~1help_center~1collections~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{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{id}/get/responses/200/content/application~1json/examples/Collection found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{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/{id}"},{"label":"Update a collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/updatecollection","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1collections~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1collections~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{id}/put/requestBody/content/application~1json/examples/collection_not_found"]}},"schemaId":"components/schemas/update_collection_request","exampleIds":["paths/~1help_center~1collections~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{id}/put/requestBody/content/application~1json/examples/collection_not_found"],"pointer":"/paths/~1help_center~1collections~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/help_center/collections/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{id}/put/requestBody/content/application~1json/examples/collection_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/help_center/collections/{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1collections~1{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{id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{id}/put/responses/404/content/application~1json/examples/Collection Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{id}/put/responses/404/content/application~1json/examples/Collection Not Found"]}],"pointer":"/paths/~1help_center~1collections~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection","exampleIds":["paths/~1help_center~1collections~1{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{id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{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/{id}"},{"label":"Delete a collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/deletecollection","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1collections~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1collections~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/help_center/collections/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/collections/{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_collection_object","exampleIds":["paths/~1help_center~1collections~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{id}/delete/responses/404/content/application~1json/examples/collection Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{id}/delete/responses/404/content/application~1json/examples/collection Not Found"]}],"pointer":"/paths/~1help_center~1collections~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_collection_object","exampleIds":["paths/~1help_center~1collections~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1collections~1{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{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/{id}"},{"label":"Retrieve a Help Center","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/retrievehelpcenter","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the collection which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1help_centers~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1help_centers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/help_centers/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/help_centers/{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{id}/get/responses/200/content/application~1json/examples/Collection found"]}},"schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{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{id}/get/responses/404/content/application~1json/examples/Collection not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{id}/get/responses/404/content/application~1json/examples/Collection not found"]}],"pointer":"/paths/~1help_center~1help_centers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/help_center","exampleIds":["paths/~1help_center~1help_centers~1{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{id}/get/responses/200/content/application~1json/examples/Collection found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1help_centers~1{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{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/{id}"},{"label":"List all Help Centers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/listhelpcenters","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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"},{"label":"List all sections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/listallsections","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center/listallsections","metadata":{"seo":{"title":"List all sections","description":"You can fetch a list of all sections by making a GET request to https://api.intercom.io/help_center/sections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllSections","name":"List all sections","isWebhook":false,"pointer":"/paths/~1help_center~1sections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all sections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 sections by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/sections"},"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 sections sorted and ordered?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sections 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 sections 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_712"}],"pointer":"/paths/~1help_center~1sections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/sections","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"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.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/help_center/sections","href":"help-center/listallsections","openApiOperationId":"listAllSections","summary":"List all sections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API 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/section_list","exampleIds":["paths/~1help_center~1sections/get/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/section_list","exampleIds":["paths/~1help_center~1sections/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~1sections/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1help_center~1sections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/section_list","exampleIds":["paths/~1help_center~1sections/get/responses/200/content/application~1json/examples/Successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/section_list","exampleIds":["paths/~1help_center~1sections/get/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/listallsections"}],"panels":[]}]},"httpPath":"/help_center/sections"},{"label":"Create a section","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/createsection","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center/createsection","metadata":{"seo":{"title":"Create a section","description":"You can create a new section by making a POST request to https://api.intercom.io/help_center/sections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSection","name":"Create a section","isWebhook":false,"pointer":"/paths/~1help_center~1sections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 section by making a POST request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/sections."},"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_712"}],"pointer":"/paths/~1help_center~1sections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_section_request","exampleIds":["paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created"]}},"schemaId":"components/schemas/create_section_request","exampleIds":["paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created"],"pointer":"/paths/~1help_center~1sections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/help_center/sections","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"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.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_section_request","exampleIds":["paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created"]}},"responseCodes":["200","401"],"pointer":"/help_center/sections","href":"help-center/createsection","openApiOperationId":"createSection","summary":"Create a section"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production 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_section_request","exampleIds":["paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_section_request","exampleIds":["paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"section created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections/post/responses/200/content/application~1json/examples/section created"]}},"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections/post/responses/200/content/application~1json/examples/section created"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1help_center~1sections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections/post/responses/200/content/application~1json/examples/section created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections/post/responses/200/content/application~1json/examples/section created"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/createsection"}],"panels":[]}]},"httpPath":"/help_center/sections"},{"label":"Retrieve a section","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/retrievesection","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center/retrievesection","metadata":{"seo":{"title":"Retrieve a section","description":"You can fetch the details of a single section by making a GET request to https://api.intercom.io/help_center/sections/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveSection","name":"Retrieve a section","isWebhook":false,"pointer":"/paths/~1help_center~1sections~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 section by making a GET request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/help_center/sections/<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_713","description":"The unique identifier for the section which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1sections~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1sections~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/help_center/sections/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/sections/{id}","href":"help-center/retrievesection","openApiOperationId":"retrieveSection","summary":"Retrieve a section"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Section found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/200/content/application~1json/examples/Section found"]}},"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/200/content/application~1json/examples/Section found"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Section not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/404/content/application~1json/examples/Section not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/404/content/application~1json/examples/Section not found"]}],"pointer":"/paths/~1help_center~1sections~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/200/content/application~1json/examples/Section found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/200/content/application~1json/examples/Section found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/404/content/application~1json/examples/Section not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/get/responses/404/content/application~1json/examples/Section not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/retrievesection"}],"panels":[]}]},"httpPath":"/help_center/sections/{id}"},{"label":"Update a section","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/updatesection","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center/updatesection","metadata":{"seo":{"title":"Update a section","description":"You can update the details of a single section by making a PUT request to https://api.intercom.io/sections/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSection","name":"Update a section","isWebhook":false,"pointer":"/paths/~1help_center~1sections~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 section by making a PUT request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/sections/<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_713","description":"The unique identifier for the section which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1sections~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1sections~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_section_request","exampleIds":["paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_not_found"]}},"schemaId":"components/schemas/update_section_request","exampleIds":["paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_not_found"],"pointer":"/paths/~1help_center~1sections~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/help_center/sections/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_section_request","exampleIds":["paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/help_center/sections/{id}","href":"help-center/updatesection","openApiOperationId":"updateSection","summary":"Update a section"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production 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_section_request","exampleIds":["paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_section_request","exampleIds":["paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_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/section","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{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~1sections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"Section Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/404/content/application~1json/examples/Section Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/404/content/application~1json/examples/Section Not Found"]}],"pointer":"/paths/~1help_center~1sections~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/section","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/404/content/application~1json/examples/Section Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/put/responses/404/content/application~1json/examples/Section Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/updatesection"}],"panels":[]}]},"httpPath":"/help_center/sections/{id}"},{"label":"Delete a section","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/deletesection","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center/deletesection","metadata":{"seo":{"title":"Delete a section","description":"You can delete a single section by making a DELETE request to https://api.intercom.io/sections/<id>."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSection","name":"Delete a section","isWebhook":false,"pointer":"/paths/~1help_center~1sections~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 section by making a DELETE request to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.intercom.io/sections/<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_713","description":"The unique identifier for the section which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1help_center~1sections~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1help_center~1sections~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/help_center/sections/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/help_center/sections/{id}","href":"help-center/deletesection","openApiOperationId":"deleteSection","summary":"Delete a section"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API 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_section_object","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_section_object","exampleIds":["paths/~1help_center~1sections~1{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~1sections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"404","description":"section Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/404/content/application~1json/examples/section Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/404/content/application~1json/examples/section Not Found"]}],"pointer":"/paths/~1help_center~1sections~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_section_object","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deleted_section_object","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/404/content/application~1json/examples/section Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1help_center~1sections~1{id}/delete/responses/404/content/application~1json/examples/section Not Found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/help-center/deletesection"}],"panels":[]}]},"httpPath":"/help_center/sections/{id}"},{"type":"link","label":"Collection","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/collection","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/help-center/help_center","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/help-center/help_center_list","routeSlug":"/docs/references/2.9/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":"Section","link":"/docs/references/2.9/rest-api/api.intercom.io/help-center/section","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/help-center/section","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"section"},"seo":{"title":"Section"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Section","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/section"},"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":"Section","link":"/help-center/section","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"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/{id}","summary":"Retrieve a collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/retrievecollection","deprecated":false},{"title":"/help_center/collections/{id}","summary":"Update a collection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/help-center/updatecollection","deprecated":false},{"title":"/help_center/collections/{id}","summary":"Delete a collection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/help-center/deletecollection","deprecated":false},{"title":"/help_center/help_centers/{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},{"title":"/help_center/sections","summary":"List all sections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/listallsections","deprecated":false},{"title":"/help_center/sections","summary":"Create a section","prefix":{"name":"post","color":"post"},"badges":[],"link":"/help-center/createsection","deprecated":false},{"title":"/help_center/sections/{id}","summary":"Retrieve a section","prefix":{"name":"get","color":"get"},"badges":[],"link":"/help-center/retrievesection","deprecated":false},{"title":"/help_center/sections/{id}","summary":"Update a section","prefix":{"name":"put","color":"put"},"badges":[],"link":"/help-center/updatesection","deprecated":false},{"title":"/help_center/sections/{id}","summary":"Delete a section","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/help-center/deletesection","deprecated":false}]}]}]}]}},{"type":"group","label":"Messages","link":"/docs/references/2.9/rest-api/api.intercom.io/messages","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/messages","items":[{"label":"Create a message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/messages/createmessage","routeSlug":"/docs/references/2.9/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 or an email."}},"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 or an email."},"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_712"}],"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/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/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.9","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/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/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/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"},{"type":"link","label":"Message","link":"/docs/references/2.9/rest-api/api.intercom.io/messages/message","routeSlug":"/docs/references/2.9/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}]}]}]}]}},{"type":"group","label":"News","link":"/docs/references/2.9/rest-api/api.intercom.io/news","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/news/listnewsitems","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/news/createnewsitem","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/news/retrievenewsitem","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the news item which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1news~1news_items~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1news~1news_items~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/news_items/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/news/news_items/{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{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~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/~1news~1news_items~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{id}/get/responses/404/content/application~1json/examples/News Item Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{id}/get/responses/404/content/application~1json/examples/News Item Not Found"]}],"pointer":"/paths/~1news~1news_items~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{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{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{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/{id}"},{"label":"Update a news item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/news/updatenewsitem","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the news item which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1news~1news_items~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1news~1news_items~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{id}/put/requestBody/content/application~1json/examples/news_item_not_found"]}},"schemaId":"components/schemas/news_item_request","exampleIds":["paths/~1news~1news_items~1{id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{id}/put/requestBody/content/application~1json/examples/news_item_not_found"],"pointer":"/paths/~1news~1news_items~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/news/news_items/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{id}/put/requestBody/content/application~1json/examples/news_item_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/news/news_items/{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{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{id}/put/requestBody/content/application~1json/examples/successful","paths/~1news~1news_items~1{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{id}/put/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{id}/put/responses/404/content/application~1json/examples/News Item Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{id}/put/responses/404/content/application~1json/examples/News Item Not Found"]}],"pointer":"/paths/~1news~1news_items~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/news_item","exampleIds":["paths/~1news~1news_items~1{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{id}/put/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{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/{id}"},{"label":"Delete a news item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/news/deletenewsitem","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier for the news item which is given by Intercom.","required":true,"example":123}],"pointer":"/paths/~1news~1news_items~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1news~1news_items~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/news/news_items/{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_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/news/news_items/{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/deleted_object","exampleIds":["paths/~1news~1news_items~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{id}/delete/responses/404/content/application~1json/examples/News Item Not Found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{id}/delete/responses/404/content/application~1json/examples/News Item Not Found"]}],"pointer":"/paths/~1news~1news_items~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deleted_object","exampleIds":["paths/~1news~1news_items~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1news_items~1{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{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/{id}"},{"label":"List all live newsfeed items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/news/listlivenewsfeeditems","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the news feed item which is given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1news~1newsfeeds~1{id}~1items/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1news~1newsfeeds~1{id}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/newsfeeds/{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":"id","in":"path","required":true,"example":"123","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/news/newsfeeds/{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{id}~1items/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds~1{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{id}~1items/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{id}~1items/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1news~1newsfeeds~1{id}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paginated_response","exampleIds":["paths/~1news~1newsfeeds~1{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{id}~1items/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{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{id}~1items/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/listlivenewsfeeditems"}],"panels":[]}]},"httpPath":"/news/newsfeeds/{id}/items"},{"label":"List all newsfeeds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/news/listnewsfeeds","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/news/retrievenewsfeed","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the news feed item which is given by Intercom.","required":true,"example":"123"}],"pointer":"/paths/~1news~1newsfeeds~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1news~1newsfeeds~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/news/newsfeeds/{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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/news/newsfeeds/{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{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~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/~1news~1newsfeeds~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1news~1newsfeeds~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/newsfeed","exampleIds":["paths/~1news~1newsfeeds~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1news~1newsfeeds~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/news/retrievenewsfeed"}],"panels":[]}]},"httpPath":"/news/newsfeeds/{id}"},{"type":"link","label":"News Item","link":"/docs/references/2.9/rest-api/api.intercom.io/news/news_item","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/news/newsfeed","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/news/newsfeed_assignment","routeSlug":"/docs/references/2.9/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/{id}","summary":"Retrieve a news item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/retrievenewsitem","deprecated":false},{"title":"/news/news_items/{id}","summary":"Update a news item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/news/updatenewsitem","deprecated":false},{"title":"/news/news_items/{id}","summary":"Delete a news item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/news/deletenewsitem","deprecated":false},{"title":"/news/newsfeeds/{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/{id}","summary":"Retrieve a newsfeed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/news/retrievenewsfeed","deprecated":false}]}]}]}]}},{"type":"group","label":"Notes","link":"/docs/references/2.9/rest-api/api.intercom.io/notes","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/notes","items":[{"label":"List all notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/notes/listnotes","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a contact.","required":true}],"pointer":"/paths/~1contacts~1{id}~1notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{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":"id","in":"path","required":true,"schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/contacts/{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{id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{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{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note_list","exampleIds":["paths/~1contacts~1{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{id}~1notes/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{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{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/listnotes"}],"panels":[]}]},"httpPath":"/contacts/{id}/notes"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/notes/createnote","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a given contact.","required":true,"example":"123"}],"pointer":"/paths/~1contacts~1{id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{id}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"pointer":"/paths/~1contacts~1{id}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{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":"id","in":"path","required":true,"example":"123","schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"]}},"responseCodes":["200","404"],"pointer":"/contacts/{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_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718","exampleIds":["paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response","paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found","paths/~1contacts~1{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{id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{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{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}],"pointer":"/paths/~1contacts~1{id}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1contacts~1{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{id}~1notes/post/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{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{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found","paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/createnote"}],"panels":[]}]},"httpPath":"/contacts/{id}/notes"},{"label":"Retrieve a note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/notes/retrievenote","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_713","description":"The unique identifier of a given note","required":true,"example":1}],"pointer":"/paths/~1notes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1notes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notes/{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":1,"schemaId":"schema_713"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/notes/{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{id}/get/responses/200/content/application~1json/examples/Note found"]}},"schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{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{id}/get/responses/404/content/application~1json/examples/Note not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{id}/get/responses/404/content/application~1json/examples/Note not found"]}],"pointer":"/paths/~1notes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{id}/get/responses/200/content/application~1json/examples/Note found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note","exampleIds":["paths/~1notes~1{id}/get/responses/200/content/application~1json/examples/Note found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1notes~1{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{id}/get/responses/404/content/application~1json/examples/Note not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/retrievenote"}],"panels":[]}]},"httpPath":"/notes/{id}"},{"type":"link","label":"Note","link":"/docs/references/2.9/rest-api/api.intercom.io/notes/note","routeSlug":"/docs/references/2.9/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":"Note","link":"/notes/note","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts/{id}/notes","summary":"List all notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/listnotes","deprecated":false},{"title":"/contacts/{id}/notes","summary":"Create a note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/createnote","deprecated":false},{"title":"/notes/{id}","summary":"Retrieve a note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/retrievenote","deprecated":false}]}]}]}]}},{"type":"group","label":"Segments","link":"/docs/references/2.9/rest-api/api.intercom.io/segments","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/segments/listsegmentsforacontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/segments/listsegments","routeSlug":"/docs/references/2.9/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_716","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_712"}],"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_716"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/segments/retrievesegment","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identified of a given segment.","required":true,"example":"123"}],"pointer":"/paths/~1segments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1segments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/segments/{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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/segments/{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{id}/get/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~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/~1segments~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{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{id}/get/responses/404/content/application~1json/examples/Segment not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{id}/get/responses/404/content/application~1json/examples/Segment not found"]}],"pointer":"/paths/~1segments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~1{id}/get/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/segment","exampleIds":["paths/~1segments~1{id}/get/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1segments~1{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{id}/get/responses/404/content/application~1json/examples/Segment not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/retrievesegment"}],"panels":[]}]},"httpPath":"/segments/{id}"},{"type":"link","label":"Segment","link":"/docs/references/2.9/rest-api/api.intercom.io/segments/segment","routeSlug":"/docs/references/2.9/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/{id}","summary":"Retrieve a segment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/segments/retrievesegment","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription Types","link":"/docs/references/2.9/rest-api/api.intercom.io/subscription-types","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/subscription-types/listsubscriptionsforacontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/subscription-types/attachsubscriptiontypetocontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_719","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_719","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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_719","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_719","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_719","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/2.9/rest-api/api.intercom.io/subscription-types/detachsubscriptiontypetocontact","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"id","in":"path","schemaId":"schema_715","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{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_id}/subscriptions/{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_715"},{"name":"id","in":"path","required":true,"example":"37846","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/subscriptions/{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}},"schemaId":"components/schemas/subscription_type","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1subscriptions~1{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{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{id}/delete/responses/200/content/application~1json/examples/Successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{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{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1subscriptions~1{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/{id}"},{"label":"List subscription types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/subscription-types/listsubscriptiontypes","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/subscription-types/subscription_type","routeSlug":"/docs/references/2.9/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/{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/2.9/rest-api/api.intercom.io/switch","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/switch/createphoneswitch","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/tags","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/tags","items":[{"label":"List tags attached to a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tags/listtagsforacontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/tags/attachtagtocontact","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_720","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_720","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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_720","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_720","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_720","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/2.9/rest-api/api.intercom.io/tags/detachtagfromcontact","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the contact which is given by Intercom","required":true,"example":"63a07ddf05a32042dffac965"},{"name":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the tag which is given by Intercom","required":true,"example":"7522907"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{contact_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":"contact_id","in":"path","required":true,"example":"63a07ddf05a32042dffac965","schemaId":"schema_715"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/contacts/{contact_id}/tags/{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_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/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found","paths/~1contacts~1{contact_id}~1tags~1{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/{id}"},{"label":"Add tag to a conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tags/attachtagtoconversation","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_723","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_723","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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_723","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_723","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_723","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/2.9/rest-api/api.intercom.io/tags/detachtagfromconversation","routeSlug":"/docs/references/2.9/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{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_715","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":"id","in":"path","schemaId":"schema_715","description":"id","required":true,"example":"7522907"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conversations/{conversation_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":"conversation_id","in":"path","required":true,"example":"64619700005694","schemaId":"schema_715"},{"name":"id","in":"path","required":true,"example":"7522907","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/conversations/{conversation_id}/tags/{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_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found","paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_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/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found","paths/~1conversations~1{conversation_id}~1tags~1{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/{id}"},{"label":"List all tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tags/listtags","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/tags/createtag","routeSlug":"/docs/references/2.9/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_712"}],"pointer":"/paths/~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_729","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_729","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.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_729","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","404"],"pointer":"/tags","href":"tags/createtag","openApiOperationId":"createTag","summary":"Create or update a tag, Tag or untag companies, Tag contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"schemaId":"schema_729","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_729","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_basic","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful"]}},"schemaId":"components/schemas/tag_basic","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"]},{"code":"404","description":"User  not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Company not found","paths/~1tags/post/responses/404/content/application~1json/examples/User  not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Company not found","paths/~1tags/post/responses/404/content/application~1json/examples/User  not found"]}],"pointer":"/paths/~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags/post/responses/200/content/application~1json/examples/Action successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag_basic","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"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Company not found","paths/~1tags/post/responses/404/content/application~1json/examples/User  not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags/post/responses/404/content/application~1json/examples/Company not found","paths/~1tags/post/responses/404/content/application~1json/examples/User  not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/createtag"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Find a specific tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tags/findtag","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier of a given tag","required":true,"example":"123"}],"pointer":"/paths/~1tags~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1tags~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/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":"id","in":"path","required":true,"example":"123","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/tags/{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{id}/get/responses/200/content/application~1json/examples/Tag found"]}},"schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{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{id}/get/responses/404/content/application~1json/examples/Tag not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{id}/get/responses/404/content/application~1json/examples/Tag not found"]}],"pointer":"/paths/~1tags~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag_basic","exampleIds":["paths/~1tags~1{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{id}/get/responses/200/content/application~1json/examples/Tag found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{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{id}/get/responses/404/content/application~1json/examples/Tag not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/findtag"}],"panels":[]}]},"httpPath":"/tags/{id}"},{"label":"Delete tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tags/deletetag","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier of a given tag","required":true,"example":"123"}],"pointer":"/paths/~1tags~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1tags~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/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":"id","in":"path","required":true,"example":"123","schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/tags/{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{id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{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{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{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{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}],"pointer":"/paths/~1tags~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{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{id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1tags~1{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{id}/delete/responses/404/content/application~1json/examples/Resource not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetag"}],"panels":[]}]},"httpPath":"/tags/{id}"},{"type":"link","label":"Tag","link":"/docs/references/2.9/rest-api/api.intercom.io/tags/tag","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/tags/tag_basic","routeSlug":"/docs/references/2.9/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":"/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/{id}","summary":"Remove tag from a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/detachtagfromcontact","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/{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/{id}","summary":"Find a specific tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/findtag","deprecated":false},{"title":"/tags/{id}","summary":"Delete tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetag","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams","link":"/docs/references/2.9/rest-api/api.intercom.io/teams","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/teams","items":[{"label":"List all teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/teams/listteams","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/teams/retrieveteam","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier of a given team.","required":true,"example":"123"}],"pointer":"/paths/~1teams~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1teams~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/teams/{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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/teams/{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{id}/get/responses/200/content/application~1json/examples/successful"]}},"schemaId":"components/schemas/team","exampleIds":["paths/~1teams~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/~1teams~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{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{id}/get/responses/404/content/application~1json/examples/Team not found"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{id}/get/responses/404/content/application~1json/examples/Team not found"]}],"pointer":"/paths/~1teams~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","exampleIds":["paths/~1teams~1{id}/get/responses/200/content/application~1json/examples/successful"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team","exampleIds":["paths/~1teams~1{id}/get/responses/200/content/application~1json/examples/successful"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1teams~1{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{id}/get/responses/404/content/application~1json/examples/Team not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/retrieveteam"}],"panels":[]}]},"httpPath":"/teams/{id}"},{"type":"link","label":"Team","link":"/docs/references/2.9/rest-api/api.intercom.io/teams/team","routeSlug":"/docs/references/2.9/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/{id}","summary":"Retrieve a team","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/retrieveteam","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticket Type Attributes","link":"/docs/references/2.9/rest-api/api.intercom.io/ticket-type-attributes","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/ticket-type-attributes/createtickettypeattribute","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/ticket-type-attributes/updatetickettypeattribute","routeSlug":"/docs/references/2.9/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{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_715","description":"The unique identifier for the ticket type which is given by Intercom.","required":true},{"name":"id","in":"path","schemaId":"schema_715","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{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{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{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{id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ticket_types/{ticket_type_id}/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":"ticket_type_id","in":"path","required":true,"schemaId":"schema_715"},{"name":"id","in":"path","required":true,"schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"]}},"responseCodes":["200","401"],"pointer":"/ticket_types/{ticket_type_id}/attributes/{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{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{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{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{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{ticket_type_id}~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types~1{ticket_type_id}~1attributes~1{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{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{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{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{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/{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/{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/2.9/rest-api/api.intercom.io/ticket-types","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/ticket-types/listtickettypes","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/ticket-types/createtickettype","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/ticket-types/gettickettype","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the ticket type which is given by Intercom.","required":true}],"pointer":"/paths/~1ticket_types~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1ticket_types~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ticket_types/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/ticket_types/{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{id}/get/responses/200/content/application~1json/examples/Ticket type found"]}},"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{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{id}/get/responses/200/content/application~1json/examples/Ticket type found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-types/gettickettype"}],"panels":[]}]},"httpPath":"/ticket_types/{id}"},{"label":"Update a ticket type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/ticket-types/updatetickettype","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","description":"The unique identifier for the ticket type which is given by Intercom.","required":true}],"pointer":"/paths/~1ticket_types~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1ticket_types~1{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{id}/put/requestBody/content/application~1json/examples/ticket_type_updated"]}},"schemaId":"components/schemas/update_ticket_type_request","exampleIds":["paths/~1ticket_types~1{id}/put/requestBody/content/application~1json/examples/ticket_type_updated"],"pointer":"/paths/~1ticket_types~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ticket_types/{id}","servers":[{"url":"https://api.intercom.io","description":"The production API server"},{"url":"https://api.eu.intercom.io","description":"The european API server"},{"url":"https://api.au.intercom.io","description":"The australian API server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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{id}/put/requestBody/content/application~1json/examples/ticket_type_updated"]}},"responseCodes":["200","401"],"pointer":"/ticket_types/{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{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{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{id}/put/responses/200/content/application~1json/examples/Ticket type updated"]}},"schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{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{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1ticket_types~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_type","exampleIds":["paths/~1ticket_types~1{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{id}/put/responses/200/content/application~1json/examples/Ticket type updated"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1ticket_types~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-types/updatetickettype"}],"panels":[]}]},"httpPath":"/ticket_types/{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/{id}","summary":"Retrieve a ticket type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-types/gettickettype","deprecated":false},{"title":"/ticket_types/{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/2.9/rest-api/api.intercom.io/tickets","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/tickets/replyticket","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/tickets/replyticket","metadata":{"seo":{"title":"Reply to a ticket","description":"You can reply to a ticket with a note from an admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replyTicket","name":"Reply to a ticket","isWebhook":false,"pointer":"/paths/~1tickets~1{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 note from an admin."},{"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_730","required":true}],"pointer":"/paths/~1tickets~1{id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1tickets~1{id}~1reply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_reply_request","exampleIds":["paths/~1tickets~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"]}},"schemaId":"components/schemas/create_ticket_reply_request","exampleIds":["paths/~1tickets~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"],"pointer":"/paths/~1tickets~1{id}~1reply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/{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":"id","in":"path","required":true,"example":"123","schemaId":"schema_730"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_ticket_reply_request","exampleIds":["paths/~1tickets~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"]}},"responseCodes":["200","401"],"pointer":"/tickets/{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":"components/schemas/create_ticket_reply_request","exampleIds":["paths/~1tickets~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_reply_request","exampleIds":["paths/~1tickets~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Admin note reply","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_note","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"]}},"schemaId":"components/schemas/ticket_note","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1tickets~1{id}~1reply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket_note","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket_note","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/replyticket"}],"panels":[]}]},"httpPath":"/tickets/{id}/reply"},{"label":"Create a ticket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tickets/createticket","routeSlug":"/docs/references/2.9/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_712"}],"pointer":"/paths/~1tickets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_request","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"]}},"schemaId":"components/schemas/create_ticket_request","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.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create_ticket_request","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":"components/schemas/create_ticket_request","exampleIds":["paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create_ticket_request","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":"Update a ticket","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tickets/updateticket","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","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{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1tickets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_ticket_request","exampleIds":["paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_not_found"]}},"schemaId":"components/schemas/update_ticket_request","exampleIds":["paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_not_found"],"pointer":"/paths/~1tickets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tickets/{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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update_ticket_request","exampleIds":["paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_not_found"]}},"responseCodes":["200","401","404"],"pointer":"/tickets/{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":"components/schemas/update_ticket_request","exampleIds":["paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_not_found"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update_ticket_request","exampleIds":["paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found","paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_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/ticket","exampleIds":["paths/~1tickets~1{id}/put/responses/200/content/application~1json/examples/Successful response"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~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/~1tickets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{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{id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Assignee not found"]}},"exampleIds":["paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Assignee not found"]}],"pointer":"/paths/~1tickets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{id}/put/responses/200/content/application~1json/examples/Successful response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{id}/put/responses/200/content/application~1json/examples/Successful response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"404","exampleIds":["paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Assignee not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Admin not found","paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Assignee not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/updateticket"}],"panels":[]}]},"httpPath":"/tickets/{id}"},{"label":"Retrieve a ticket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/tickets/getticket","routeSlug":"/docs/references/2.9/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{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":"id","in":"path","schemaId":"schema_715","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{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Intercom-Version","in":"header","schemaId":"schema_712"}],"pointer":"/paths/~1tickets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tickets/{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_715"}],"query":[],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","schemaId":"components/schemas/intercom_version"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/tickets/{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{id}/get/responses/200/content/application~1json/examples/Ticket found"]}},"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{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{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}],"pointer":"/paths/~1tickets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{id}/get/responses/200/content/application~1json/examples/Ticket found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ticket","exampleIds":["paths/~1tickets~1{id}/get/responses/200/content/application~1json/examples/Ticket found"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1tickets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/getticket"}],"panels":[]}]},"httpPath":"/tickets/{id}"},{"type":"link","label":"Ticket","link":"/docs/references/2.9/rest-api/api.intercom.io/tickets/ticket","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/tickets/ticket_contacts","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/tickets/ticket_part","routeSlug":"/docs/references/2.9/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 Type","link":"/docs/references/2.9/rest-api/api.intercom.io/tickets/ticket_type","routeSlug":"/docs/references/2.9/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 Type","link":"/tickets/ticket_type","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tickets/{id}/reply","summary":"Reply to a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/replyticket","deprecated":false},{"title":"/tickets","summary":"Create a ticket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/createticket","deprecated":false},{"title":"/tickets/{id}","summary":"Update a ticket","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tickets/updateticket","deprecated":false},{"title":"/tickets/{id}","summary":"Retrieve a ticket","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tickets/getticket","deprecated":false}]}]}]}]}},{"type":"group","label":"Visitors","link":"/docs/references/2.9/rest-api/api.intercom.io/visitors","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/visitors","items":[{"label":"Update a visitor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/references/2.9/rest-api/api.intercom.io/visitors/updatevisitor","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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/2.9/rest-api/api.intercom.io/visitors/retrievevisitorwithuserid","routeSlug":"/docs/references/2.9/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_715","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_712"}],"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_715"}],"querystring":[],"header":[{"name":"Intercom-Version","in":"header","example":"2.9","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/2.9/rest-api/api.intercom.io/visitors/convertvisitor","routeSlug":"/docs/references/2.9/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_712"}],"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.9","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":"Models","link":"/docs/references/2.9/rest-api/api.intercom.io/models","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models","items":[{"type":"link","label":"Activity Log","link":"/docs/references/2.9/rest-api/api.intercom.io/models/activity_log","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/activity_log_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/activity_log_metadata","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/addressable_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/admin_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/admin_priority_level","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/admin_reply_conversation_request","routeSlug":"/docs/references/2.9/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","link":"/docs/references/2.9/rest-api/api.intercom.io/models/admin_with_app","routeSlug":"/docs/references/2.9/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":"App","link":"/docs/references/2.9/rest-api/api.intercom.io/models/app","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/article_content","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/article_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/article_statistics","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/article_translated_content","routeSlug":"/docs/references/2.9/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":"Assign Conversation Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/assign_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/attach_contact_to_conversation_request","routeSlug":"/docs/references/2.9/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":"Close Conversation Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/close_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/collection_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/company_attached_contacts","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/company_attached_segments","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/company_data","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/company_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/company_scroll","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_archived","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_attached_companies","routeSlug":"/docs/references/2.9/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 companies","link":"/docs/references/2.9/rest-api/api.intercom.io/models/contact_companies","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_deleted","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_location","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_notes","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reference","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_base_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_email_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_intercom_user_id_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_ticket_email_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_ticket_intercom_user_id_request","routeSlug":"/docs/references/2.9/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":"User ID","link":"/docs/references/2.9/rest-api/api.intercom.io/models/contact_reply_ticket_user_id_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_reply_user_id_request","routeSlug":"/docs/references/2.9/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":"Segments","link":"/docs/references/2.9/rest-api/api.intercom.io/models/contact_segments","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_social_profiles","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_subscription_types","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_tags","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/contact_unarchived","routeSlug":"/docs/references/2.9/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":"Conversation attachment files","link":"/docs/references/2.9/rest-api/api.intercom.io/models/conversation_attachment_files","routeSlug":"/docs/references/2.9/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":"Contacts","link":"/docs/references/2.9/rest-api/api.intercom.io/models/conversation_contacts","routeSlug":"/docs/references/2.9/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":"First contact reply","link":"/docs/references/2.9/rest-api/api.intercom.io/models/conversation_first_contact_reply","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/conversation_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/conversation_part","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/conversation_part_author","routeSlug":"/docs/references/2.9/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 Parts","link":"/docs/references/2.9/rest-api/api.intercom.io/models/conversation_parts","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/conversation_rating","routeSlug":"/docs/references/2.9/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 source","link":"/docs/references/2.9/rest-api/api.intercom.io/models/conversation_source","routeSlug":"/docs/references/2.9/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 statistics","link":"/docs/references/2.9/rest-api/api.intercom.io/models/conversation_statistics","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/conversation_teammates","routeSlug":"/docs/references/2.9/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 Visitor Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/convert_visitor_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_article_request","routeSlug":"/docs/references/2.9/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 Collection Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_collection_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_contact_request","routeSlug":"/docs/references/2.9/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 Conversation Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_data_attribute_request","routeSlug":"/docs/references/2.9/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 Event Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_data_event_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_data_event_summaries_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_data_exports_request","routeSlug":"/docs/references/2.9/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 Message Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_message_request","routeSlug":"/docs/references/2.9/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 Or Update Company Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_or_update_company_request","routeSlug":"/docs/references/2.9/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 Tag Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_or_update_tag_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_phone_switch_request","routeSlug":"/docs/references/2.9/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 Section Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_section_request","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/create_section_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_section_request"},"seo":{"title":"Create Section Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Section Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/create_section_request"},"children":[]}]}]}},{"type":"link","label":"Create Ticket Reply Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_ticket_reply_request","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/create_ticket_reply_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"create_ticket_reply_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_request"},"children":[]}]}]}},{"type":"link","label":"Create Ticket Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/create_ticket_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_ticket_type_attribute_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/create_ticket_type_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/cursor_pages","routeSlug":"/docs/references/2.9/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":"Custom Attributes","link":"/docs/references/2.9/rest-api/api.intercom.io/models/custom_attributes","routeSlug":"/docs/references/2.9/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":"customer_request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/customer_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/data_attribute_list","routeSlug":"/docs/references/2.9/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 Event List","link":"/docs/references/2.9/rest-api/api.intercom.io/models/data_event_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/data_event_summary","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/data_event_summary_item","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/data_export_csv","routeSlug":"/docs/references/2.9/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":"Deleted Article Object","link":"/docs/references/2.9/rest-api/api.intercom.io/models/deleted_article_object","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/deleted_collection_object","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/deleted_company_object","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/deleted_company_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_company_object"},"seo":{"title":"Deleted Company Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Company Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_company_object"},"children":[]}]}]}},{"type":"link","label":"Deleted Object","link":"/docs/references/2.9/rest-api/api.intercom.io/models/deleted_object","routeSlug":"/docs/references/2.9/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":"Deleted Section Object","link":"/docs/references/2.9/rest-api/api.intercom.io/models/deleted_section_object","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/deleted_section_object","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deleted_section_object"},"seo":{"title":"Deleted Section Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleted Section Object","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deleted_section_object"},"children":[]}]}]}},{"type":"link","label":"detach_contact_from_conversation_request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/detach_contact_from_conversation_request","routeSlug":"/docs/references/2.9/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":"Error","link":"/docs/references/2.9/rest-api/api.intercom.io/models/error","routeSlug":"/docs/references/2.9/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":"File","link":"/docs/references/2.9/rest-api/api.intercom.io/models/file_attribute","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/group_content","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/group_translated_content","routeSlug":"/docs/references/2.9/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":"intercom_version","link":"/docs/references/2.9/rest-api/api.intercom.io/models/intercom_version","routeSlug":"/docs/references/2.9/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":"Merge contact data","link":"/docs/references/2.9/rest-api/api.intercom.io/models/merge_contacts_request","routeSlug":"/docs/references/2.9/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":"Multiple Filter Search Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/multiple_filter_search_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/news_item_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/note_list","routeSlug":"/docs/references/2.9/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":"Open Conversation Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/open_conversation_request","routeSlug":"/docs/references/2.9/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":"Pagination Object","link":"/docs/references/2.9/rest-api/api.intercom.io/models/pages_link","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/paginated_response","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/part_attachment","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/phone_switch","routeSlug":"/docs/references/2.9/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":"redact_conversation_request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/redact_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/reference","routeSlug":"/docs/references/2.9/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":"reply_conversation_request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/reply_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/search_request","routeSlug":"/docs/references/2.9/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":"Sections","link":"/docs/references/2.9/rest-api/api.intercom.io/models/section_list","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/section_list","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"section_list"},"seo":{"title":"Sections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sections","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/section_list"},"children":[]}]}]}},{"type":"link","label":"Segment List","link":"/docs/references/2.9/rest-api/api.intercom.io/models/segment_list","routeSlug":"/docs/references/2.9/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":"Single Filter Search Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/single_filter_search_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/sla_applied","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/snooze_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/social_profile","routeSlug":"/docs/references/2.9/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":"Pagination: Starting After","link":"/docs/references/2.9/rest-api/api.intercom.io/models/starting_after_paging","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/subscription_type_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/tag_company_request","routeSlug":"/docs/references/2.9/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":"Tags","link":"/docs/references/2.9/rest-api/api.intercom.io/models/tag_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/tag_multiple_users_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/tags","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/team_list","routeSlug":"/docs/references/2.9/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 Priority Level","link":"/docs/references/2.9/rest-api/api.intercom.io/models/team_priority_level","routeSlug":"/docs/references/2.9/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":"Ticket Attributes","link":"/docs/references/2.9/rest-api/api.intercom.io/models/ticket_custom_attributes","routeSlug":"/docs/references/2.9/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":"A Ticket Part representing a note","link":"/docs/references/2.9/rest-api/api.intercom.io/models/ticket_note","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/ticket_note","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ticket_note"},"seo":{"title":"A Ticket Part representing a note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"A Ticket Part representing a note","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ticket_note"},"children":[]}]}]}},{"type":"link","label":"Ticket part author","link":"/docs/references/2.9/rest-api/api.intercom.io/models/ticket_part_author","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/ticket_parts","routeSlug":"/docs/references/2.9/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":"Ticket Attributes","link":"/docs/references/2.9/rest-api/api.intercom.io/models/ticket_request_custom_attributes","routeSlug":"/docs/references/2.9/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 Type Attribute","link":"/docs/references/2.9/rest-api/api.intercom.io/models/ticket_type_attribute","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/ticket_type_attribute_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/ticket_type_list","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/translation","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/untag_company_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/update_article_request","routeSlug":"/docs/references/2.9/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 Collection Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/update_collection_request","routeSlug":"/docs/references/2.9/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 Contact Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/update_contact_request","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/update_contact_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_contact_request"},"seo":{"title":"Update Contact Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Contact Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_contact_request"},"children":[]}]}]}},{"type":"link","label":"Update Conversation Request","link":"/docs/references/2.9/rest-api/api.intercom.io/models/update_conversation_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/update_data_attribute_request","routeSlug":"/docs/references/2.9/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 Section Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/update_section_request","routeSlug":"/docs/references/2.9/rest-api/api.intercom.io/models/update_section_request","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"update_section_request"},"seo":{"title":"Update Section Request Payload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Section Request Payload","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/update_section_request"},"children":[]}]}]}},{"type":"link","label":"Update Ticket Request Payload","link":"/docs/references/2.9/rest-api/api.intercom.io/models/update_ticket_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/update_ticket_type_attribute_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/update_ticket_type_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/update_visitor_request","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/visitor","routeSlug":"/docs/references/2.9/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/2.9/rest-api/api.intercom.io/models/visitor_deleted_object","routeSlug":"/docs/references/2.9/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":[]}]}]}}],"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","link":"/models/admin_with_app","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":"Assign Conversation Request","link":"/models/assign_conversation_request","deprecated":false},{"title":"Assign Conversation Request","link":"/models/attach_contact_to_conversation_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 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":"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":"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":"Conversation attachment files","link":"/models/conversation_attachment_files","deprecated":false},{"title":"Contacts","link":"/models/conversation_contacts","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 Parts","link":"/models/conversation_parts","deprecated":false},{"title":"Conversation Rating","link":"/models/conversation_rating","deprecated":false},{"title":"Conversation source","link":"/models/conversation_source","deprecated":false},{"title":"Conversation statistics","link":"/models/conversation_statistics","deprecated":false},{"title":"Conversation teammates","link":"/models/conversation_teammates","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 Collection Request Payload","link":"/models/create_collection_request","deprecated":false},{"title":"Create Contact Request Payload","link":"/models/create_contact_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 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 Message Request Payload","link":"/models/create_message_request","deprecated":false},{"title":"Create Or Update Company Request Payload","link":"/models/create_or_update_company_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 Section Request Payload","link":"/models/create_section_request","deprecated":false},{"title":"Create Ticket Reply Request Payload","link":"/models/create_ticket_reply_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":"Custom Attributes","link":"/models/custom_attributes","deprecated":false},{"title":"customer_request","link":"/models/customer_request","deprecated":false},{"title":"Data Attribute List","link":"/models/data_attribute_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":"Deleted Article Object","link":"/models/deleted_article_object","deprecated":false},{"title":"Deleted Collection Object","link":"/models/deleted_collection_object","deprecated":false},{"title":"Deleted Company Object","link":"/models/deleted_company_object","deprecated":false},{"title":"Deleted Object","link":"/models/deleted_object","deprecated":false},{"title":"Deleted Section Object","link":"/models/deleted_section_object","deprecated":false},{"title":"detach_contact_from_conversation_request","link":"/models/detach_contact_from_conversation_request","deprecated":false},{"title":"Error","link":"/models/error","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":"intercom_version","link":"/models/intercom_version","deprecated":false},{"title":"Merge contact data","link":"/models/merge_contacts_request","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":"Open Conversation Request","link":"/models/open_conversation_request","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":"redact_conversation_request","link":"/models/redact_conversation_request","deprecated":false},{"title":"Reference","link":"/models/reference","deprecated":false},{"title":"reply_conversation_request","link":"/models/reply_conversation_request","deprecated":false},{"title":"Search data","link":"/models/search_request","deprecated":false},{"title":"Sections","link":"/models/section_list","deprecated":false},{"title":"Segment List","link":"/models/segment_list","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":"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":"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 Priority Level","link":"/models/team_priority_level","deprecated":false},{"title":"Ticket Attributes","link":"/models/ticket_custom_attributes","deprecated":false},{"title":"A Ticket Part representing a note","link":"/models/ticket_note","deprecated":false},{"title":"Ticket part author","link":"/models/ticket_part_author","deprecated":false},{"title":"Ticket Parts","link":"/models/ticket_parts","deprecated":false},{"title":"Ticket Attributes","link":"/models/ticket_request_custom_attributes","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 Collection Request Payload","link":"/models/update_collection_request","deprecated":false},{"title":"Update Contact Request Payload","link":"/models/update_contact_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 Section Request Payload","link":"/models/update_section_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}]}]}]}]}}],"store":{"schemaStore":{"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_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","message_deletion","message_state_change","messenger_look_and_feel_change","messenger_search_required_change","messenger_spaces_change","office_hours_change","role_change","role_creation","role_deletion","ruleset_activation_title_preview","ruleset_creation","ruleset_deletion","search_browse_enabled_change","search_browse_required_change","seat_change","seat_revoke","security_settings_change","temporary_expectation_change","upfront_email_collection_change","welcome_message_change"],"example":"app_name_change"},"activity_description":{"type":"string","description":"A sentence or two describing the activity.","example":"Admin updated the app's name to \"My App\"."}}}},"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 Bloggs"}}}},"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 Examplee"},"email":{"type":"string","description":"The email of the admin.","example":"wash@example.com"},"job_title":{"type":"string","description":"The job title of the admin.","example":"Philosopher"},"away_mode_enabled":{"type":"boolean","description":"Identifies if this admin is currently set in away mode.","example":false},"away_mode_reassign":{"type":"boolean","description":"Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.","example":false},"has_inbox_seat":{"type":"boolean","description":"Identifies if this admin has a paid inbox seat to restrict/allow features that require them.","example":true},"team_ids":{"type":"array","description":"This object represents the avatar associated with the admin.","example":[814865],"items":{"type":"integer"}},"avatar":{"type":"string","format":"uri","nullable":true,"description":"Image for the associated team or teammate","example":"https://picsum.photos/200/300"},"team_priority_level":{"$ref":"#/components/schemas/team_priority_level"}}}},"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"]},"type":{"type":"string","enum":["admin"],"example":"admin"},"body":{"type":"string","description":"The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.","example":"Hello there!"},"admin_id":{"type":"string","description":"The id of the admin who is authoring the comment.","example":"3156780"},"created_at":{"type":"integer","description":"The time the reply was created. If not provided, the current time will be used.","example":1590000000},"attachment_urls":{"type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10},"attachment_files":{"type":"array","description":"A list of files that will be added as attachments. You can include up to 10 files","items":{"$ref":"#/components/schemas/conversation_attachment_files"},"maxItems":10}},"required":["message_type","type","admin_id"]}},"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 Examplee"},"email":{"type":"string","description":"The email of the admin.","example":"wash@example.com"},"job_title":{"type":"string","description":"The job title of the admin.","example":"Philosopher"},"away_mode_enabled":{"type":"boolean","description":"Identifies if this admin is currently set in away mode.","example":false},"away_mode_reassign":{"type":"boolean","description":"Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.","example":false},"has_inbox_seat":{"type":"boolean","description":"Identifies if this admin has a paid inbox seat to restrict/allow features that require them.","example":true},"team_ids":{"type":"array","description":"This is a list of ids of the teams that this admin is part of.","example":[814865],"items":{"type":"integer"}},"avatar":{"type":"object","description":"This object represents the avatar associated with the admin.","properties":{"type":{"type":"string","description":[{"$$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/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/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/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.","example":"This is the body of the article."},"author_id":{"type":"integer","description":"The ID of the author of the article.","example":"5017691"},"state":{"type":"string","description":[{"$$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},"url":{"type":"string","description":"The URL of the article.","example":"http://intercom.test/help/en/articles/3-default-language"}}}},"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"},"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},"url":{"type":"string","nullable":true,"description":"The URL of the article. For multilingual articles, this will be the URL of the default language's content.","example":"http://intercom.test/help/en/articles/3-default-language"},"parent_id":{"type":"integer","nullable":true,"description":"The id of the article's parent collection or section. An article without this field stands alone.","example":"125685"},"parent_ids":{"type":"array","description":"The ids of the article's parent collections or sections. An article without this field stands alone.","items":{"type":"integer"},"example":[18,19]},"parent_type":{"type":"string","nullable":true,"description":[{"$$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"},"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"}}}},"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 other types of reaction.","example":20}}}},"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/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":"joe@example.com"},"customer":{"$ref":"#/components/schemas/customer_request"}},"required":["email"]}]}}}},"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"},"help_center_id":{"type":"integer","nullable":true,"description":"The id of the help center the collection is in.","example":"123"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of object - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["collection"],"default":"collection","example":"collection"}}}},"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":"Example Company Inc."},"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"}}}}}}},"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_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"],"description":"Contact are the objects that represent your leads and users in Intercom.","properties":{"type":{"type":"string","description":"The type of object.","example":"contact"},"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"5ba682d23d7cf92bef87bfd4"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"f3b87a2e09d514c6c2e79b9a"},"workspace_id":{"type":"string","description":"The id of the workspace which the contact belongs to.","example":"ecahpwf5"},"role":{"type":"string","description":"The role of the contact.","example":"user"},"email":{"type":"string","description":"The contact's email.","example":"joe@example.com"},"email_domain":{"type":"string","description":"The contact's email domain.","example":"example.com"},"phone":{"type":"string","nullable":true,"description":"The contacts phone.","example":"+1123456789"},"name":{"type":"string","nullable":true,"description":"The contacts name.","example":"John Doe"},"owner_id":{"type":"integer","nullable":true,"description":"The id of an admin that has been assigned account ownership of the contact.","example":123},"has_hard_bounced":{"type":"boolean","description":"Whether the contact has had an email sent to them hard bounce.","example":true},"marked_email_as_spam":{"type":"boolean","description":"Whether the contact has marked an email sent to them as spam.","example":true},"unsubscribed_from_emails":{"type":"boolean","description":"Whether the contact is unsubscribed from emails.","example":true},"created_at":{"type":"integer","format":"date-time","description":"(Unix timestamp 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"}}}},"components/schemas/contact_archived":{"id":"components/schemas/contact_archived","kind":"json-schema","title":"Contact Archived","data":{"title":"Contact Archived","type":"object","description":"archived contact object","properties":{"type":{"type":"string","description":"always contact","enum":["contact"],"example":"contact"},"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"5ba682d23d7cf92bef87bfd4"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"f3b87a2e09d514c6c2e79b9a"},"archived":{"type":"boolean","description":"Whether the contact is archived or not.","example":true}}}},"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 containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.","properties":{"data":{"type":"array","description":"An array of company data objects attached to the contact.","items":{"$ref":"#/components/schemas/company_data"}},"url":{"type":"string","format":"uri","description":"Url to get more company resources for this contact","example":"/contacts/5ba682d23d7cf92bef87bfd4/companies"},"total_count":{"type":"integer","description":"Int representing the total number of companyies attached to this contact","example":100},"has_more":{"type":"boolean","description":"Whether there's more Addressable Objects to be viewed. If true, use the url to view all","example":true}}}},"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","type":"object","description":"deleted contact object","properties":{"type":{"type":"string","description":"always contact","enum":["contact"],"example":"contact"},"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"5ba682d23d7cf92bef87bfd4"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"f3b87a2e09d514c6c2e79b9a"},"deleted":{"type":"boolean","description":"Whether the contact is deleted or not.","example":true}}}},"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":"f3b87a2e09d514c6c2e79b9a"}}}},"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."},"attachment_urls":{"title":"Attachment URLs","type":"array","description":"A list of image URLs that will be added as attachments. You can include up to 10 URLs.","items":{"type":"string","format":"uri"},"maxItems":10}},"required":["message_type","type","body"]}},"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_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_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_unarchived":{"id":"components/schemas/contact_unarchived","kind":"json-schema","title":"Contact Unarchived","data":{"title":"Contact Unarchived","type":"object","description":"unarchived contact object","properties":{"type":{"type":"string","description":"always contact","enum":["contact"],"example":"contact"},"id":{"type":"string","description":"The unique identifier for the contact which is given by Intercom.","example":"5ba682d23d7cf92bef87bfd4"},"external_id":{"type":"string","nullable":true,"description":"The unique identifier for the contact which is provided by the Client.","example":"f3b87a2e09d514c6c2e79b9a"},"archived":{"type":"boolean","description":"Whether the contact is archived or not.","example":false}}}},"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":["priority","not_priority"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If marked as priority, it will return priority or else not_priority."},"children":[]}]}]}],"example":"priority"},"admin_assignee_id":{"type":"integer","nullable":true,"description":"The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.","example":0},"team_assignee_id":{"type":"integer","nullable":true,"description":"The id of the team assigned to the conversation. If it's not assigned to a team it will return null.","example":5017691},"tags":{"$ref":"#/components/schemas/tags"},"conversation_rating":{"$ref":"#/components/schemas/conversation_rating"},"source":{"$ref":"#/components/schemas/conversation_source"},"contacts":{"$ref":"#/components/schemas/conversation_contacts"},"teammates":{"$ref":"#/components/schemas/conversation_teammates"},"first_contact_reply":{"$ref":"#/components/schemas/conversation_first_contact_reply"},"sla_applied":{"$ref":"#/components/schemas/sla_applied"},"statistics":{"$ref":"#/components/schemas/conversation_statistics"}}}},"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":["priority","not_priority"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If marked as priority, it will return priority or else not_priority."},"children":[]}]}]}],"example":"priority"},"admin_assignee_id":{"type":"integer","nullable":true,"description":"The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.","example":0},"team_assignee_id":{"type":"integer","nullable":true,"description":"The id of the team assigned to the conversation. If it's not assigned to a team it will return null.","example":5017691},"tags":{"$ref":"#/components/schemas/tags"},"conversation_rating":{"$ref":"#/components/schemas/conversation_rating"},"source":{"$ref":"#/components/schemas/conversation_source"},"contacts":{"$ref":"#/components/schemas/conversation_contacts"},"teammates":{"$ref":"#/components/schemas/conversation_teammates"},"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"}}}},"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_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_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":"The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.","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}}}},"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"}}}},"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":2}}}},"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},"contact":{"$ref":"#/components/schemas/contact_reference"},"teammate":{"$ref":"#/components/schemas/reference"}}}},"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp."},"children":[]}]}]}],"example":"conversation","enum":["conversation","email","facebook","instagram","phone_call","phone_switch","push","sms","twitter","whatsapp"]},"id":{"type":"string","description":"The id representing the message.","example":"3"},"delivered_as":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email)."},"children":[]}]}]}],"example":"operator_initiated"},"subject":{"type":"string","description":"Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.","example":""},"body":{"type":"string","description":"The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.","example":"<p>Hey there!</p>"},"author":{"$ref":"#/components/schemas/conversation_part_author"},"attachments":{"type":"array","description":"A list of attachments for the part.","items":{"$ref":"#/components/schemas/part_attachment"}},"url":{"type":"string","nullable":true,"description":"The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.","example":null},"redacted":{"type":"boolean","description":"Whether or not the source message has been redacted. Only applicable for contact initiated messages.","example":false}}}},"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}}}},"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_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":"joe@example.com"}},"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":"joe@example.com"}},"anyOf":[{"required":["id"]},{"required":["user_id"]},{"required":["email"]}]}},"required":["type","user","visitor"]}},"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":"The content of the article. For multilingual articles, this will be the body of the default language's content.","example":"<p>This is the body in html</p>"},"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"}},"required":["title","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"},"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":{"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":"integer","nullable":true,"description":"The id of an admin that has been assigned account ownership of the contact","example":123},"unsubscribed_from_emails":{"type":"boolean","nullable":true,"description":"Whether the contact is unsubscribed from emails","example":true},"custom_attributes":{"type":"object","nullable":true,"description":"The custom attributes which are set for the contact","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_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},"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":"inapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in-app messaging), "},"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":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["inapp","email","sms","whatsapp","facebook"],"example":"inapp"}},"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_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":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["in_app","email"],"example":"in_app"},"subject":{"type":"string","description":"The title of the email.","example":"Thanks for everything"},"body":{"type":"string","description":"The content of the message. HTML and plaintext are supported.","example":"Hello there"},"template":{"type":"string","description":[{"$$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":{"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":"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"]},"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"]}]}},"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":"Technology"},"custom_attributes":{"type":"object","description":"A hash of key/value pairs containing any other data about the company you want Intercom to store.","additionalProperties":{"type":"string"},"example":{"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}},"remote_created_at":{"type":"integer","description":"The time the company was created by you.","example":1394531169},"monthly_spend":{"type":"integer","description":[{"$$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_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_section_request":{"id":"components/schemas/create_section_request","kind":"json-schema","title":"Create Section Request Payload","data":{"description":"You can create a Section","type":"object","title":"Create Section Request Payload","properties":{"name":{"type":"string","description":"The name of the collection. For multilingual collections, this will be the name of the default language's content.","example":"Section 51"},"parent_id":{"type":"integer","description":"The id for the collection this section will be within.","example":18},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"}},"required":["name","parent_id"]}},"components/schemas/create_ticket_reply_request":{"id":"components/schemas/create_ticket_reply_request","kind":"json-schema","title":"Create Ticket Reply Request Payload","data":{"title":"Create Ticket Reply Request Payload","type":"object","properties":{"body":{"type":"string","description":"The message body of the note, which may contain HTML.","example":"<p>Okay!</p>"},"message_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the reply. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at the moment."},"children":[]}]}]}],"example":"note","default":"note"},"admin_id":{"type":"string","description":"The id of the admin who is making the note.","example":"1234"}},"required":["body","admin_id"]}},"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"}]},"company_id":{"type":"string","description":"The ID of the company that the ticket is associated with. The ID that you set upon company creation.","example":"1234"},"ticket_attributes":{"$ref":"#/components/schemas/ticket_request_custom_attributes"}},"required":["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"},"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/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.","additionalProperties":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/custom_object_instance"}]}}},"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":"5a7a19e9f59ae20001d1c1e6"},"external_id":{"type":"string","description":"The id you have defined for the custom object instance.","example":"0001d1c1e65a7a19e9f59ae2"},"type":{"type":"string","description":"The identifier of the custom object type that defines the structure of the custom object instance.","example":"Order"},"custom_attributes":{"type":"object","description":"The custom attributes you have set on the custom object instance.","additionalProperties":{"type":"string"}}}}},"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, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.","properties":{"type":{"type":"string","description":[{"$$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, companies or conversations.","properties":{"type":{"type":"string","description":"The type of the object","enum":["list"],"example":"list"},"data":{"type":"array","description":"A list of data attributes","items":{"$ref":"#/components/schemas/data_attribute"}}}}},"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_identfier":{"type":"string","description":"The identifier for your job.","example":"orzzsbd7hk67xyu"},"status":{"type":"string","enum":["pending","in_progress","failed","completed","no_data","canceled"],"description":"The current state of your job.","example":"pending"},"download_expires_at":{"type":"string","description":"The time after which you will not be able to access the data.","example":"1674917488"},"download_url":{"type":"string","description":"The location where you can download your data.","example":"https://api.intercom.test/download/messages/data/example"}}}},"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_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/deleted_section_object":{"id":"components/schemas/deleted_section_object","kind":"json-schema","title":"Deleted Section Object","data":{"title":"Deleted Section Object","type":"object","description":"Response returned when an object is deleted","properties":{"id":{"type":"string","description":"The unique identifier for the section which you provided in the URL.","example":"6890762"},"object":{"type":"string","description":[{"$$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":"section"},"children":[]}]}]}],"enum":["section"],"example":"section"},"deleted":{"type":"boolean","description":"Whether the section 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/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/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/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://intercom.help/mycompany"},"custom_domain":{"type":"string","nullable":true,"description":"Custom domain configured for the help center","example":"help.mycompany.com"}}}},"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/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.9","default":"2.9","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","Preview"]}},"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"}}}},"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/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.","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"}}},"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.","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/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/section":{"id":"components/schemas/section","kind":"json-schema","title":"Section","data":{"title":"Section","type":"object","x-tags":["Help Center"],"description":"Sections are subdivisions of a collection, with a collection potentially having multiple sections.","properties":{"type":{"type":"string","description":[{"$$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":"section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["section"],"default":"section","example":"section"},"id":{"type":"string","description":"The unique identifier for the section which is given by Intercom.","example":"6871119"},"workspace_id":{"type":"string","description":"The id of the workspace which the section belongs to.","example":"hfi1bx4l"},"name":{"type":"string","description":"The name of the section. For multilingual sections, this will be the name of the default language's content.","example":"Default language name"},"created_at":{"type":"integer","format":"date-time","description":"The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content.","example":1672928359},"updated_at":{"type":"integer","format":"date-time","description":"The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content.","example":1672928610},"url":{"type":"string","nullable":true,"description":"The URL of the section. For multilingual help centers, this will be the URL of the section for the default language.","example":"http://intercom.test/help/section/name"},"icon":{"type":"string","nullable":true,"description":"The icon of the section.","example":"book-bookmark"},"order":{"type":"integer","description":[{"$$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"},"parent_id":{"oneOf":[{"type":"integer","title":"Integer"},{"type":"string","title":"String"}],"description":"The id of the parent section.","example":6871119},"default_locale":{"type":"string","description":"The default locale of the help center. This field is only returned for multilingual help centers.","example":"en"},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"}}}},"components/schemas/section_list":{"id":"components/schemas/section_list","kind":"json-schema","title":"Sections","data":{"title":"Sections","type":"object","description":"This will return a list of Sections 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 sections.","example":12},"data":{"type":"array","description":"An array of section objects","items":{"$ref":"#/components/schemas/section"}}}}},"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":{"type":"string","description":"The value that you want to search on.","example":"73732934"}}}},"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_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"}}}},"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/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"},"ticket_attributes":{"$ref":"#/components/schemas/ticket_custom_attributes"},"ticket_state":{"type":"string","description":"The state the ticket is currenly in","enum":["submitted","in_progress","waiting_on_customer","resolved"],"example":"submitted"},"ticket_state_internal_label":{"type":"string","description":"The state the ticket is currently in, in a human readable form - visible in Intercom"},"ticket_state_external_label":{"type":"string","description":"The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal."},"ticket_type":{"$ref":"#/components/schemas/ticket_type"},"contacts":{"$ref":"#/components/schemas/ticket_contacts"},"admin_assignee_id":{"type":"string","description":"The id representing the admin assigned to the ticket.","example":"1295"},"team_assignee_id":{"type":"string","description":"The id representing the team assigned to the ticket.","example":"1295"},"created_at":{"type":"integer","format":"date-time","description":"The time the ticket was created as a UTC Unix timestamp.","example":1663597223},"updated_at":{"type":"integer","format":"date-time","description":"The last time the ticket was updated as a UTC Unix timestamp.","example":1663597260},"ticket_parts":{"$ref":"#/components/schemas/ticket_parts"},"is_shared":{"type":"boolean","description":"Whether or not the ticket is shared with the customer.","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_note":{"id":"components/schemas/ticket_note","kind":"json-schema","title":"A Ticket Part representing a note","data":{"title":"A Ticket Part representing a note","type":"object","description":"A Ticket Part representing a note 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","enum":["ticket_part"]},"id":{"type":"string","description":"The id representing the note.","example":"3"},"part_type":{"type":"string","description":"Always note","example":"note","enum":["note"]},"body":{"type":"string","nullable":true,"description":"The message body, which may contain HTML.","example":"<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_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}}}},"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","enum":["admin","bot","team"]},"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_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_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"},"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"},"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":"ticket_type.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ticket_types":{"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_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":"The content of the article. For multilingual articles, this will be the body of the default language's content.","example":"<p>This is the body in html</p>"},"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"}}}},"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"}}}},"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"},"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":"integer","nullable":true,"description":"The id of an admin that has been assigned account ownership of the contact","example":123},"unsubscribed_from_emails":{"type":"boolean","nullable":true,"description":"Whether the contact is unsubscribed from emails","example":true},"custom_attributes":{"type":"object","nullable":true,"description":"The custom attributes which are set for the contact"}}}},"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},"custom_attributes":{"$ref":"#/components/schemas/custom_attributes"}}}},"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_section_request":{"id":"components/schemas/update_section_request","kind":"json-schema","title":"Update Section Request Payload","data":{"description":"You can update a Section","type":"object","title":"Update Section Request Payload","properties":{"name":{"type":"string","description":"The name of the collection. For multilingual collections, this will be the name of the default language's content.","example":"Section 51"},"parent_id":{"type":"integer","description":"The id for the collection this section will be within.","example":18},"translated_content":{"nullable":true,"$ref":"#/components/schemas/group_translated_content"}}}},"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"}},"state":{"type":"string","enum":["in_progress","waiting_on_customer","resolved"],"description":"The state of the ticket.","example":"submitted"},"is_shared":{"type":"boolean","description":"Specify whether the ticket is visible to users.","example":true},"assignment":{"type":"object","properties":{"admin_id":{"type":"string","description":"The ID of the admin performing the action.","example":"123"},"assignee_id":{"type":"string","description":"The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.","example":"123"}}}}}},"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"},"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"}}}},"schema_712":{"kind":"json-schema","data":{"$ref":"#/components/schemas/intercom_version"},"id":"schema_712"},"schema_713":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_713"},"schema_714":{"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}}},"id":"schema_714"},"schema_715":{"kind":"json-schema","data":{"type":"string"},"id":"schema_715"},"schema_716":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_716"},"schema_717":{"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_717"},"schema_718":{"kind":"json-schema","data":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The text of the note.","example":"New note"},"contact_id":{"type":"string","description":"The unique identifier of a given contact.","example":"123"},"admin_id":{"type":"string","description":"The unique identifier of a given admin.","example":"123"}}},"id":"schema_718"},"schema_719":{"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_719"},"schema_720":{"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_720"},"schema_721":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/update_contact_request"}]},"id":"schema_721"},"schema_722":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/create_contact_request"}]},"id":"schema_722"},"schema_723":{"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_723"},"schema_724":{"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_724"},"schema_725":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":150},"id":"schema_725"},"schema_726":{"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_726"},"schema_727":{"kind":"json-schema","data":{"type":"string","enum":["contact","company","conversation"]},"id":"schema_727"},"schema_728":{"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_728"},"schema_729":{"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_729"},"schema_730":{"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_730"}},"exampleStore":{"paths/~1me/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"admin","id":"991267242","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":1717021328,"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{id}~1away/put/requestBody/content/application~1json/examples/successful_response":{"value":{"away_mode_enabled":true,"away_mode_reassign":true},"key":"successful_response","summary":"Successful response","id":"paths/~1admins~1{id}~1away/put/requestBody/content/application~1json/examples/successful_response"},"paths/~1admins~1{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{id}~1away/put/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1admins~1{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{id}~1away/put/requestBody/content/application~1json/examples/unauthorized"},"paths/~1admins~1{id}~1away/put/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"admin","id":"991267243","name":"Ciaran2 Lee","email":"admin2@email.com","away_mode_enabled":true,"away_mode_reassign":true,"has_inbox_seat":true,"team_ids":[]},"key":"Successful response","summary":"Successful response","id":"paths/~1admins~1{id}~1away/put/responses/200/content/application~1json/examples/Successful response"},"paths/~1admins~1{id}~1away/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ee1782d2-154b-4a94-824b-144059b4e321","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1{id}~1away/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1{id}~1away/put/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"20a813b6-c6b4-4430-a9db-12956e806ec1","errors":[{"code":"admin_not_found","message":"Admin for admin_id not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1admins~1{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":"b12d89d1-922f-4bec-b532-247bb581fd15","performed_by":{"type":"admin","id":"991267247","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":1717021333,"activity_type":"message_state_change","activity_description":"Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title."},{"id":"ab862e22-dac4-430a-bd06-6324b9bfbe53","performed_by":{"type":"admin","id":"991267247","email":"admin5@email.com","ip":"127.0.0.1"},"metadata":{"before":"before","after":"after"},"created_at":1717021333,"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/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":"69a6cf16-1eaf-42f3-bf89-e4a9944f5f89","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/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"admin.list","admins":[{"type":"admin","email":"admin7@email.com","id":"991267249","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":"7ce06acd-f398-4faf-8fe8-7c5b8bc5c3ca","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{id}/get/responses/200/content/application~1json/examples/Admin found":{"value":{"type":"admin","id":"991267251","name":"Ciaran9 Lee","email":"admin9@email.com","away_mode_enabled":false,"away_mode_reassign":false,"has_inbox_seat":true,"team_ids":[]},"key":"Admin found","summary":"Admin found","id":"paths/~1admins~1{id}/get/responses/200/content/application~1json/examples/Admin found"},"paths/~1admins~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"231aad72-f519-4f47-b436-663eb5046063","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1admins~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1admins~1{id}/get/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"8d8d85cb-c827-44f2-abee-58edbb4d1dda","errors":[{"code":"admin_not_found","message":"Admin not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1admins~1{id}/get/responses/404/content/application~1json/examples/Admin not found"},"paths/~1articles/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","pages":{"type":"pages","page":1,"per_page":25,"total_pages":1},"total_count":1,"data":[{"id":"35","type":"article","workspace_id":"this_is_an_id33_that_should_be_at_least_4","parent_id":145,"parent_type":"collection","parent_ids":[],"title":"This is the article title","description":"","body":"","author_id":991267254,"state":"published","created_at":1717021340,"updated_at":1717021340,"url":"http://help-center.test/myapp-33/en/articles/35-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":"78e7c2d8-6d98-4b85-af8a-3e4ae5438eb3","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":991267259,"state":"published","parent_id":147,"parent_type":"collection","translated_content":{"fr":{"title":"Merci pour tout","description":"Description de l'article","body":"Corps de l'article","author_id":991267259,"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":"38","type":"article","workspace_id":"this_is_an_id37_that_should_be_at_least_4","parent_id":147,"parent_type":"collection","parent_ids":[],"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0},"title":"Thanks for everything","description":"Description of the Article","body":"<p class=\"no-margin\">Body of the Article</p>","author_id":991267259,"state":"published","created_at":1717021342,"updated_at":1717021342,"url":"http://help-center.test/myapp-37/en/articles/38-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":"dc6520ae-9647-4c5e-a83f-344532dc9a59","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":"58823089-52e6-4242-8693-b881c74a26d7","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{id}/get/responses/200/content/application~1json/examples/Article found":{"value":{"id":"41","type":"article","workspace_id":"this_is_an_id43_that_should_be_at_least_4","parent_id":150,"parent_type":"collection","parent_ids":[],"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0},"title":"This is the article title","description":"","body":"","author_id":991267264,"state":"published","created_at":1717021344,"updated_at":1717021344,"url":"http://help-center.test/myapp-43/en/articles/41-this-is-the-article-title"},"key":"Article found","summary":"Article found","id":"paths/~1articles~1{id}/get/responses/200/content/application~1json/examples/Article found"},"paths/~1articles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"4df4917b-c4d0-45a9-a61e-6c3597e96e10","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{id}/get/responses/404/content/application~1json/examples/Article not found":{"value":{"type":"error.list","request_id":"f15f878f-3fb3-47f0-acc7-c7adcef0c61d","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Article not found","summary":"Article not found","id":"paths/~1articles~1{id}/get/responses/404/content/application~1json/examples/Article not found"},"paths/~1articles~1{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{id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1articles~1{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{id}/put/requestBody/content/application~1json/examples/article_not_found"},"paths/~1articles~1{id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"44","type":"article","workspace_id":"this_is_an_id49_that_should_be_at_least_4","parent_id":153,"parent_type":"collection","parent_ids":[],"statistics":{"type":"article_statistics","views":0,"conversations":0,"reactions":0,"happy_reaction_percentage":0,"neutral_reaction_percentage":0,"sad_reaction_percentage":0},"title":"Christmas is here!","description":"","body":"<p class=\"no-margin\">New gifts in store for the jolly season</p>","author_id":991267270,"state":"published","created_at":1717021347,"updated_at":1717021347,"url":"http://help-center.test/myapp-49/en/articles/44-christmas-is-here"},"key":"successful","summary":"successful","id":"paths/~1articles~1{id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1articles~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b48c9005-6e42-46aa-a792-ffe1279164c0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{id}/put/responses/404/content/application~1json/examples/Article Not Found":{"value":{"type":"error.list","request_id":"ebc188c3-3680-4724-a6a4-939f760cf1ff","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Article Not Found","summary":"Article Not Found","id":"paths/~1articles~1{id}/put/responses/404/content/application~1json/examples/Article Not Found"},"paths/~1articles~1{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"47","object":"article","deleted":true},"key":"successful","summary":"successful","id":"paths/~1articles~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1articles~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"50e2264e-9795-4eda-839b-8435da6eb115","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1articles~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1articles~1{id}/delete/responses/404/content/application~1json/examples/Article Not Found":{"value":{"type":"error.list","request_id":"1c891e3d-b5c7-4f63-93f1-c131397c71ec","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Article Not Found","summary":"Article Not Found","id":"paths/~1articles~1{id}/delete/responses/404/content/application~1json/examples/Article Not Found"},"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":"6657aaba6abd0164c24b0c8e","app_id":"this_is_an_id127_that_should_be_at_least_","name":"my company","remote_created_at":1374138000,"created_at":1717021370,"updated_at":1717021370,"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":"bfe6a349-0654-4e5e-b9c8-f3fdda83e0fa","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":"6657aabc6abd0164c24b0c96","app_id":"this_is_an_id133_that_should_be_at_least_","name":"IntercomQATest1","remote_created_at":1717021372,"created_at":1717021372,"updated_at":1717021372,"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":"7aebb259-19d4-4319-87ef-5be8441c07b6","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":"1f01a6c6-5bfd-4b36-9778-aaf35e7c40b3","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{id}/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6657aabe6abd0164c24b0ca1","app_id":"this_is_an_id139_that_should_be_at_least_","name":"company1","remote_created_at":1717021374,"created_at":1717021374,"updated_at":1717021374,"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{id}/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a2e85fb1-4b73-4001-81f1-59b1eae9acbe","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{id}/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"6f14da94-ea76-4693-8ee8-f7d0cfdf4c6e","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{id}/get/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{id}/put/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6657aac06abd0164c24b0cab","app_id":"this_is_an_id145_that_should_be_at_least_","name":"company2","remote_created_at":1717021376,"created_at":1717021376,"updated_at":1717021376,"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{id}/put/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5457ba38-3d4e-47c1-98f2-8ea519cbd63f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{id}/put/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"1dc7b16f-9368-42a7-97e7-db4068df5c6c","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{id}/put/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{id}/delete/responses/200/content/application~1json/examples/Successful":{"value":{"id":"6657aac36abd0164c24b0cb5","object":"company","deleted":true},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{id}/delete/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b1857b1c-7be0-4c1b-b417-991e48903439","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"fc9dc442-d14b-4500-bd17-340d4081e0a8","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{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{id}~1contacts/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8c869368-88be-4489-8a12-588bae568529","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{id}~1contacts/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"3f658ef0-56a2-48f2-a3ba-f86b379a75eb","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{id}~1contacts/get/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1companies~1{id}~1segments/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[]},"key":"Successful","summary":"Successful","id":"paths/~1companies~1{id}~1segments/get/responses/200/content/application~1json/examples/Successful"},"paths/~1companies~1{id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"d835d6ef-48b4-4ba9-9814-86e66e5bd8e9","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1companies~1{id}~1segments/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1companies~1{id}~1segments/get/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"4b8e5c25-306a-4073-b5ae-d87a2c96519d","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1companies~1{id}~1segments/get/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":"6657aac96abd0164c24b0cd1","app_id":"this_is_an_id169_that_should_be_at_least_","name":"IntercomQATest1","remote_created_at":1717021385,"created_at":1717021385,"updated_at":1717021385,"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":"b672ed4c-464a-4606-b2c1-8d40edef7951","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":"6657aacb6abd0164c24b0cd7","app_id":"this_is_an_id173_that_should_be_at_least_","name":"IntercomQATest1","remote_created_at":1717021387,"created_at":1717021387,"updated_at":1717021387,"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":"759035f4-de24-45cf-9f63-9aa86aba1248"},"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":"f40dc354-ebc0-4eaa-b713-ac942902b635","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{id}~1companies/post/requestBody/content/application~1json/examples/successful":{"value":{"id":"6657aacd6abd0164c24b0ce0"},"key":"successful","summary":"Successful","id":"paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request":{"value":null,"key":"bad_request","summary":"Bad Request","id":"paths/~1contacts~1{id}~1companies/post/requestBody/content/application~1json/examples/bad_request"},"paths/~1contacts~1{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{id}~1companies/post/requestBody/content/application~1json/examples/company_not_found"},"paths/~1contacts~1{id}~1companies/post/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6657aacd6abd0164c24b0ce0","app_id":"this_is_an_id177_that_should_be_at_least_","name":"company6","remote_created_at":1717021389,"created_at":1717021389,"updated_at":1717021389,"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{id}~1companies/post/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request":{"value":{"type":"error.list","request_id":"acd7e8d3-23e0-4a81-9027-dc73d9eb94f9","errors":[{"code":"parameter_not_found","message":"company not specified"}]},"key":"Bad Request","summary":"Bad Request","id":"paths/~1contacts~1{id}~1companies/post/responses/400/content/application~1json/examples/Bad Request"},"paths/~1contacts~1{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{id}~1companies/post/responses/400/content/application~1json/examples/Contact Company Limit Exceeded"},"paths/~1contacts~1{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a8b4fc2f-3e2c-4339-ba90-7df1c7f55d94","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}~1companies/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"9b32d40e-a76d-4391-8058-c4856f47f30f","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company Not Found","summary":"Company Not Found","id":"paths/~1contacts~1{id}~1companies/post/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1contacts~1{id}~1companies/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"list","data":[{"type":"company","company_id":"1","id":"6657aad36abd0164c24b0d01","app_id":"this_is_an_id193_that_should_be_at_least_","name":"company12","remote_created_at":1717021395,"created_at":1717021395,"updated_at":1717021395,"last_request_at":1716848595,"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{id}~1companies/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"569829f1-97e6-43ae-82bf-1ddc978fd525","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}~1companies/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"310fc913-3cc2-4222-9de9-2b327149f0dd","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1companies/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/200/content/application~1json/examples/Successful":{"value":{"type":"company","company_id":"1","id":"6657aad06abd0164c24b0cf0","app_id":"this_is_an_id185_that_should_be_at_least_","name":"company8","remote_created_at":1717021392,"created_at":1717021392,"updated_at":1717021392,"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{id}/delete/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2933cb04-d47e-4ad9-b764-f6abef8a224b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Company Not Found":{"value":{"type":"error.list","request_id":"f5af06b4-da5a-442a-8610-960fa3e1ea3f","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{id}/delete/responses/404/content/application~1json/examples/Company Not Found"},"paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Contact Not Found":{"value":{"type":"error.list","request_id":"16ac995d-d962-4fe6-8a45-571d40a85932","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact Not Found","summary":"Contact Not Found","id":"paths/~1contacts~1{contact_id}~1companies~1{id}/delete/responses/404/content/application~1json/examples/Contact Not Found"},"paths/~1contacts~1{id}~1notes/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"list","data":[{"type":"note","id":"29","created_at":1716416598,"contact":{"type":"contact","id":"6657aad66abd0164c24b0d0c"},"author":{"type":"admin","id":"991267352","name":"Ciaran110 Lee","email":"admin110@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>This is a note.</p>"},{"type":"note","id":"28","created_at":1716330198,"contact":{"type":"contact","id":"6657aad66abd0164c24b0d0c"},"author":{"type":"admin","id":"991267352","name":"Ciaran110 Lee","email":"admin110@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>This is a note.</p>"},{"type":"note","id":"27","created_at":1716330197,"contact":{"type":"contact","id":"6657aad66abd0164c24b0d0c"},"author":{"type":"admin","id":"991267352","name":"Ciaran110 Lee","email":"admin110@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{id}~1notes/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1contacts~1{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"5c017b27-069c-45ac-8012-4fd96bc575a1","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1notes/get/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response":{"value":{"contact_id":"6657aad76abd0164c24b0d0e","admin_id":991267354,"body":"Hello"},"key":"successful_response","summary":"Successful response","id":"paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/successful_response"},"paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found":{"value":{"contact_id":"6657aad76abd0164c24b0d0f","admin_id":123,"body":"Hello"},"key":"admin_not_found","summary":"Admin not found","id":"paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found":{"value":{"contact_id":123,"admin_id":991267356,"body":"Hello"},"key":"contact_not_found","summary":"Contact not found","id":"paths/~1contacts~1{id}~1notes/post/requestBody/content/application~1json/examples/contact_not_found"},"paths/~1contacts~1{id}~1notes/post/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"note","id":"34","created_at":1717021399,"contact":{"type":"contact","id":"6657aad76abd0164c24b0d0e"},"author":{"type":"admin","id":"991267354","name":"Ciaran112 Lee","email":"admin112@email.com","away_mode_enabled":false,"away_mode_reassign":false},"body":"<p>Hello</p>"},"key":"Successful response","summary":"Successful response","id":"paths/~1contacts~1{id}~1notes/post/responses/200/content/application~1json/examples/Successful response"},"paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"b4f4eb11-8a81-49b9-91db-42e8c1eca575","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Admin not found"},"paths/~1contacts~1{id}~1notes/post/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"385e508f-749b-462b-a1a7-fa63325e488e","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{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":"6657aad96abd0164c24b0d11","name":"segment","created_at":1717021401,"updated_at":1717021401,"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":"35d42f23-43c1-47e0-86ec-66e17a98c904","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":"9451e8b0-0b60-4a3c-8eda-9e644eaec3a0","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":"93","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":"95","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":"917619e6-202c-4837-bc02-24fcfe95e17c","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":"de54f84d-185c-4565-b1f8-4b9a6d8a5b6a","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":108,"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":112,"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":"108","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":"6e57c92f-9224-46d6-9315-38263aff308b","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":"f0eaf097-047e-40a0-bdcf-bc124bffe683","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":"f9e0a206-a1b0-4bc3-a5b2-58925130e490","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{id}/delete/responses/200/content/application~1json/examples/Successful":{"value":{"type":"subscription","id":"124","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{id}/delete/responses/200/content/application~1json/examples/Successful"},"paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"79a857ea-0495-4122-a11c-7e00140bdaf3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"10fb9404-d330-4531-81ca-c04ca4d55947","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"type":"error.list","request_id":"2879d387-dc58-4b94-91e3-e4abbc4ac50d","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1contacts~1{contact_id}~1subscriptions~1{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":"83","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":"889da38c-3715-4edd-829f-c6234c6b61c5","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":"9831ae15-042d-4df0-8709-05712becdc48","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":84},"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":85},"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":"84","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":"e33c99ea-541f-4662-bd11-677745c60510","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":"56dc903d-e3b7-49e9-aeeb-44f658ec1881","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":"bed647c1-2d8b-4fa0-b16e-92184a12ef6f","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{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"87","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"994fceee-e6d2-455f-b5e4-ae7304feec2e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found":{"value":{"type":"error.list","request_id":"f5167a40-7d57-4480-921a-7144ab21e273","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"Contact not found","summary":"Contact not found","id":"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Contact not found"},"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"c0dc7099-cb44-4f33-9efe-e22d24c1a227","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1contacts~1{contact_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found"},"paths/~1contacts~1{id}/put/requestBody/content/application~1json/examples/successful":{"value":{"email":"joebloggs@intercom.io","name":"joe bloggs"},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1{id}/put/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6657aae76abd0164c24b0d28","workspace_id":"this_is_an_id259_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":1717021415,"updated_at":1717021415,"signed_up_at":1717021415,"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/6657aae76abd0164c24b0d28/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6657aae76abd0164c24b0d28/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6657aae76abd0164c24b0d28/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aae76abd0164c24b0d28/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aae76abd0164c24b0d28/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"babb0a78-a81a-4c20-b2b6-b407dfeb6b2d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6657aae86abd0164c24b0d29","workspace_id":"this_is_an_id263_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":1717021416,"updated_at":1717021416,"signed_up_at":1717021416,"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/6657aae86abd0164c24b0d29/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6657aae86abd0164c24b0d29/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6657aae86abd0164c24b0d29/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aae86abd0164c24b0d29/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aae86abd0164c24b0d29/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"4101d4ef-8205-4e5f-b513-479f749c34c9","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"6657aaea6abd0164c24b0d2a","object":"contact","deleted":true},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"13311953-9f38-4984-a63f-83d70dee0110","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful":{"value":{"from":"6657aaeb6abd0164c24b0d2b","into":"6657aaeb6abd0164c24b0d2c"},"key":"successful","summary":"successful","id":"paths/~1contacts~1merge/post/requestBody/content/application~1json/examples/successful"},"paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful":{"value":{"type":"contact","id":"6657aaeb6abd0164c24b0d2c","workspace_id":"this_is_an_id271_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":1717021419,"updated_at":1717021420,"signed_up_at":1717021419,"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/6657aaeb6abd0164c24b0d2c/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6657aaeb6abd0164c24b0d2c/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6657aaeb6abd0164c24b0d2c/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aaeb6abd0164c24b0d2c/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aaeb6abd0164c24b0d2c/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":null},"key":"successful","summary":"successful","id":"paths/~1contacts~1merge/post/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1merge/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8084b6b3-60e7-46b9-96ab-ed0d9ef45e67","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"}]},"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/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"019c15bc-59b6-46e0-a99c-9ff87e13255b","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":"e8bd0d1b-622c-4343-b613-01ba2803cbca","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":"6657aaf06abd0164c24b0d2f","workspace_id":"this_is_an_id283_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":1717021424,"updated_at":1717021424,"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/6657aaf06abd0164c24b0d2f/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6657aaf06abd0164c24b0d2f/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6657aaf06abd0164c24b0d2f/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aaf06abd0164c24b0d2f/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6657aaf06abd0164c24b0d2f/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":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":"555fa590-2a77-4f14-a607-7fb420b1bc8b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1contacts/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1contacts~1{id}~1archive/post/responses/200/content/application~1json/examples/successful":{"value":{"id":"6657aaf26abd0164c24b0d30","object":"contact","archived":true},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}~1archive/post/responses/200/content/application~1json/examples/successful"},"paths/~1contacts~1{id}~1unarchive/post/responses/200/content/application~1json/examples/successful":{"value":{"id":"6657aaf26abd0164c24b0d31","object":"contact","archived":false},"key":"successful","summary":"successful","id":"paths/~1contacts~1{id}~1unarchive/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags/post/requestBody/content/application~1json/examples/successful":{"value":{"id":89,"admin_id":991267387},"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":90,"admin_id":991267389},"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":"89","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":"d610fe70-342b-44fa-9e29-0bcfcaf1865f","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":"1f017fec-9524-406d-9587-8dafdac7b0b2","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{id}/delete/requestBody/content/application~1json/examples/successful":{"value":{"admin_id":991267391},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found":{"value":{"admin_id":991267393},"key":"conversation_not_found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/conversation_not_found"},"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found":{"value":{"admin_id":991267394},"key":"tag_not_found","summary":"Tag not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/requestBody/content/application~1json/examples/tag_not_found"},"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"type":"tag","id":"92","name":"Manual tag","applied_at":1663597223,"applied_by":{"type":"admin","id":"456"}},"key":"successful","summary":"successful","id":"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8591b1dd-51af-4927-a3eb-2f92738d5fe3","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found":{"value":{"type":"error.list","request_id":"196f750c-77c5-458d-95cd-a2eb06eb93c9","errors":[{"code":"not_found","message":"Conversation not found"}]},"key":"Conversation not found","summary":"Conversation not found","id":"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Conversation not found"},"paths/~1conversations~1{conversation_id}~1tags~1{id}/delete/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"7bf65c4c-15a4-42da-9c01-3a7fd9801d41","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{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":"301","created_at":1717021435,"updated_at":1717021435,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918227","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267397","name":"Ciaran152 Lee","email":"admin152@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657aafb6abd0164c24b0d35"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null}]},"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":"de4b1b6d-c724-4b8b-829b-12f7fcb40473","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":"ae58f677-d8b7-4a9d-8686-2418c79b060f","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":"6657ab116abd0164c24b0d4d"},"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":"403918237","created_at":1717021458,"body":"Hello there","message_type":"inapp","conversation_id":"329"},"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":"11e20110-32ad-4b8b-92db-a3430d929f55","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":"f304a890-faa2-4a77-90ad-6a711da1f79a","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":"ffaf1bd9-3b6d-47bc-97ec-644e7739e0b0","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{id}/get/responses/200/content/application~1json/examples/conversation found":{"value":{"type":"conversation","id":"333","created_at":1717021463,"updated_at":1717021463,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918241","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267414","name":"Ciaran162 Lee","email":"admin162@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab176abd0164c24b0d51"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[],"total_count":0}},"key":"conversation found","summary":"conversation found","id":"paths/~1conversations~1{id}/get/responses/200/content/application~1json/examples/conversation found"},"paths/~1conversations~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"9ba8124b-f405-4d50-a274-7c91a0ccd624","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}/get/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"ffffbffd-8a8c-49df-a4c1-74e76782150c","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{id}/get/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"3b602881-22c9-4fd1-86d4-668e2befa292","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/conversation_found":{"value":{"read":true},"key":"conversation_found","summary":"conversation found","id":"paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/conversation_found"},"paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/not_found":{"value":{"read":true},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{id}/put/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{id}/put/responses/200/content/application~1json/examples/conversation found":{"value":{"type":"conversation","id":"337","created_at":1717021469,"updated_at":1717021471,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918245","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267422","name":"Ciaran166 Lee","email":"admin166@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab1d6abd0164c24b0d55"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":true,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"68","part_type":"conversation_attribute_updated_by_admin","body":null,"created_at":1717021471,"updated_at":1717021471,"notified_at":1717021471,"assigned_to":null,"author":{"id":"991267423","type":"bot","name":"Operator","email":"operator+this_is_an_id332_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false},{"type":"conversation_part","id":"69","part_type":"conversation_attribute_updated_by_admin","body":null,"created_at":1717021471,"updated_at":1717021471,"notified_at":1717021471,"assigned_to":null,"author":{"id":"991267423","type":"bot","name":"Operator","email":"operator+this_is_an_id332_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false}],"total_count":2}},"key":"conversation found","summary":"conversation found","id":"paths/~1conversations~1{id}/put/responses/200/content/application~1json/examples/conversation found"},"paths/~1conversations~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"91390a0b-072d-460f-8479-68b449551f18","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}/put/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"550bb111-91b0-4b1a-a0ba-7a0d4d4fe4a5","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{id}/put/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"10e790d1-780d-44c8-8f3d-10ad1e4ada0c","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{id}/put/responses/404/content/application~1json/examples/Not found"},"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":"344","created_at":1717021480,"updated_at":1717021480,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918252","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267452","name":"Ciaran189 Lee","email":"admin189@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab286abd0164c24b0d5c"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null}]},"key":"successful","summary":"successful","id":"paths/~1conversations~1search/post/responses/200/content/application~1json/examples/successful"},"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_reply":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6657ab2f6abd0164c24b0d64","body":"Thanks again :)"},"key":"user_reply","summary":"User reply","id":"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_reply"},"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply":{"value":{"message_type":"note","type":"admin","admin_id":991267457,"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/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"},"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6657ab356abd0164c24b0d67","body":"Thanks again :)"},"key":"user_last_conversation_reply","summary":"User last conversation reply","id":"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/user_last_conversation_reply"},"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/not_found":{"value":{"message_type":"comment","type":"user","intercom_user_id":"6657ab376abd0164c24b0d68","body":"Thanks again :)"},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{id}~1reply/post/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User reply":{"value":{"type":"conversation","id":"353","created_at":1717021487,"updated_at":1717021489,"waiting_since":1717021488,"snoozed_until":null,"source":{"type":"conversation","id":"403918255","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267455","name":"Ciaran191 Lee","email":"admin191@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab2f6abd0164c24b0d64"}]},"first_contact_reply":{"created_at":1717021488,"type":"conversation","url":null},"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"71","part_type":"open","body":"<p>Thanks again :)</p>","created_at":1717021488,"updated_at":1717021488,"notified_at":1717021488,"assigned_to":null,"author":{"id":"6657ab2f6abd0164c24b0d64","type":"user","name":"Joe Bloggs","email":"joe@bloggs.com"},"attachments":[],"external_id":null,"redacted":false},{"type":"conversation_part","id":"72","part_type":"language_detection_details","body":null,"created_at":1717021489,"updated_at":1717021489,"notified_at":1717021489,"assigned_to":null,"author":{"id":"991267456","type":"bot","name":"Operator","email":"operator+this_is_an_id346_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false}],"total_count":2}},"key":"User reply","summary":"User reply","id":"paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User reply"},"paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply":{"value":{"type":"conversation","id":"354","created_at":1717021490,"updated_at":1717021491,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918256","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267457","name":"Ciaran192 Lee","email":"admin192@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab326abd0164c24b0d65"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"73","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":1717021491,"updated_at":1717021491,"notified_at":1717021491,"assigned_to":null,"author":{"id":"991267457","type":"admin","name":"Ciaran192 Lee","email":"admin192@email.com"},"attachments":[],"external_id":null,"redacted":false}],"total_count":1}},"key":"Admin note reply","summary":"Admin note reply","id":"paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"},"paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply":{"value":{"type":"conversation","id":"356","created_at":1717021493,"updated_at":1717021494,"waiting_since":1717021494,"snoozed_until":null,"source":{"type":"conversation","id":"403918258","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267461","name":"Ciaran194 Lee","email":"admin194@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab356abd0164c24b0d67"}]},"first_contact_reply":{"created_at":1717021494,"type":"conversation","url":null},"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"74","part_type":"open","body":"<p>Thanks again :)</p>","created_at":1717021494,"updated_at":1717021494,"notified_at":1717021494,"assigned_to":null,"author":{"id":"6657ab356abd0164c24b0d67","type":"user","name":"Joe Bloggs","email":"joe@bloggs.com"},"attachments":[],"external_id":null,"redacted":false},{"type":"conversation_part","id":"75","part_type":"language_detection_details","body":null,"created_at":1717021494,"updated_at":1717021494,"notified_at":1717021494,"assigned_to":null,"author":{"id":"991267462","type":"bot","name":"Operator","email":"operator+this_is_an_id352_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false}],"total_count":2}},"key":"User last conversation reply","summary":"User last conversation reply","id":"paths/~1conversations~1{id}~1reply/post/responses/200/content/application~1json/examples/User last conversation reply"},"paths/~1conversations~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b7b53b82-b194-4cca-ae16-e96b5f026b32","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"14779f4f-31d1-46cc-a4fa-7d799bdcbef6","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{id}~1reply/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{id}~1reply/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"89de1a37-4535-4bd5-84d8-8ce890d12fa5","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{id}~1reply/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation":{"value":{"message_type":"close","type":"admin","admin_id":991267469,"body":"Goodbye :)"},"key":"close_a_conversation","summary":"Close a conversation","id":"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/close_a_conversation"},"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation":{"value":{"message_type":"snoozed","admin_id":991267471,"snoozed_until":1717025103},"key":"snooze_a_conversation","summary":"Snooze a conversation","id":"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/snooze_a_conversation"},"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation":{"value":{"message_type":"open","admin_id":991267473},"key":"open_a_conversation","summary":"Open a conversation","id":"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/open_a_conversation"},"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation":{"value":{"message_type":"assignment","type":"admin","admin_id":991267476,"assignee_id":991267476},"key":"assign_a_conversation","summary":"Assign a conversation","id":"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/assign_a_conversation"},"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/not_found":{"value":{"message_type":"close","type":"admin","admin_id":991267478,"body":"Goodbye :)"},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{id}~1parts/post/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation":{"value":{"type":"conversation","id":"360","created_at":1717021500,"updated_at":1717021501,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918262","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267469","name":"Ciaran198 Lee","email":"admin198@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab3c6abd0164c24b0d6b"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"76","part_type":"close","body":"<p>Goodbye :)</p>","created_at":1717021501,"updated_at":1717021501,"notified_at":1717021501,"assigned_to":null,"author":{"id":"991267469","type":"admin","name":"Ciaran198 Lee","email":"admin198@email.com"},"attachments":[],"external_id":null,"redacted":false}],"total_count":1}},"key":"Close a conversation","summary":"Close a conversation","id":"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Close a conversation"},"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation":{"value":{"type":"conversation","id":"361","created_at":1717021502,"updated_at":1717021503,"waiting_since":null,"snoozed_until":1717025103,"source":{"type":"conversation","id":"403918263","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267471","name":"Ciaran199 Lee","email":"admin199@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab3e6abd0164c24b0d6c"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"snoozed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"77","part_type":"snoozed","body":null,"created_at":1717021503,"updated_at":1717021503,"notified_at":1717021503,"assigned_to":null,"author":{"id":"991267471","type":"admin","name":"Ciaran199 Lee","email":"admin199@email.com"},"attachments":[],"external_id":null,"redacted":false}],"total_count":1}},"key":"Snooze a conversation","summary":"Snooze a conversation","id":"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Snooze a conversation"},"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation":{"value":{"type":"conversation","id":"366","created_at":1717021502,"updated_at":1717021512,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918264","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267473","name":"Ciaran200 Lee","email":"admin200@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab426abd0164c24b0d71"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":true,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":"","topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"79","part_type":"open","body":null,"created_at":1717021512,"updated_at":1717021512,"notified_at":1717021512,"assigned_to":null,"author":{"id":"991267473","type":"admin","name":"Ciaran200 Lee","email":"admin200@email.com"},"attachments":[],"external_id":null,"redacted":false}],"total_count":1}},"key":"Open a conversation","summary":"Open a conversation","id":"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Open a conversation"},"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation":{"value":{"type":"conversation","id":"371","created_at":1717021513,"updated_at":1717021514,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918267","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267476","name":"Ciaran202 Lee","email":"admin202@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab496abd0164c24b0d75"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"80","part_type":"assign_and_reopen","body":null,"created_at":1717021514,"updated_at":1717021514,"notified_at":1717021514,"assigned_to":{"type":"admin","id":"991267476"},"author":{"id":"991267476","type":"admin","name":"Ciaran202 Lee","email":"admin202@email.com"},"attachments":[],"external_id":null,"redacted":false}],"total_count":1}},"key":"Assign a conversation","summary":"Assign a conversation","id":"paths/~1conversations~1{id}~1parts/post/responses/200/content/application~1json/examples/Assign a conversation"},"paths/~1conversations~1{id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"09df82cc-f148-4e0a-aceb-de32ffccc17a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}~1parts/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"8e3d0d18-8021-46c4-a041-2dc3993810ee","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{id}~1parts/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{id}~1parts/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"69371e02-f296-471e-a494-1a532b5a1aa2","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{id}~1parts/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/200/content/application~1json/examples/Assign a conversation using assignment rules":{"value":{"type":"conversation","id":"375","created_at":1717021520,"updated_at":1717021521,"waiting_since":null,"snoozed_until":null,"source":{"type":"conversation","id":"403918271","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267484","name":"Ciaran206 Lee","email":"admin206@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab4f6abd0164c24b0d79"}]},"first_contact_reply":null,"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":false,"state":"closed","read":false,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"81","part_type":"default_assignment","body":null,"created_at":1717021521,"updated_at":1717021521,"notified_at":1717021521,"assigned_to":{"type":"nobody_admin","id":null},"author":{"id":"991267485","type":"bot","name":"Operator","email":"operator+this_is_an_id375_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false}],"total_count":1}},"key":"Assign a conversation using assignment rules","summary":"Assign a conversation using assignment rules","id":"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/200/content/application~1json/examples/Assign a conversation using assignment rules"},"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"469fd3bb-93cc-440a-92dc-a13b1677d376","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"5315a8cb-df46-4bb3-90ec-143d787edda3","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"57b08a56-d3a2-4b62-9c10-7779a72d3b40","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{id}~1run_assignment_rules/post/responses/404/content/application~1json/examples/Not found"},"paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation":{"value":{"admin_id":991267492,"customer":{"intercom_user_id":"6657ab566abd0164c24b0d7d"}},"key":"attach_a_contact_to_a_conversation","summary":"Attach a contact to a conversation","id":"paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/attach_a_contact_to_a_conversation"},"paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/not_found":{"value":{"admin_id":991267494,"customer":{"intercom_user_id":"6657ab576abd0164c24b0d7e"}},"key":"not_found","summary":"Not found","id":"paths/~1conversations~1{id}~1customers/post/requestBody/content/application~1json/examples/not_found"},"paths/~1conversations~1{id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation":{"value":{"customers":[{"type":"user","id":"6657ab566abd0164c24b0d7d"}]},"key":"Attach a contact to a conversation","summary":"Attach a contact to a conversation","id":"paths/~1conversations~1{id}~1customers/post/responses/200/content/application~1json/examples/Attach a contact to a conversation"},"paths/~1conversations~1{id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1c005bf9-c6f0-4fc1-b352-53e84c675cc5","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1conversations~1{id}~1customers/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1conversations~1{id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted":{"value":{"type":"error.list","request_id":"717510bb-f9b8-4237-a89d-41bccf8dca5c","errors":[{"code":"api_plan_restricted","message":"Active subscription needed."}]},"key":"API plan restricted","summary":"API plan restricted","id":"paths/~1conversations~1{id}~1customers/post/responses/403/content/application~1json/examples/API plan restricted"},"paths/~1conversations~1{id}~1customers/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"error.list","request_id":"d203f7a5-6175-4a1a-9c64-cc807288bcda","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Not found","summary":"Not found","id":"paths/~1conversations~1{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":991267500,"customer":{"intercom_user_id":"6657ab5c6abd0164c24b0d81"}},"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":991267503,"customer":{"intercom_user_id":"6657ab656abd0164c24b0d8a"}},"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":991267506,"customer":{"intercom_user_id":"6657ab6c6abd0164c24b0d92"}},"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":991267509,"customer":{"intercom_user_id":"6657ab736abd0164c24b0d9a"}},"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":"6657ab636abd0164c24b0d89"}]},"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":"f4ac4049-1de5-4587-ae47-42149bab024a","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":"6c084c7f-9ff4-47d9-94ce-f7241256d119","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":"52dc69da-3bbd-486a-b932-adf6bcd9bfce","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":"08be5e8d-4a8d-4bdc-9352-5044268a97a8","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":"e1e0f127-bd7e-4d98-923e-792ceaca8575","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~1redact/post/requestBody/content/application~1json/examples/redact_a_conversation_part":{"value":{"type":"conversation_part","conversation_id":437,"conversation_part_id":89},"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":"437","created_at":1717021579,"updated_at":1717021582,"waiting_since":1717021580,"snoozed_until":null,"source":{"type":"conversation","id":"403918297","delivered_as":"admin_initiated","subject":"","body":"<p>this is the message body</p>","author":{"type":"admin","id":"991267518","name":"Ciaran226 Lee","email":"admin226@email.com"},"attachments":[],"url":null,"redacted":false},"contacts":{"type":"contact.list","contacts":[{"type":"contact","id":"6657ab8b6abd0164c24b0db2"}]},"first_contact_reply":{"created_at":1717021580,"type":"conversation","url":null},"admin_assignee_id":991267715,"team_assignee_id":5017691,"open":true,"state":"open","read":true,"tags":{"type":"tag.list","tags":[]},"priority":"not_priority","sla_applied":null,"statistics":null,"conversation_rating":null,"teammates":null,"title":null,"topics":{},"ticket":null,"conversation_parts":{"type":"conversation_part.list","conversation_parts":[{"type":"conversation_part","id":"89","part_type":"open","body":"<p><i>This message was deleted</i></p>","created_at":1717021580,"updated_at":1717021582,"notified_at":1717021580,"assigned_to":null,"author":{"id":"6657ab8b6abd0164c24b0db2","type":"user","name":"Joe Bloggs","email":"joe@bloggs.com"},"attachments":[],"external_id":null,"redacted":true},{"type":"conversation_part","id":"90","part_type":"language_detection_details","body":null,"created_at":1717021580,"updated_at":1717021580,"notified_at":1717021580,"assigned_to":null,"author":{"id":"991267519","type":"bot","name":"Operator","email":"operator+this_is_an_id409_that_should_be_at_least_@intercom.io"},"attachments":[],"external_id":null,"redacted":false}],"total_count":2}},"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":"892510d5-1003-4dae-ae3a-16f032ce47ed","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":"4bfb74f7-a3f1-491f-bed8-6d1f7a9231cc","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/~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":"991267543","created_at":1717021596,"updated_at":1717021596,"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":"347e1bef-2b93-48e7-994f-2d84b5754cca","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/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":true,"custom":true,"archived":false,"admin_id":"991267545","created_at":1717021597,"updated_at":1717021597,"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":"cc7918cc-666a-4e83-b82c-0bf0c8a71376","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":"a482b171-5581-4f05-a8b4-71a9aca2246d","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":"82f80d44-20a6-45bb-a69c-abb1eeaab5ff","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":"48e4900b-b047-4064-a060-d19d936986f2","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":"9671eab5-6cb1-47ea-bef6-9877d24aa8be","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":"5b7162e1-b827-4c54-9299-1923661ab15a","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{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{id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1data_attributes~1{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{id}/put/requestBody/content/application~1json/examples/too_few_options_in_list"},"paths/~1data_attributes~1{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{id}/put/requestBody/content/application~1json/examples/attribute_not_found"},"paths/~1data_attributes~1{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{id}/put/requestBody/content/application~1json/examples/has_dependant_object"},"paths/~1data_attributes~1{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":"991267552","created_at":1717021600,"updated_at":1717021601,"model":"company"},"key":"Successful","summary":"Successful","id":"paths/~1data_attributes~1{id}/put/responses/200/content/application~1json/examples/Successful"},"paths/~1data_attributes~1{id}/put/responses/400/content/application~1json/examples/Too few options in list":{"value":{"type":"error.list","request_id":"3f2e9798-2691-4757-8ddd-990cd23b1ee4","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{id}/put/responses/400/content/application~1json/examples/Too few options in list"},"paths/~1data_attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"3f503566-39bd-4e10-a030-dc0bf2a305cb","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1data_attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1data_attributes~1{id}/put/responses/404/content/application~1json/examples/Attribute Not Found":{"value":{"type":"error.list","request_id":"364ec895-b362-42d0-96c8-f3ad314a25a6","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{id}/put/responses/404/content/application~1json/examples/Attribute Not Found"},"paths/~1data_attributes~1{id}/put/responses/422/content/application~1json/examples/Has Dependant Object":{"value":{"type":"error.list","request_id":"0ae09d21-a5ec-4cea-a56f-d22d4423112e","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{id}/put/responses/422/content/application~1json/examples/Has Dependant Object"},"paths/~1events/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5ebeb1a3-2867-48c4-8122-4ab53e63a6b7","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":"6657aba56abd0164c24b0dbb","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":"80fcaff4-e81a-4155-82de-3130830c6f2c","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":"6721c78e-3aaf-4da1-8fb5-ff546b6560c2","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":1717003608,"created_at_before":1717021608},"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":"m3489fdme82zmm0j","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":"nhhv3bazoxu29hxd","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":"63tf5lz9hk0ean3z","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/~1help_center~1collections/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"id":"161","workspace_id":"this_is_an_id63_that_should_be_at_least_4","name":"English collection title","url":"http://help-center.test/myapp-63/collection-17","order":17,"created_at":1717021353,"updated_at":1717021353,"description":"english collection description","icon":"bookmark","help_center_id":89,"type":"collection"}],"total_count":1,"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":"26131e21-0b21-495d-8931-162525858184","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":"167","workspace_id":"this_is_an_id67_that_should_be_at_least_4","name":"Thanks for everything","url":"http://help-center.test/myapp-67/","order":1,"created_at":1717021354,"updated_at":1717021354,"description":"","icon":"book-bookmark","help_center_id":91,"type":"collection"},"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":"7ad38384-798f-4780-a4e7-98e6e52ca290","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":"834f5ddd-4c83-457a-848f-054e4bd86eae","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{id}/get/responses/200/content/application~1json/examples/Collection found":{"value":{"id":"172","workspace_id":"this_is_an_id73_that_should_be_at_least_4","name":"English collection title","url":"http://help-center.test/myapp-73/collection-22","order":22,"created_at":1717021355,"updated_at":1717021355,"description":"english collection description","icon":"bookmark","help_center_id":94,"type":"collection"},"key":"Collection found","summary":"Collection found","id":"paths/~1help_center~1collections~1{id}/get/responses/200/content/application~1json/examples/Collection found"},"paths/~1help_center~1collections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f4bd9fb5-b105-4f16-971a-7f0ba29023f1","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{id}/get/responses/404/content/application~1json/examples/Collection not found":{"value":{"type":"error.list","request_id":"c5a684d9-dde7-426d-b220-e624931cc6df","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Collection not found","summary":"Collection not found","id":"paths/~1help_center~1collections~1{id}/get/responses/404/content/application~1json/examples/Collection not found"},"paths/~1help_center~1collections~1{id}/put/requestBody/content/application~1json/examples/successful":{"value":{"name":"Update collection name"},"key":"successful","summary":"successful","id":"paths/~1help_center~1collections~1{id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1help_center~1collections~1{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{id}/put/requestBody/content/application~1json/examples/collection_not_found"},"paths/~1help_center~1collections~1{id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"178","workspace_id":"this_is_an_id79_that_should_be_at_least_4","name":"Update collection name","url":"http://help-center.test/myapp-79/collection-25","order":25,"created_at":1717021357,"updated_at":1717021357,"description":"english collection description","icon":"folder","help_center_id":97,"type":"collection"},"key":"successful","summary":"successful","id":"paths/~1help_center~1collections~1{id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1help_center~1collections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"7ba596ad-8e27-4dbc-8c3d-4982d3c8b988","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{id}/put/responses/404/content/application~1json/examples/Collection Not Found":{"value":{"type":"error.list","request_id":"63095699-29bc-4fd8-bb65-0de9b8e547a1","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Collection Not Found","summary":"Collection Not Found","id":"paths/~1help_center~1collections~1{id}/put/responses/404/content/application~1json/examples/Collection Not Found"},"paths/~1help_center~1collections~1{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"184","object":"collection","deleted":true},"key":"successful","summary":"successful","id":"paths/~1help_center~1collections~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1help_center~1collections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"0c63c1fa-7eef-47e7-a49c-cff4bb859cb2","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1collections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1collections~1{id}/delete/responses/404/content/application~1json/examples/collection Not Found":{"value":{"type":"error.list","request_id":"4d55ff13-21ee-4dae-835a-dca073c727e6","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"collection Not Found","summary":"collection Not Found","id":"paths/~1help_center~1collections~1{id}/delete/responses/404/content/application~1json/examples/collection Not Found"},"paths/~1help_center~1help_centers~1{id}/get/responses/200/content/application~1json/examples/Collection found":{"value":{"id":"103","workspace_id":"this_is_an_id91_that_should_be_at_least_4","created_at":1717021361,"updated_at":1717021361,"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{id}/get/responses/200/content/application~1json/examples/Collection found"},"paths/~1help_center~1help_centers~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ba42a13b-92b4-4322-8c13-10ed6ffd493e","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1help_centers~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1help_centers~1{id}/get/responses/404/content/application~1json/examples/Collection not found":{"value":{"type":"error.list","request_id":"19d9dda0-1643-4a16-8b4e-e1690ef5d27c","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Collection not found","summary":"Collection not found","id":"paths/~1help_center~1help_centers~1{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":"8f33a54a-8db1-43c2-9a80-59e0e6779333","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/~1help_center~1sections/get/responses/200/content/application~1json/examples/Successful":{"value":{"type":"list","data":[{"id":"191","workspace_id":"this_is_an_id101_that_should_be_at_least_","name":"English section title","url":"http://help-center.test/myapp-101/section-15","order":15,"created_at":1717021363,"updated_at":1717021363,"type":"section","parent_id":190}],"total_count":1,"pages":{"type":"pages","page":1,"per_page":20,"total_pages":1}},"key":"Successful","summary":"Successful","id":"paths/~1help_center~1sections/get/responses/200/content/application~1json/examples/Successful"},"paths/~1help_center~1sections/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"cf47bffc-9759-4792-8556-a25fbe66ed45","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1sections/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created":{"value":{"name":"Thanks for everything","parent_id":194},"key":"section_created","summary":"section created","id":"paths/~1help_center~1sections/post/requestBody/content/application~1json/examples/section_created"},"paths/~1help_center~1sections/post/responses/200/content/application~1json/examples/section created":{"value":{"id":"196","workspace_id":"this_is_an_id105_that_should_be_at_least_","name":"Thanks for everything","url":"http://help-center.test/myapp-105/","order":1,"created_at":1717021364,"updated_at":1717021364,"type":"section","parent_id":"194"},"key":"section created","summary":"section created","id":"paths/~1help_center~1sections/post/responses/200/content/application~1json/examples/section created"},"paths/~1help_center~1sections/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"3053d544-e1a1-4fd8-9662-0f74ff782f14","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1sections/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1sections~1{id}/get/responses/200/content/application~1json/examples/Section found":{"value":{"id":"200","workspace_id":"this_is_an_id109_that_should_be_at_least_","name":"English section title","url":"http://help-center.test/myapp-109/section-19","order":19,"created_at":1717021365,"updated_at":1717021365,"type":"section","parent_id":199},"key":"Section found","summary":"Section found","id":"paths/~1help_center~1sections~1{id}/get/responses/200/content/application~1json/examples/Section found"},"paths/~1help_center~1sections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"ddd1b999-84bc-414b-8e83-d47e3fb1660a","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1sections~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1sections~1{id}/get/responses/404/content/application~1json/examples/Section not found":{"value":{"type":"error.list","request_id":"6fccbab7-24fa-4eed-8686-c241d4bbdb86","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Section not found","summary":"Section not found","id":"paths/~1help_center~1sections~1{id}/get/responses/404/content/application~1json/examples/Section not found"},"paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful":{"value":{"name":"Update section name","parent_id":205},"key":"successful","summary":"successful","id":"paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_not_found":{"value":{"name":"Update section name","parent_id":207},"key":"section_not_found","summary":"Section Not Found","id":"paths/~1help_center~1sections~1{id}/put/requestBody/content/application~1json/examples/section_not_found"},"paths/~1help_center~1sections~1{id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"206","workspace_id":"this_is_an_id115_that_should_be_at_least_","name":"Update section name","url":"http://help-center.test/myapp-115/section-22","order":22,"created_at":1717021366,"updated_at":1717021367,"type":"section","parent_id":"205"},"key":"successful","summary":"successful","id":"paths/~1help_center~1sections~1{id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1help_center~1sections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"1c08c7df-d5a9-4227-aba7-d252280baaaa","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1sections~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1sections~1{id}/put/responses/404/content/application~1json/examples/Section Not Found":{"value":{"type":"error.list","request_id":"70d7d473-e3d1-4630-b310-3e7a327e9a74","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Section Not Found","summary":"Section Not Found","id":"paths/~1help_center~1sections~1{id}/put/responses/404/content/application~1json/examples/Section Not Found"},"paths/~1help_center~1sections~1{id}/delete/responses/200/content/application~1json/examples/successful":{"value":{"id":"212","object":"section","deleted":true},"key":"successful","summary":"successful","id":"paths/~1help_center~1sections~1{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1help_center~1sections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f48d51c1-cebd-4805-9268-4a8c8459cc4f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1help_center~1sections~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1help_center~1sections~1{id}/delete/responses/404/content/application~1json/examples/section Not Found":{"value":{"type":"error.list","request_id":"d2b2e713-177e-43e9-9e07-51ba367845c9","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"section Not Found","summary":"section Not Found","id":"paths/~1help_center~1sections~1{id}/delete/responses/404/content/application~1json/examples/section Not Found"},"paths/~1messages/post/requestBody/content/application~1json/examples/user_message_created":{"value":{"from":{"type":"user","id":"6657abab6abd0164c24b0dc0"},"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":"6657abac6abd0164c24b0dc1"},"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":"991267575"},"to":{"type":"user","id":"6657abad6abd0164c24b0dc2"},"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/no_body_supplied_for_message":{"value":{"from":{"type":"admin","id":"991267577"},"to":{"type":"user","id":"6657abaf6abd0164c24b0dc3"},"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":"991267578"},"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":"991267579"},"to":{"type":"user","id":"6657abb06abd0164c24b0dc5"},"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":"403918302","created_at":1717021611,"body":"heyy","message_type":"inapp","conversation_id":"442"},"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":"403918303","created_at":1717021612,"body":"heyy","message_type":"inapp","conversation_id":"443"},"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":"15","created_at":1717021614,"subject":"heyy","body":"heyy","message_type":"inapp","owner":{"type":"admin","id":"991267575","name":"Ciaran276 Lee","email":"admin276@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":"049f5096-216f-467e-8fd0-2331ac74a002","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":"26b582f5-81ba-4f2a-a533-fbce3944c563","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":"24f9aaf3-e8a7-40cd-b439-0841baa44805","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":"4b08a866-f009-468a-893a-865e7d8ced74","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":"29713c7a-484b-499e-8c50-1e39d999b495","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/~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":"30","type":"news-item","workspace_id":"this_is_an_id503_that_should_be_at_least_","title":"We have news","body":"<p>Hello there,</p>","sender_id":991267586,"state":"draft","labels":[],"cover_image_url":null,"reactions":[null,null,null,null],"deliver_silently":false,"created_at":1717021618,"updated_at":1717021618,"newsfeed_assignments":[]},{"id":"29","type":"news-item","workspace_id":"this_is_an_id503_that_should_be_at_least_","title":"We have news","body":"<p>Hello there,</p>","sender_id":991267584,"state":"draft","labels":[],"cover_image_url":null,"reactions":[null,null,null,null],"deliver_silently":false,"created_at":1717021617,"updated_at":1717021617,"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":"8a9a7c2e-15b7-4dba-a3c7-1aa75decb59e","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":991267593,"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_id507_that_should_be_at_least_","title":"Halloween is here!","body":"<p>New costumes in store for this spooky season</p>","sender_id":991267593,"state":"live","labels":["New","Product","Update"],"cover_image_url":null,"reactions":["😆","😅"],"deliver_silently":true,"created_at":1717021620,"updated_at":1717021620,"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":"d8bfbb7c-b0b6-405a-8bbd-5422697e1dc1","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{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"34","type":"news-item","workspace_id":"this_is_an_id511_that_should_be_at_least_","title":"We have news","body":"<p>Hello there,</p>","sender_id":991267596,"state":"live","labels":[],"cover_image_url":null,"reactions":[null,null,null,null],"deliver_silently":false,"created_at":1717021621,"updated_at":1717021621,"newsfeed_assignments":[{"newsfeed_id":55,"published_at":1717021621}]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"e67ea708-23ce-417d-b8d0-5f0feadcf33c","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items~1{id}/get/responses/404/content/application~1json/examples/News Item Not Found":{"value":{"type":"error.list","request_id":"f4423d98-b41c-42f7-ba88-79d792097cf8","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"News Item Not Found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{id}/get/responses/404/content/application~1json/examples/News Item Not Found"},"paths/~1news~1news_items~1{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":991267604,"reactions":["😝","😂"]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{id}/put/requestBody/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{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":991267607,"reactions":["😝","😂"]},"key":"news_item_not_found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{id}/put/requestBody/content/application~1json/examples/news_item_not_found"},"paths/~1news~1news_items~1{id}/put/responses/200/content/application~1json/examples/successful":{"value":{"id":"37","type":"news-item","workspace_id":"this_is_an_id517_that_should_be_at_least_","title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>","sender_id":991267604,"state":"live","labels":[],"cover_image_url":null,"reactions":["😝","😂"],"deliver_silently":false,"created_at":1717021623,"updated_at":1717021624,"newsfeed_assignments":[]},"key":"successful","summary":"successful","id":"paths/~1news~1news_items~1{id}/put/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"403da25a-8045-4987-9a34-b3347a02c8b0","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items~1{id}/put/responses/404/content/application~1json/examples/News Item Not Found":{"value":{"type":"error.list","request_id":"500997db-736a-473c-a8be-58a7a89b89d5","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"News Item Not Found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{id}/put/responses/404/content/application~1json/examples/News Item Not Found"},"paths/~1news~1news_items~1{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{id}/delete/responses/200/content/application~1json/examples/successful"},"paths/~1news~1news_items~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"f990d4f8-43c3-4719-9560-ee30422462ce","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1news_items~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1news~1news_items~1{id}/delete/responses/404/content/application~1json/examples/News Item Not Found":{"value":{"type":"error.list","request_id":"7a923ed2-c82a-45b5-b859-ac8d35bedecc","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"News Item Not Found","summary":"News Item Not Found","id":"paths/~1news~1news_items~1{id}/delete/responses/404/content/application~1json/examples/News Item Not Found"},"paths/~1news~1newsfeeds~1{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{id}~1items/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1newsfeeds~1{id}~1items/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"a9bb7a8c-ce91-4197-9732-b0d68678ea42","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1newsfeeds~1{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":1717021629,"updated_at":1717021629},{"id":"69","type":"newsfeed","name":"Visitor Feed","created_at":1717021629,"updated_at":1717021629}],"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":"98f77a2e-a0fa-461a-9ca7-b388f1dea32c","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{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"id":"72","type":"newsfeed","name":"Visitor Feed","created_at":1717021630,"updated_at":1717021630},"key":"successful","summary":"successful","id":"paths/~1news~1newsfeeds~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1news~1newsfeeds~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b3ac2f76-21d8-444c-80d3-4d28ad72da7f","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1news~1newsfeeds~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1notes~1{id}/get/responses/200/content/application~1json/examples/Note found":{"value":{"type":"note","id":"37","created_at":1716330431,"contact":{"type":"contact","id":"6657abbf6abd0164c24b0dc8"},"author":{"type":"admin","id":"991267623","name":"Ciaran323 Lee","email":"admin323@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{id}/get/responses/200/content/application~1json/examples/Note found"},"paths/~1notes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"6ae7fce4-8d40-4c5f-b4dd-d88f1faae666","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1notes~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1notes~1{id}/get/responses/404/content/application~1json/examples/Note not found":{"value":{"type":"error.list","request_id":"011cacd4-8b6a-47d2-8c62-d53840407296","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Note not found","summary":"Note not found","id":"paths/~1notes~1{id}/get/responses/404/content/application~1json/examples/Note not found"},"paths/~1segments/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"segment.list","segments":[{"type":"segment","id":"6657abc16abd0164c24b0dcb","name":"John segment","created_at":1717021633,"updated_at":1717021633,"person_type":"user"},{"type":"segment","id":"6657abc16abd0164c24b0dcc","name":"Jane segment","created_at":1717021633,"updated_at":1717021633,"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":"8f262c81-9866-4bc9-a311-7f0d5626063d","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{id}/get/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"segment","id":"6657abc26abd0164c24b0dcf","name":"John segment","created_at":1717021634,"updated_at":1717021634,"person_type":"user"},"key":"Successful response","summary":"Successful response","id":"paths/~1segments~1{id}/get/responses/200/content/application~1json/examples/Successful response"},"paths/~1segments~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"2a342688-3235-4ff6-b05b-d22fe703b554","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1segments~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1segments~1{id}/get/responses/404/content/application~1json/examples/Segment not found":{"value":{"type":"error.list","request_id":"1031750e-cb16-44a9-acae-3fdefacf973c","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Segment not found","summary":"Segment not found","id":"paths/~1segments~1{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":"137","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":"387640aa-d3cb-40c0-b8b7-ed3d52a57f17","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/12b27d11-b981-41a9-a922-886b54bf93b7","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":"67b6c667-7107-406f-9d87-ff6116dca52b","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":"105","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":"3c4758e2-e787-4f70-9fdf-d56ee7d3d830","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":"108","name":"test"},"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":"e25d8bd7-817a-4171-b5f3-9fad4c76cf00","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":"bae6bbdb-8eb5-4ee5-8db9-141bb17bd32b","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags/post/responses/404/content/application~1json/examples/Company not found":{"value":{"type":"error.list","request_id":"a9716d1d-378f-4f9f-b86a-88b3a0237d99","errors":[{"code":"company_not_found","message":"Company Not Found"}]},"key":"Company not found","summary":"Company not found","id":"paths/~1tags/post/responses/404/content/application~1json/examples/Company not found"},"paths/~1tags/post/responses/404/content/application~1json/examples/User  not found":{"value":{"type":"error.list","request_id":"a7430819-e714-4464-b909-efee0a364a27","errors":[{"code":"not_found","message":"User Not Found"}]},"key":"User  not found","summary":"User  not found","id":"paths/~1tags/post/responses/404/content/application~1json/examples/User  not found"},"paths/~1tags~1{id}/get/responses/200/content/application~1json/examples/Tag found":{"value":{"type":"tag","id":"116","name":"Manual tag"},"key":"Tag found","summary":"Tag found","id":"paths/~1tags~1{id}/get/responses/200/content/application~1json/examples/Tag found"},"paths/~1tags~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"6fbffa27-6ff2-4eac-9595-3eaff5d9e998","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags~1{id}/get/responses/404/content/application~1json/examples/Tag not found":{"value":{"type":"error.list","request_id":"c19e3e7f-3095-4e68-9d6e-015abdff20e5","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Tag not found","summary":"Tag not found","id":"paths/~1tags~1{id}/get/responses/404/content/application~1json/examples/Tag not found"},"paths/~1tags~1{id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects":{"value":{"type":"error.list","request_id":"f8f3114a-ce4b-48b5-a43a-adfd8eb25a53","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{id}/delete/responses/400/content/application~1json/examples/Tag has dependent objects"},"paths/~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"283deaf2-c25c-49c7-a076-db7fa2b60201","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tags~1{id}/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tags~1{id}/delete/responses/404/content/application~1json/examples/Resource not found":{"value":{"type":"error.list","request_id":"6c9d0394-0a09-46ba-8ba5-b78b8c7e1e82","errors":[{"code":"not_found","message":"Resource Not Found"}]},"key":"Resource not found","summary":"Resource not found","id":"paths/~1tags~1{id}/delete/responses/404/content/application~1json/examples/Resource 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":"f4b16541-5c75-45d1-887c-b9cf7ca35de7","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{id}/get/responses/200/content/application~1json/examples/successful":{"value":{"type":"team","id":"991267661","name":"team 1","admin_ids":[]},"key":"successful","summary":"successful","id":"paths/~1teams~1{id}/get/responses/200/content/application~1json/examples/successful"},"paths/~1teams~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"5e20abcf-e0f9-4ba3-aab2-f966923ecf21","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1teams~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1teams~1{id}/get/responses/404/content/application~1json/examples/Team not found":{"value":{"type":"error.list","request_id":"1afb669d-00be-48c8-afcf-ae3a2ab35c39","errors":[{"code":"team_not_found","message":"Team not found"}]},"key":"Team not found","summary":"Team not found","id":"paths/~1teams~1{id}/get/responses/404/content/application~1json/examples/Team not found"},"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":"163","workspace_id":"this_is_an_id609_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":51,"archived":false,"created_at":1717021654,"updated_at":1717021654},"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":"094e1e29-ba56-453f-8faa-5008558e1aab","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{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{id}/put/requestBody/content/application~1json/examples/ticket_type_attribute_updated"},"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated":{"value":{"type":"ticket_type_attribute","id":"168","workspace_id":"this_is_an_id613_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":53,"archived":false,"created_at":1717021655,"updated_at":1717021656},"key":"Ticket Type Attribute updated","summary":"Ticket Type Attribute updated","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{id}/put/responses/200/content/application~1json/examples/Ticket Type Attribute updated"},"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"bc5574be-db90-4757-bff5-a8829af8dd0d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{ticket_type_id}~1attributes~1{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":"55","name":"Bug Report","description":"Bug Report Template","icon":"🎟️","workspace_id":"this_is_an_id617_that_should_be_at_least_","archived":false,"created_at":1717021657,"updated_at":1717021657,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"171","workspace_id":"this_is_an_id617_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":55,"archived":false,"created_at":1717021657,"updated_at":1717021657},{"type":"ticket_type_attribute","id":"173","workspace_id":"this_is_an_id617_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":55,"archived":false,"created_at":1717021657,"updated_at":1717021657},{"type":"ticket_type_attribute","id":"172","workspace_id":"this_is_an_id617_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":55,"archived":false,"created_at":1717021657,"updated_at":1717021657}]}}]},"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":"a09f28f1-0b27-4977-a34f-0ac84850a9af","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":"🎟️"},"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":"58","name":"Customer Issue","description":"Customer Report Template","icon":"🎟️","workspace_id":"this_is_an_id621_that_should_be_at_least_","archived":false,"created_at":1717021658,"updated_at":1717021658,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"180","workspace_id":"this_is_an_id621_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":58,"archived":false,"created_at":1717021658,"updated_at":1717021658},{"type":"ticket_type_attribute","id":"181","workspace_id":"this_is_an_id621_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":58,"archived":false,"created_at":1717021658,"updated_at":1717021658}]}},"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":"078d21f5-f247-4178-adf1-4dc7e3640249","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{id}/get/responses/200/content/application~1json/examples/Ticket type found":{"value":{"type":"ticket_type","id":"60","name":"Bug Report","description":"Bug Report Template","icon":"🎟️","workspace_id":"this_is_an_id625_that_should_be_at_least_","archived":false,"created_at":1717021659,"updated_at":1717021659,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"185","workspace_id":"this_is_an_id625_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":60,"archived":false,"created_at":1717021659,"updated_at":1717021659},{"type":"ticket_type_attribute","id":"187","workspace_id":"this_is_an_id625_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":60,"archived":false,"created_at":1717021659,"updated_at":1717021659},{"type":"ticket_type_attribute","id":"186","workspace_id":"this_is_an_id625_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":60,"archived":false,"created_at":1717021659,"updated_at":1717021659}]}},"key":"Ticket type found","summary":"Ticket type found","id":"paths/~1ticket_types~1{id}/get/responses/200/content/application~1json/examples/Ticket type found"},"paths/~1ticket_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"06b9904b-f065-400b-9641-186e64864045","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1ticket_types~1{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{id}/put/requestBody/content/application~1json/examples/ticket_type_updated"},"paths/~1ticket_types~1{id}/put/responses/200/content/application~1json/examples/Ticket type updated":{"value":{"type":"ticket_type","id":"62","name":"Bug Report 2","description":"Bug Report Template","icon":"🎟️","workspace_id":"this_is_an_id629_that_should_be_at_least_","archived":false,"created_at":1717021660,"updated_at":1717021661,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"191","workspace_id":"this_is_an_id629_that_should_be_at_least_","name":"_default_title_","description":"","data_type":"string","input_options":{"multiline":false},"order":0,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":62,"archived":false,"created_at":1717021660,"updated_at":1717021660},{"type":"ticket_type_attribute","id":"193","workspace_id":"this_is_an_id629_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":62,"archived":false,"created_at":1717021660,"updated_at":1717021660},{"type":"ticket_type_attribute","id":"192","workspace_id":"this_is_an_id629_that_should_be_at_least_","name":"_default_description_","description":"","data_type":"string","input_options":{"multiline":true},"order":1,"required_to_create":false,"required_to_create_for_contacts":false,"visible_on_create":true,"visible_to_contacts":true,"default":true,"ticket_type_id":62,"archived":false,"created_at":1717021660,"updated_at":1717021660}]}},"key":"Ticket type updated","summary":"Ticket type updated","id":"paths/~1ticket_types~1{id}/put/responses/200/content/application~1json/examples/Ticket type updated"},"paths/~1ticket_types~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"b6a4ebf0-661c-4d2c-bf2a-c0e98c7c49ae","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1ticket_types~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply":{"value":{"message_type":"note","type":"admin","admin_id":991267687,"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{id}~1reply/post/requestBody/content/application~1json/examples/admin_note_reply"},"paths/~1tickets~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply":{"value":{"type":"ticket_part","id":"98","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":1717021664,"updated_at":1717021664,"author":{"id":"991267687","type":"admin","name":"Ciaran382 Lee","email":"admin382@email.com"},"attachments":[],"redacted":false},"key":"Admin note reply","summary":"Admin note reply","id":"paths/~1tickets~1{id}~1reply/post/responses/200/content/application~1json/examples/Admin note reply"},"paths/~1tickets~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"8bcefa1e-70b4-456d-baf7-d97bf8ca5401","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{id}~1reply/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets/post/requestBody/content/application~1json/examples/successful_response":{"value":{"ticket_type_id":69,"contacts":[{"id":"6657abe46abd0164c24b0df2"}],"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":"446","ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"ticket_state":"submitted","ticket_state_internal_label":"Submitted","ticket_state_external_label":"Submitted","ticket_type":{"type":"ticket_type","id":"69","name":"my-ticket-type-6","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id643_that_should_be_at_least_","archived":false,"created_at":1717021667,"updated_at":1717021667,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"203","workspace_id":"this_is_an_id643_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":69,"archived":false,"created_at":1717021667,"updated_at":1717021667},{"type":"ticket_type_attribute","id":"204","workspace_id":"this_is_an_id643_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":69,"archived":false,"created_at":1717021668,"updated_at":1717021668}]}},"contacts":{"type":"contact.list","contacts":[{"id":"6657abe46abd0164c24b0df2","role":"user"}]},"admin_assignee_id":"0","team_assignee_id":"0","created_at":1717021669,"updated_at":1717021669,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"99","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1717021669,"updated_at":1717021669,"author":{"id":"991267707","type":"bot","name":"Operator","email":"operator+this_is_an_id643_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false}],"total_count":1}},"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":"10eb82e2-1019-4426-b5d0-8d3a817d0578","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response":{"value":{"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"state":"in_progress","assignment":{"admin_id":"991267719","assignee_id":"991267721"},"open":true,"snoozed_until":1673609604},"key":"successful_response","summary":"Successful response","id":"paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/successful_response"},"paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found":{"value":{"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"state":"in_progress","assignment":{"admin_id":"123","assignee_id":"991267729"}},"key":"admin_not_found","summary":"Admin not found","id":"paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/admin_not_found"},"paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_not_found":{"value":{"ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"state":"in_progress","assignment":{"admin_id":"991267735","assignee_id":"456"}},"key":"assignee_not_found","summary":"Assignee not found","id":"paths/~1tickets~1{id}/put/requestBody/content/application~1json/examples/assignee_not_found"},"paths/~1tickets~1{id}/put/responses/200/content/application~1json/examples/Successful response":{"value":{"type":"ticket","id":"447","ticket_attributes":{"_default_title_":"example","_default_description_":"there is a problem"},"ticket_state":"in_progress","ticket_state_internal_label":"In progress","ticket_state_external_label":"In progress","ticket_type":{"type":"ticket_type","id":"71","name":"my-ticket-type-8","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id647_that_should_be_at_least_","archived":false,"created_at":1717021671,"updated_at":1717021671,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"208","workspace_id":"this_is_an_id647_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":71,"archived":false,"created_at":1717021671,"updated_at":1717021671},{"type":"ticket_type_attribute","id":"209","workspace_id":"this_is_an_id647_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":71,"archived":false,"created_at":1717021671,"updated_at":1717021671}]}},"contacts":{"type":"contact.list","contacts":[{"id":"6657abe76abd0164c24b0df3","role":"lead"}]},"admin_assignee_id":"991267721","team_assignee_id":"0","created_at":1717021672,"updated_at":1717021674,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"100","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1717021672,"updated_at":1717021672,"author":{"id":"991267719","type":"admin","name":"Ciaran412 Lee","email":"admin412@email.com"},"attachments":[],"redacted":false},{"type":"ticket_part","id":"101","part_type":"ticket_attribute_updated_by_admin","created_at":1717021673,"updated_at":1717021673,"author":{"id":"991267720","type":"bot","name":"Operator","email":"operator+this_is_an_id647_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false},{"type":"ticket_part","id":"102","part_type":"ticket_attribute_updated_by_admin","created_at":1717021673,"updated_at":1717021673,"author":{"id":"991267720","type":"bot","name":"Operator","email":"operator+this_is_an_id647_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false},{"type":"ticket_part","id":"103","part_type":"ticket_state_updated_by_admin","ticket_state":"in_progress","previous_ticket_state":"submitted","created_at":1717021674,"updated_at":1717021674,"author":{"id":"991267720","type":"bot","name":"Operator","email":"operator+this_is_an_id647_that_should_be_at_least_@intercom.io"},"attachments":[],"redacted":false},{"type":"ticket_part","id":"104","part_type":"assignment","created_at":1717021674,"updated_at":1717021674,"assigned_to":{"type":"admin","id":"991267721"},"author":{"id":"991267719","type":"admin","name":"Ciaran412 Lee","email":"admin412@email.com"},"attachments":[],"redacted":false}],"total_count":5}},"key":"Successful response","summary":"Successful response","id":"paths/~1tickets~1{id}/put/responses/200/content/application~1json/examples/Successful response"},"paths/~1tickets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"475d6530-9b7b-45fe-ae9b-2eac68b2e305","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{id}/put/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Admin not found":{"value":{"type":"error.list","request_id":"297e6005-a6fa-476a-ad07-878b51f5646f","errors":[{"code":"assignee_not_found","message":"Assignee not found"}]},"key":"Admin not found","summary":"Admin not found","id":"paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Admin not found"},"paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Assignee not found":{"value":{"type":"error.list","request_id":"1d253700-fff8-4664-a0bb-b05242b3b2c0","errors":[{"code":"assignee_not_found","message":"Assignee not found"}]},"key":"Assignee not found","summary":"Assignee not found","id":"paths/~1tickets~1{id}/put/responses/404/content/application~1json/examples/Assignee not found"},"paths/~1tickets~1{id}/get/responses/200/content/application~1json/examples/Ticket found":{"value":{"type":"ticket","id":"450","ticket_attributes":{"_default_title_":"attribute_value","_default_description_":null},"ticket_state":"submitted","ticket_state_internal_label":"Submitted","ticket_state_external_label":"Submitted","ticket_type":{"type":"ticket_type","id":"75","name":"my-ticket-type-12","description":"my ticket type description is awesome.","icon":"🦁","workspace_id":"this_is_an_id655_that_should_be_at_least_","archived":false,"created_at":1717021681,"updated_at":1717021681,"is_internal":false,"ticket_type_attributes":{"type":"list","data":[{"type":"ticket_type_attribute","id":"219","workspace_id":"this_is_an_id655_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":75,"archived":false,"created_at":1717021681,"updated_at":1717021681},{"type":"ticket_type_attribute","id":"220","workspace_id":"this_is_an_id655_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":75,"archived":false,"created_at":1717021681,"updated_at":1717021681}]}},"contacts":{"type":"contact.list","contacts":[{"id":"6657abf16abd0164c24b0df6","role":"lead"}]},"admin_assignee_id":"0","team_assignee_id":"0","created_at":1717021682,"updated_at":1717021682,"ticket_parts":{"type":"ticket_part.list","ticket_parts":[{"type":"ticket_part","id":"107","part_type":"ticket_state_updated_by_admin","ticket_state":"submitted","previous_ticket_state":"submitted","created_at":1717021682,"updated_at":1717021682,"author":{"id":"991267748","type":"admin","name":"Ciaran438 Lee","email":"admin438@email.com"},"attachments":[],"redacted":false}],"total_count":1}},"key":"Ticket found","summary":"Ticket found","id":"paths/~1tickets~1{id}/get/responses/200/content/application~1json/examples/Ticket found"},"paths/~1tickets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"error.list","request_id":"cfbb87fd-8bbe-443d-9e21-cb3dc71f0de8","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1tickets~1{id}/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1visitors/put/requestBody/content/application~1json/examples/successful":{"value":{"id":"6657abf76abd0164c24b0df9","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":"6657abf76abd0164c24b0df9","user_id":"3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3","anonymous":true,"email":"","phone":null,"name":"Gareth Bale","pseudonym":"Indigo Guitar","avatar":{"type":"avatar","image_url":"https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-guitar.png"},"app_id":"this_is_an_id665_that_should_be_at_least_","companies":{"type":"company.list","companies":[]},"location_data":{},"last_request_at":null,"created_at":1717021687,"remote_created_at":1717021687,"signed_up_at":1717021687,"updated_at":1717021687,"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":"629db2ed-d045-457f-81f7-a24d5b629c5f","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":"08bbf6c3-96e7-4f46-9623-1ffdd7176b04","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":"6657abf96abd0164c24b0dff","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_id671_that_should_be_at_least_","companies":{"type":"company.list","companies":[]},"location_data":{},"last_request_at":null,"created_at":1717021689,"remote_created_at":1717021689,"signed_up_at":1717021689,"updated_at":1717021689,"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":"3f38ffa3-4cb5-463a-98ac-795cadb5d475","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":"dcae890e-9ff2-449a-bcc3-ab4ceb151767","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":"6657abfb6abd0164c24b0e06","workspace_id":"this_is_an_id677_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":1717021691,"updated_at":1717021691,"signed_up_at":1717021691,"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/6657abfb6abd0164c24b0e06/tags","total_count":0,"has_more":false},"notes":{"type":"list","data":[],"url":"/contacts/6657abfb6abd0164c24b0e06/notes","total_count":0,"has_more":false},"companies":{"type":"list","data":[],"url":"/contacts/6657abfb6abd0164c24b0e06/companies","total_count":0,"has_more":false},"opted_out_subscription_types":{"type":"list","data":[],"url":"/contacts/6657abfb6abd0164c24b0e06/subscriptions","total_count":0,"has_more":false},"opted_in_subscription_types":{"type":"list","data":[],"url":"/contacts/6657abfb6abd0164c24b0e06/subscriptions","total_count":0,"has_more":false},"utm_campaign":null,"utm_content":null,"utm_medium":null,"utm_source":null,"utm_term":null,"referrer":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":"dea6a078-4db1-4f21-a9f6-14bfce68209d","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1visitors~1convert/post/responses/401/content/application~1json/examples/Unauthorized"}},"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.9/rest-api/api.intercom.io.json?download"},{"url":"/_bundle/docs/references/@2.9/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/2.9/rest-api/api.intercom.io","routesMapping":{}}