The document goes last among the documents that share its parent. Under a parent it takes
the parent’s client; the parent has to exist and not be archived.
Body must not embed images as data: URLs: upload each image with
POST /v1/attachments and use the url it returns. Links in the body to other
documents, devices, custom assets, contacts, passwords and structured documents are added
to the document’s related items, as the app adds them.
Attach files after creating, with PATCH /v1/documents/{documentId}.
Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.
The client the document belongs to; omit or null for an internal document. Under a parent
the document takes the parent's client, and a different value here is rejected.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Gorelo Documentation","colors":{"primary":"#1DAF94","light":"#8AEFDD","dark":"#1DAF94"},"logo":{"light":"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=3c12ffa7afbcef131d2c6fb36f00e159","dark":"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=2dc592c604dd68bb156e97c047088df2"},"favicon":"https://mintcdn.com/gorelo/eK-NlDv-DeG3Jk2m/favicon.svg?fit=max\u0026auto=format\u0026n=eK-NlDv-DeG3Jk2m\u0026q=85\u0026s=99510712391acd38a7057cf358869244","api":{"url":"full"},"appearance":{"default":"dark"},"background":{"color":{"light":"#FBFBFB","dark":"#1F2023"}},"navbar":{"links":[{"href":"https://feedback.gorelo.io/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"x":"https://twitter.com/Goreloio","facebook":"https://www.facebook.com/gorelo.io","linkedin":"https://www.linkedin.com/company/gorelo","youtube":"https://www.youtube.com/@gorelotech","discord":"https://discord.com/invite/BpmP8BSrj6","website":"https://www.gorelo.io/"}},"seo":{"indexing":"navigable"},"fonts":{"family":"Inter","weight":400},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"what-is-gorelo"},{"language":"ar","href":"ar/what-is-gorelo"},{"language":"pt-BR","href":"pt-BR/what-is-gorelo"},{"language":"fr-CA","href":"fr-CA/what-is-gorelo"},{"language":"ca","href":"ca/what-is-gorelo"},{"language":"cn","href":"cn/what-is-gorelo"},{"language":"zh","href":"zh/what-is-gorelo"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gorelo","hasAudioNarration":false,"actualSubdomain":"gorelo","customDomains":["help.gorelo.io"],"gitSource":{"type":"github","owner":"gorelo","repo":"gorelo_public_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0e7e8f954e5368715cbc6","collectionId":"9e2c5cbd-ad8e-42d1-aeb6-bcda615db32d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0e7e8f954e5368715cbc6"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0e8186786d105b8a06985","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"en","tag":"API","count":128},{"language":"ar","tag":"API","count":128},{"language":"ca","tag":"API","count":128},{"language":"cn","tag":"API","count":128},{"language":"fr-CA","tag":"API","count":128},{"language":"pt-BR","tag":"API","count":128},{"language":"zh","tag":"API","count":128},{"language":"en","tag":"API reference","count":125},{"language":"ar","tag":"مرجع API","count":125},{"language":"ca","tag":"Referència de l'API","count":125},{"language":"cn","tag":"API 参考","count":125},{"language":"fr-CA","tag":"Référence de l'API","count":125},{"language":"pt-BR","tag":"Referência da API","count":125},{"language":"zh","tag":"API 參考","count":125},{"language":"en","tag":"Service Delivery","count":40},{"language":"ar","tag":"تقديم الخدمة","count":40},{"language":"ca","tag":"Prestació de servei","count":40},{"language":"cn","tag":"服务交付","count":40},{"language":"fr-CA","tag":"Prestation de services","count":40},{"language":"pt-BR","tag":"Entrega de serviços","count":40},{"language":"zh","tag":"服務交付","count":40},{"language":"en","tag":"Remote Management","count":35},{"language":"ar","tag":"الإدارة عن بُعد","count":35},{"language":"ca","tag":"Gestió remota","count":35},{"language":"cn","tag":"远程管理","count":35},{"language":"fr-CA","tag":"Gestion à distance","count":35},{"language":"pt-BR","tag":"Gerenciamento remoto","count":35},{"language":"zh","tag":"遠端管理","count":35},{"language":"en","tag":"Billing","count":34},{"language":"en","tag":"Projects","count":31},{"language":"ar","tag":"Projects","count":28},{"language":"ca","tag":"Projects","count":28},{"language":"cn","tag":"Projects","count":28},{"language":"fr-CA","tag":"Projects","count":28},{"language":"pt-BR","tag":"Projects","count":28},{"language":"zh","tag":"Projects","count":28},{"language":"en","tag":"Assets","count":26},{"language":"ar","tag":"Billing","count":24},{"language":"ca","tag":"Billing","count":24},{"language":"cn","tag":"Billing","count":24},{"language":"fr-CA","tag":"Billing","count":24},{"language":"pt-BR","tag":"Billing","count":24},{"language":"zh","tag":"Billing","count":24},{"language":"en","tag":"Tickets","count":22},{"language":"ar","tag":"Assets","count":22},{"language":"ca","tag":"Assets","count":22},{"language":"cn","tag":"Assets","count":22},{"language":"fr-CA","tag":"Assets","count":22},{"language":"pt-BR","tag":"Tickets","count":22},{"language":"pt-BR","tag":"Assets","count":22},{"language":"zh","tag":"Assets","count":22},{"language":"en","tag":"How-to guides","count":19},{"language":"ar","tag":"أدلة الكيفية","count":19},{"language":"ca","tag":"Guies pràctiques","count":19},{"language":"cn","tag":"操作指南","count":19},{"language":"fr-CA","tag":"Guides pratiques","count":19},{"language":"pt-BR","tag":"Guias práticos","count":19},{"language":"zh","tag":"操作指南","count":19},{"language":"ar","tag":"Tickets","count":16},{"language":"ca","tag":"Tickets","count":16},{"language":"cn","tag":"Tickets","count":16},{"language":"fr-CA","tag":"Tickets","count":16},{"language":"zh","tag":"Tickets","count":16},{"language":"en","tag":"Documents","count":15},{"language":"ca","tag":"Documents","count":15},{"language":"fr-CA","tag":"Documents","count":15},{"language":"ar","tag":"العمليات","count":13},{"language":"cn","tag":"运营","count":13},{"language":"pt-BR","tag":"Operações","count":13},{"language":"zh","tag":"營運","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@gorelo.io","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"ar/api-reference/documents/creates-a-document","slug":"/ar/api-reference/documents/creates-a-document","pageMetadata":{"title":"Creates a document.","description":"The document goes last among the documents that share its parent. Under a parent it takes\r\nthe parent's client; the parent has to exist and not be archived.\r\n \r\n`Body` must not embed images as `data:` URLs: upload each image with\r\n`POST /v1/attachments` and use the url it returns. Links in the body to other\r\ndocuments, devices, custom assets, contacts, passwords and structured documents are added\r\nto the document's related items, as the app adds them.\r\n \r\nAttach files after creating, with `PATCH /v1/documents/{documentId}`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents","href":"/ar/api-reference/documents/creates-a-document","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The document goes last among the documents that share its parent. Under a parent it takes\\r\\nthe parent’s client; the parent has to exist and not be archived.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Body\"\n }), \" must not embed images as \", _jsx(_components.code, {\n children: \"data:\"\n }), \" URLs: upload each image with\\r\\n\", _jsx(_components.code, {\n children: \"POST /v1/attachments\"\n }), \" and use the url it returns. Links in the body to other\\r\\ndocuments, devices, custom assets, contacts, passwords and structured documents are added\\r\\nto the document’s related items, as the app adds them.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Attach files after creating, with \", _jsx(_components.code, {\n children: \"PATCH /v1/documents/{documentId}\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Creates a document.","description":"The document goes last among the documents that share its parent. Under a parent it takes\r\nthe parent's client; the parent has to exist and not be archived.\r\n \r\n`Body` must not embed images as `data:` URLs: upload each image with\r\n`POST /v1/attachments` and use the url it returns. Links in the body to other\r\ndocuments, devices, custom assets, contacts, passwords and structured documents are added\r\nto the document's related items, as the app adds them.\r\n \r\nAttach files after creating, with `PATCH /v1/documents/{documentId}`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents","href":"/ar/api-reference/documents/creates-a-document","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Creates a document.","description":"The document goes last among the documents that share its parent. Under a parent it takes\r\nthe parent's client; the parent has to exist and not be archived.\r\n \r\n`Body` must not embed images as `data:` URLs: upload each image with\r\n`POST /v1/attachments` and use the url it returns. Links in the body to other\r\ndocuments, devices, custom assets, contacts, passwords and structured documents are added\r\nto the document's related items, as the app adds them.\r\n \r\nAttach files after creating, with `PATCH /v1/documents/{documentId}`.","operationId":"post_v1_documents","requestBody":"bd5efecd-6882-47c2-a697-4a88569287f1","responses":{"200":"a2f6e5c3-6fb1-4717-b2db-8ffc45585324","400":"76733e50-0bb8-4f45-85e1-7eb62853b2a6","401":"f4a76563-210a-46d7-9b15-509d5ecb1ad7","500":"ddd1f2de-72e8-4b2a-8565-2295f0042759"},"method":"post","type":"path","servers":["c45f3e55-70a5-4683-bd92-9d0a077a9a8f","2a42ac77-a3aa-4890-87be-e126aeef1e79"],"security":["f01c3aed-69e3-4627-b3db-e003e1c21463"],"path":"/v1/documents","baseUrlOptions":["https://api.usw.gorelo.io","https://api.aue.gorelo.io"],"title":"Creates a document.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{},"requestBody":{"description":"The document.","content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"Title":{"oneOf":[{"type":"string","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.1","typeLabel":"null"}],"uniqueKey":"Title","typeLabel":"string | null"},"Body":{"oneOf":[{"type":"string","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.1","typeLabel":"null"}],"uniqueKey":"Body","typeLabel":"string | null"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ClientId","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A new document.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ClientId":123}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"Title":{"oneOf":[{"type":"string","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.1","typeLabel":"null"}],"uniqueKey":"Title","typeLabel":"string | null"},"Body":{"oneOf":[{"type":"string","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.1","typeLabel":"null"}],"uniqueKey":"Body","typeLabel":"string | null"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ClientId","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A new document.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ClientId":123}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"Title":{"oneOf":[{"type":"string","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.1","typeLabel":"null"}],"uniqueKey":"Title","typeLabel":"string | null"},"Body":{"oneOf":[{"type":"string","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.1","typeLabel":"null"}],"uniqueKey":"Body","typeLabel":"string | null"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ClientId","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A new document.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ClientId":123}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"Title":{"oneOf":[{"type":"string","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Title. Required, max 200 characters.","uniqueKey":"Title.oneOf.1","typeLabel":"null"}],"uniqueKey":"Title","typeLabel":"string | null"},"Body":{"oneOf":[{"type":"string","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The body, as HTML. Must not embed images as `data:` URLs - upload them first.","uniqueKey":"Body.oneOf.1","typeLabel":"null"}],"uniqueKey":"Body","typeLabel":"string | null"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document to nest this one under; omit or null for a top-level document.","format":"uuid","uniqueKey":"ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; omit or null for an internal document. Under a parent\r\nthe document takes the parent's client, and a different value here is rejected.","format":"int64","uniqueKey":"ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ClientId","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A new document.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ClientId":123}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a2f6e5c3-6fb1-4717-b2db-8ffc45585324":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Document identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Title.","uniqueKey":"Data.Title","typeLabel":"string"},"Body":{"type":"string","description":"The body of the current version, as HTML. Image links carry a time-limited access token.","uniqueKey":"Data.Body","typeLabel":"string"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document this one is nested under; null for a top-level document.","format":"uuid","uniqueKey":"Data.ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document this one is nested under; null for a top-level document.","format":"uuid","uniqueKey":"Data.ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"RootDocumentId":{"type":"string","description":"The top-level document of this document's tree; its own id when it is top level.","format":"uuid","uniqueKey":"Data.RootDocumentId","typeLabel":"string\u003cuuid>"},"Depth":{"type":"integer","description":"How deep the document is nested: 0 for a top-level document, 1 for its children, and so on.","format":"int32","uniqueKey":"Data.Depth","typeLabel":"integer\u003cint32>"},"ChildCount":{"type":"integer","description":"Number of documents nested directly under this one, archived ones included.","format":"int32","uniqueKey":"Data.ChildCount","typeLabel":"integer\u003cint32>"},"DocumentOrder":{"type":"integer","description":"Position among the documents that share its parent, lowest first. Read-only.","format":"int32","uniqueKey":"Data.DocumentOrder","typeLabel":"integer\u003cint32>"},"Children":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"string","description":"Document identifier.","format":"uuid","uniqueKey":"Data.Children.items.[INDEX].Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Title.","uniqueKey":"Data.Children.items.[INDEX].Title","typeLabel":"string"},"ChildCount":{"type":"integer","description":"Number of documents nested directly under this one.","format":"int32","uniqueKey":"Data.Children.items.[INDEX].ChildCount","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"description":"A document nested directly under another.","uniqueKey":"Data.Children.items.[INDEX]","typeLabel":"object"},"description":"The documents nested directly under this one, in their display order.","uniqueKey":"Data.Children","typeLabel":"object[]"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; null for an internal document.","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; null for an internal document.","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"IsStarred":{"type":"boolean","description":"Whether the document is starred. A star is shared by everyone in the account, not kept per user.","uniqueKey":"Data.IsStarred","typeLabel":"boolean"},"PublicLinkEnabled":{"type":"boolean","description":"Whether the document can be read by anyone holding its public link.","uniqueKey":"Data.PublicLinkEnabled","typeLabel":"boolean"},"PublicLinkUrl":{"oneOf":[{"type":"string","description":"The public link to the current version, in the form the app copies to the clipboard. Null\r\nwhile `PublicLinkEnabled` is false.","uniqueKey":"Data.PublicLinkUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public link to the current version, in the form the app copies to the clipboard. Null\r\nwhile `PublicLinkEnabled` is false.","uniqueKey":"Data.PublicLinkUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.PublicLinkUrl","typeLabel":"string | null"},"PublishToPortalEnabled":{"type":"boolean","description":"Whether the document is published to the client portal.","uniqueKey":"Data.PublishToPortalEnabled","typeLabel":"boolean"},"AlternateName":{"oneOf":[{"type":"string","description":"The name the document is shown under in the client portal; null when none is set.","uniqueKey":"Data.AlternateName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name the document is shown under in the client portal; null when none is set.","uniqueKey":"Data.AlternateName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.AlternateName","typeLabel":"string | null"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"Attachments":{"type":"array","items":{"type":"object","properties":{"Name":{"type":"string","description":"File name.","uniqueKey":"Data.Attachments.items.[INDEX].Name","typeLabel":"string"},"Url":{"type":"string","description":"Temporary secure download link. Expires.","uniqueKey":"Data.Attachments.items.[INDEX].Url","typeLabel":"string"}},"additionalProperties":false,"description":"A file attached to a comment, and what the upload endpoint returns.","uniqueKey":"Data.Attachments.items.[INDEX]","typeLabel":"object"},"description":"Files attached to the current version. Each url carries a time-limited access token; do\r\nnot store it.","uniqueKey":"Data.Attachments","typeLabel":"object[]"},"RelatedItems":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"integer","description":"Identifier of the link itself - what the remove endpoint takes.","format":"int64","uniqueKey":"Data.RelatedItems.items.[INDEX].Id","typeLabel":"integer\u003cint64>"},"ItemId":{"type":"string","description":"Identifier of the linked record, as text: a Guid for documents, custom assets and agent assets, a number for contacts.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemId","typeLabel":"string"},"ItemType":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType","typeLabel":"object"}},"additionalProperties":false,"description":"A link between a document and another record.","uniqueKey":"Data.RelatedItems.items.[INDEX]","typeLabel":"object"},"description":"The records this document is linked to.","uniqueKey":"Data.RelatedItems","typeLabel":"object[]"},"CreatedOn":{"type":"string","description":"When the document was created (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time>"},"CreatedById":{"type":"integer","description":"Technician who created the document; 0 when it was created through the API.","format":"int64","uniqueKey":"Data.CreatedById","typeLabel":"integer\u003cint64>"},"UpdatedOn":{"oneOf":[{"type":"string","description":"When the document was last changed (UTC); its creation time if it has not been changed since.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the document was last changed (UTC); its creation time if it has not been changed since.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"},"UpdatedById":{"oneOf":[{"type":"integer","description":"Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API.","format":"int64","uniqueKey":"Data.UpdatedById.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API.","format":"int64","uniqueKey":"Data.UpdatedById.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedById","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A single document, with its body, children, attachments and related items.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","RootDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Depth":123,"ChildCount":123,"DocumentOrder":123,"Children":[{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","ChildCount":123}],"ClientId":123,"IsStarred":true,"PublicLinkEnabled":true,"PublicLinkUrl":"\u003cstring>","PublishToPortalEnabled":true,"AlternateName":"\u003cstring>","Status":{"Id":1,"Name":"\u003cstring>"},"Attachments":[{"Name":"\u003cstring>","Url":"\u003cstring>"}],"RelatedItems":[{"Id":123,"ItemId":"\u003cstring>","ItemType":{"Id":1,"Name":"\u003cstring>"}}],"CreatedOn":"2023-11-07T05:31:56Z","CreatedById":123,"UpdatedOn":"2023-11-07T05:31:56Z","UpdatedById":123},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Document identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Title.","uniqueKey":"Data.Title","typeLabel":"string"},"Body":{"type":"string","description":"The body of the current version, as HTML. Image links carry a time-limited access token.","uniqueKey":"Data.Body","typeLabel":"string"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document this one is nested under; null for a top-level document.","format":"uuid","uniqueKey":"Data.ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document this one is nested under; null for a top-level document.","format":"uuid","uniqueKey":"Data.ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"RootDocumentId":{"type":"string","description":"The top-level document of this document's tree; its own id when it is top level.","format":"uuid","uniqueKey":"Data.RootDocumentId","typeLabel":"string\u003cuuid>"},"Depth":{"type":"integer","description":"How deep the document is nested: 0 for a top-level document, 1 for its children, and so on.","format":"int32","uniqueKey":"Data.Depth","typeLabel":"integer\u003cint32>"},"ChildCount":{"type":"integer","description":"Number of documents nested directly under this one, archived ones included.","format":"int32","uniqueKey":"Data.ChildCount","typeLabel":"integer\u003cint32>"},"DocumentOrder":{"type":"integer","description":"Position among the documents that share its parent, lowest first. Read-only.","format":"int32","uniqueKey":"Data.DocumentOrder","typeLabel":"integer\u003cint32>"},"Children":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"string","description":"Document identifier.","format":"uuid","uniqueKey":"Data.Children.items.[INDEX].Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Title.","uniqueKey":"Data.Children.items.[INDEX].Title","typeLabel":"string"},"ChildCount":{"type":"integer","description":"Number of documents nested directly under this one.","format":"int32","uniqueKey":"Data.Children.items.[INDEX].ChildCount","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"description":"A document nested directly under another.","uniqueKey":"Data.Children.items.[INDEX]","typeLabel":"object"},"description":"The documents nested directly under this one, in their display order.","uniqueKey":"Data.Children","typeLabel":"object[]"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; null for an internal document.","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; null for an internal document.","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"IsStarred":{"type":"boolean","description":"Whether the document is starred. A star is shared by everyone in the account, not kept per user.","uniqueKey":"Data.IsStarred","typeLabel":"boolean"},"PublicLinkEnabled":{"type":"boolean","description":"Whether the document can be read by anyone holding its public link.","uniqueKey":"Data.PublicLinkEnabled","typeLabel":"boolean"},"PublicLinkUrl":{"oneOf":[{"type":"string","description":"The public link to the current version, in the form the app copies to the clipboard. Null\r\nwhile `PublicLinkEnabled` is false.","uniqueKey":"Data.PublicLinkUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public link to the current version, in the form the app copies to the clipboard. Null\r\nwhile `PublicLinkEnabled` is false.","uniqueKey":"Data.PublicLinkUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.PublicLinkUrl","typeLabel":"string | null"},"PublishToPortalEnabled":{"type":"boolean","description":"Whether the document is published to the client portal.","uniqueKey":"Data.PublishToPortalEnabled","typeLabel":"boolean"},"AlternateName":{"oneOf":[{"type":"string","description":"The name the document is shown under in the client portal; null when none is set.","uniqueKey":"Data.AlternateName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name the document is shown under in the client portal; null when none is set.","uniqueKey":"Data.AlternateName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.AlternateName","typeLabel":"string | null"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"Attachments":{"type":"array","items":{"type":"object","properties":{"Name":{"type":"string","description":"File name.","uniqueKey":"Data.Attachments.items.[INDEX].Name","typeLabel":"string"},"Url":{"type":"string","description":"Temporary secure download link. Expires.","uniqueKey":"Data.Attachments.items.[INDEX].Url","typeLabel":"string"}},"additionalProperties":false,"description":"A file attached to a comment, and what the upload endpoint returns.","uniqueKey":"Data.Attachments.items.[INDEX]","typeLabel":"object"},"description":"Files attached to the current version. Each url carries a time-limited access token; do\r\nnot store it.","uniqueKey":"Data.Attachments","typeLabel":"object[]"},"RelatedItems":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"integer","description":"Identifier of the link itself - what the remove endpoint takes.","format":"int64","uniqueKey":"Data.RelatedItems.items.[INDEX].Id","typeLabel":"integer\u003cint64>"},"ItemId":{"type":"string","description":"Identifier of the linked record, as text: a Guid for documents, custom assets and agent assets, a number for contacts.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemId","typeLabel":"string"},"ItemType":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType","typeLabel":"object"}},"additionalProperties":false,"description":"A link between a document and another record.","uniqueKey":"Data.RelatedItems.items.[INDEX]","typeLabel":"object"},"description":"The records this document is linked to.","uniqueKey":"Data.RelatedItems","typeLabel":"object[]"},"CreatedOn":{"type":"string","description":"When the document was created (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time>"},"CreatedById":{"type":"integer","description":"Technician who created the document; 0 when it was created through the API.","format":"int64","uniqueKey":"Data.CreatedById","typeLabel":"integer\u003cint64>"},"UpdatedOn":{"oneOf":[{"type":"string","description":"When the document was last changed (UTC); its creation time if it has not been changed since.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the document was last changed (UTC); its creation time if it has not been changed since.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"},"UpdatedById":{"oneOf":[{"type":"integer","description":"Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API.","format":"int64","uniqueKey":"Data.UpdatedById.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API.","format":"int64","uniqueKey":"Data.UpdatedById.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedById","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A single document, with its body, children, attachments and related items.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","RootDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Depth":123,"ChildCount":123,"DocumentOrder":123,"Children":[{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","ChildCount":123}],"ClientId":123,"IsStarred":true,"PublicLinkEnabled":true,"PublicLinkUrl":"\u003cstring>","PublishToPortalEnabled":true,"AlternateName":"\u003cstring>","Status":{"Id":1,"Name":"\u003cstring>"},"Attachments":[{"Name":"\u003cstring>","Url":"\u003cstring>"}],"RelatedItems":[{"Id":123,"ItemId":"\u003cstring>","ItemType":{"Id":1,"Name":"\u003cstring>"}}],"CreatedOn":"2023-11-07T05:31:56Z","CreatedById":123,"UpdatedOn":"2023-11-07T05:31:56Z","UpdatedById":123},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Document identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Title.","uniqueKey":"Data.Title","typeLabel":"string"},"Body":{"type":"string","description":"The body of the current version, as HTML. Image links carry a time-limited access token.","uniqueKey":"Data.Body","typeLabel":"string"},"ParentDocumentId":{"oneOf":[{"type":"string","description":"The document this one is nested under; null for a top-level document.","format":"uuid","uniqueKey":"Data.ParentDocumentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The document this one is nested under; null for a top-level document.","format":"uuid","uniqueKey":"Data.ParentDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ParentDocumentId","typeLabel":"string\u003cuuid> | null"},"RootDocumentId":{"type":"string","description":"The top-level document of this document's tree; its own id when it is top level.","format":"uuid","uniqueKey":"Data.RootDocumentId","typeLabel":"string\u003cuuid>"},"Depth":{"type":"integer","description":"How deep the document is nested: 0 for a top-level document, 1 for its children, and so on.","format":"int32","uniqueKey":"Data.Depth","typeLabel":"integer\u003cint32>"},"ChildCount":{"type":"integer","description":"Number of documents nested directly under this one, archived ones included.","format":"int32","uniqueKey":"Data.ChildCount","typeLabel":"integer\u003cint32>"},"DocumentOrder":{"type":"integer","description":"Position among the documents that share its parent, lowest first. Read-only.","format":"int32","uniqueKey":"Data.DocumentOrder","typeLabel":"integer\u003cint32>"},"Children":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"string","description":"Document identifier.","format":"uuid","uniqueKey":"Data.Children.items.[INDEX].Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"Title.","uniqueKey":"Data.Children.items.[INDEX].Title","typeLabel":"string"},"ChildCount":{"type":"integer","description":"Number of documents nested directly under this one.","format":"int32","uniqueKey":"Data.Children.items.[INDEX].ChildCount","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"description":"A document nested directly under another.","uniqueKey":"Data.Children.items.[INDEX]","typeLabel":"object"},"description":"The documents nested directly under this one, in their display order.","uniqueKey":"Data.Children","typeLabel":"object[]"},"ClientId":{"oneOf":[{"type":"integer","description":"The client the document belongs to; null for an internal document.","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The client the document belongs to; null for an internal document.","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"IsStarred":{"type":"boolean","description":"Whether the document is starred. A star is shared by everyone in the account, not kept per user.","uniqueKey":"Data.IsStarred","typeLabel":"boolean"},"PublicLinkEnabled":{"type":"boolean","description":"Whether the document can be read by anyone holding its public link.","uniqueKey":"Data.PublicLinkEnabled","typeLabel":"boolean"},"PublicLinkUrl":{"oneOf":[{"type":"string","description":"The public link to the current version, in the form the app copies to the clipboard. Null\r\nwhile `PublicLinkEnabled` is false.","uniqueKey":"Data.PublicLinkUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public link to the current version, in the form the app copies to the clipboard. Null\r\nwhile `PublicLinkEnabled` is false.","uniqueKey":"Data.PublicLinkUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.PublicLinkUrl","typeLabel":"string | null"},"PublishToPortalEnabled":{"type":"boolean","description":"Whether the document is published to the client portal.","uniqueKey":"Data.PublishToPortalEnabled","typeLabel":"boolean"},"AlternateName":{"oneOf":[{"type":"string","description":"The name the document is shown under in the client portal; null when none is set.","uniqueKey":"Data.AlternateName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name the document is shown under in the client portal; null when none is set.","uniqueKey":"Data.AlternateName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.AlternateName","typeLabel":"string | null"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"Attachments":{"type":"array","items":{"type":"object","properties":{"Name":{"type":"string","description":"File name.","uniqueKey":"Data.Attachments.items.[INDEX].Name","typeLabel":"string"},"Url":{"type":"string","description":"Temporary secure download link. Expires.","uniqueKey":"Data.Attachments.items.[INDEX].Url","typeLabel":"string"}},"additionalProperties":false,"description":"A file attached to a comment, and what the upload endpoint returns.","uniqueKey":"Data.Attachments.items.[INDEX]","typeLabel":"object"},"description":"Files attached to the current version. Each url carries a time-limited access token; do\r\nnot store it.","uniqueKey":"Data.Attachments","typeLabel":"object[]"},"RelatedItems":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"integer","description":"Identifier of the link itself - what the remove endpoint takes.","format":"int64","uniqueKey":"Data.RelatedItems.items.[INDEX].Id","typeLabel":"integer\u003cint64>"},"ItemId":{"type":"string","description":"Identifier of the linked record, as text: a Guid for documents, custom assets and agent assets, a number for contacts.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemId","typeLabel":"string"},"ItemType":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.RelatedItems.items.[INDEX].ItemType","typeLabel":"object"}},"additionalProperties":false,"description":"A link between a document and another record.","uniqueKey":"Data.RelatedItems.items.[INDEX]","typeLabel":"object"},"description":"The records this document is linked to.","uniqueKey":"Data.RelatedItems","typeLabel":"object[]"},"CreatedOn":{"type":"string","description":"When the document was created (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time>"},"CreatedById":{"type":"integer","description":"Technician who created the document; 0 when it was created through the API.","format":"int64","uniqueKey":"Data.CreatedById","typeLabel":"integer\u003cint64>"},"UpdatedOn":{"oneOf":[{"type":"string","description":"When the document was last changed (UTC); its creation time if it has not been changed since.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the document was last changed (UTC); its creation time if it has not been changed since.","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"},"UpdatedById":{"oneOf":[{"type":"integer","description":"Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API.","format":"int64","uniqueKey":"Data.UpdatedById.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API.","format":"int64","uniqueKey":"Data.UpdatedById.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedById","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"description":"A single document, with its body, children, attachments and related items.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Body":"\u003cstring>","ParentDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","RootDocumentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Depth":123,"ChildCount":123,"DocumentOrder":123,"Children":[{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","ChildCount":123}],"ClientId":123,"IsStarred":true,"PublicLinkEnabled":true,"PublicLinkUrl":"\u003cstring>","PublishToPortalEnabled":true,"AlternateName":"\u003cstring>","Status":{"Id":1,"Name":"\u003cstring>"},"Attachments":[{"Name":"\u003cstring>","Url":"\u003cstring>"}],"RelatedItems":[{"Id":123,"ItemId":"\u003cstring>","ItemType":{"Id":1,"Name":"\u003cstring>"}}],"CreatedOn":"2023-11-07T05:31:56Z","CreatedById":123,"UpdatedOn":"2023-11-07T05:31:56Z","UpdatedById":123},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"76733e50-0bb8-4f45-85e1-7eb62853b2a6":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f4a76563-210a-46d7-9b15-509d5ecb1ad7":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ddd1f2de-72e8-4b2a-8565-2295f0042759":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f01c3aed-69e3-4627-b3db-e003e1c21463":{"ApiKeyAuth":{"type":"apiKey","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c45f3e55-70a5-4683-bd92-9d0a077a9a8f":{"url":"https://api.usw.gorelo.io","description":"US"},"2a42ac77-a3aa-4890-87be-e126aeef1e79":{"url":"https://api.aue.gorelo.io","description":"Australia"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"gorelo","siteName":"Gorelo Documentation","title":"Creates a document. - Gorelo Documentation","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/documents/creates-a-document","matchLevel":1},"ar":{"href":"/ar/api-reference/documents/creates-a-document","matchLevel":0},"pt-BR":{"href":"/pt-br/api-reference/documents/creates-a-document","matchLevel":1},"fr-CA":{"href":"/fr-ca/api-reference/documents/creates-a-document","matchLevel":1},"ca":{"href":"/ca/api-reference/documents/creates-a-document","matchLevel":1},"cn":{"href":"/cn/api-reference/documents/creates-a-document","matchLevel":1},"zh":{"href":"/zh/api-reference/documents/creates-a-document","matchLevel":1}}},"lastModified":"2026-10-27T17:47:12.322Z","originalFileLocation":"ar/api-reference/documents/creates-a-document.mdx","locale":"ar"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The document goes last among the documents that share its parent. Under a parent it takes the parent\u0026#x27;s client; the parent has to exist and not be archived. Body must not embed images as data: URLs: upload each image with POST /v1/attachments and use the url it returns. Links in the body to other documents, devices, custom assets, contacts, passwords and structured documents are added to the document\u0026#x27;s related items, as the app adds them. Attach files after creating, with PATCH /v1/documents/{documentId}.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Creates a document. - Gorelo Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"The document goes last among the documents that share its parent. Under a parent it takes the parent\u0026#x27;s client; the parent has to exist and not be archived. Body must not embed images as data: URLs: upload each image with POST /v1/attachments and use the url it returns. Links in the body to other documents, devices, custom assets, contacts, passwords and structured documents are added to the document\u0026#x27;s related items, as the app adds them. Attach files after creating, with PATCH /v1/documents/{documentId}.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gorelo.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=Creates+a+document.\u0026amp;description=The+document+goes+last+among+the+documents+that+share+its+parent.+Under+a+parent+it+takes%0D%0Athe+parent%27s+client%3B+the+parent+has+to+exist+and+not+be+archived.%0D%0A++\u0026amp;theme=13a01696fc0cf71f5fdb322b\u0026amp;signature=607f38d61f1941988f3f50d0d7411adce074b0f495a3b8b897c1c1d74d91e86b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Creates a document. - Gorelo Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The document goes last among the documents that share its parent. Under a parent it takes the parent\u0026#x27;s client; the parent has to exist and not be archived. Body must not embed images as data: URLs: upload each image with POST /v1/attachments and use the url it returns. Links in the body to other documents, devices, custom assets, contacts, passwords and structured documents are added to the document\u0026#x27;s related items, as the app adds them. Attach files after creating, with PATCH /v1/documents/{documentId}.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gorelo.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=Creates+a+document.\u0026amp;description=The+document+goes+last+among+the+documents+that+share+its+parent.+Under+a+parent+it+takes%0D%0Athe+parent%27s+client%3B+the+parent+has+to+exist+and+not+be+archived.%0D%0A++\u0026amp;theme=13a01696fc0cf71f5fdb322b\u0026amp;signature=607f38d61f1941988f3f50d0d7411adce074b0f495a3b8b897c1c1d74d91e86b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1DAF94\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ar/api-reference/documents/creates-a-document.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://help.gorelo.io/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://help.gorelo.io/pt-br/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr-CA\" href=\"https://help.gorelo.io/fr-ca/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://help.gorelo.io/ca/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://help.gorelo.io/cn/api-reference/documents/creates-a-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://help.gorelo.io/api-reference/documents/creates-a-document\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.gorelo.io/#organization\",\"name\":\"Gorelo Documentation\",\"url\":\"https://help.gorelo.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=3c12ffa7afbcef131d2c6fb36f00e159\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.gorelo.io#website\",\"name\":\"Gorelo Documentation\",\"url\":\"https://help.gorelo.io\",\"publisher\":{\"@id\":\"https://help.gorelo.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document#webpage\",\"url\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document\",\"name\":\"Creates a document.\",\"description\":\"The document goes last among the documents that share its parent. Under a parent it takes the parent's client; the parent has to exist and not be archived. Body must not embed images as data: URLs: upload each image with POST /v1/attachments and use the url it returns. Links in the body to other documents, devices, custom assets, contacts, passwords and structured documents are added to the document's related items, as the app adds them. Attach files after creating, with PATCH /v1/documents/{documentId}.\",\"dateModified\":\"2026-10-27T17:47:12.322Z\",\"isPartOf\":{\"@id\":\"https://help.gorelo.io#website\"},\"breadcrumb\":{\"@id\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"مرجع API\",\"item\":\"https://help.gorelo.io/ar/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://help.gorelo.io/ar/api-reference/documents/lists-the-service-providers-documents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Creates a document.\",\"item\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document#apireference\",\"headline\":\"Creates a document.\",\"name\":\"Creates a document.\",\"description\":\"The document goes last among the documents that share its parent. Under a parent it takes the parent's client; the parent has to exist and not be archived. Body must not embed images as data: URLs: upload each image with POST /v1/attachments and use the url it returns. Links in the body to other documents, devices, custom assets, contacts, passwords and structured documents are added to the document's related items, as the app adds them. Attach files after creating, with PATCH /v1/documents/{documentId}.\",\"url\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document\",\"mainEntityOfPage\":{\"@id\":\"https://help.gorelo.io/ar/api-reference/documents/creates-a-document#webpage\"},\"dateModified\":\"2026-10-27T17:47:12.322Z\",\"publisher\":{\"@id\":\"https://help.gorelo.io/#organization\"},\"isPartOf\":{\"@id\":\"https://help.gorelo.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gorelo Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gorelo Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/api-reference/documents/creates-a-document"}]},{"language":"ar","tabs":[{"tab":"البدء","icon":"rocket-launch","pages":[{"title":"البدء","href":"/ar/what-is-gorelo"}]},{"tab":"تقديم الخدمة","icon":"bell","pages":[{"title":"تقديم الخدمة","href":"/ar/sd-overview"}]},{"tab":"الإدارة عن بُعد","icon":"desktop","pages":[{"title":"الإدارة عن بُعد","href":"/ar/remote-management-overview"}]},{"tab":"الفوترة","icon":"sack-dollar","pages":[{"title":"الفوترة","href":"/ar/how-billing-works"}]},{"tab":"التكاملات","icon":"plug","pages":[{"title":"التكاملات","href":"/ar/integrations-overview"}]},{"tab":"API","icon":"satellite-dish","pages":[{"title":"نظرة عامة على Gorelo API","href":"/ar/api-overview"},{"title":"إنشاء مفتاح API","href":"/ar/generate-api-key"},{"title":"إبطال مفتاح API","href":"/ar/revoke-api-key"},{"group":"مرجع API","pages":[{"group":"Alerts","pages":[{"title":"Lists alerts for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/alerts","href":"/ar/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider"},{"title":"Posts an external alert against a client for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/alerts","href":"/ar/api-reference/alerts/posts-an-external-alert-against-a-client-for-the-service-provider"}]},{"group":"Assets","pages":[{"title":"Lists agent assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents","href":"/ar/api-reference/assets/lists-agent-assets"},{"title":"Lists custom assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom","href":"/ar/api-reference/assets/lists-custom-assets"},{"title":"Creates a custom asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/assets/custom","href":"/ar/api-reference/assets/creates-a-custom-asset"},{"title":"Gets a single custom asset by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom/{customAssetId}","href":"/ar/api-reference/assets/gets-a-single-custom-asset-by-id"},{"title":"Deletes a custom asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/custom/{customAssetId}","href":"/ar/api-reference/assets/deletes-a-custom-asset"},{"title":"Updates a custom asset. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/assets/custom/{customAssetId}","href":"/ar/api-reference/assets/updates-a-custom-asset-send-only-the-fields-you-want-to-change"},{"title":"Gets a single agent (managed device) asset by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}","href":"/ar/api-reference/assets/gets-a-single-agent-managed-device-asset-by-id"},{"title":"Deletes an agent (managed device) asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/agents/{agentAssetId}","href":"/ar/api-reference/assets/deletes-an-agent-managed-device-asset"},{"title":"Lists the patches installed on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/patches","href":"/ar/api-reference/assets/lists-the-patches-installed-on-an-agent"},{"title":"Lists the Windows updates pending on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/patches/available","href":"/ar/api-reference/assets/lists-the-windows-updates-pending-on-an-agent"},{"title":"Lists the applications installed on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/apps","href":"/ar/api-reference/assets/lists-the-applications-installed-on-an-agent"},{"title":"Gets an agent's processors, memory and disks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/hardware","href":"/ar/api-reference/assets/gets-an-agents-processors-memory-and-disks"},{"title":"Lists the tags on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/tags","href":"/ar/api-reference/assets/lists-the-tags-on-an-agent"},{"title":"Lists the service provider's scripts using cursor pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scripts","href":"/ar/api-reference/assets/lists-the-service-providers-scripts-using-cursor-pagination"},{"title":"Gets a script, with its content.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scripts/{scriptId}","href":"/ar/api-reference/assets/gets-a-script-with-its-content"},{"title":"Lists the asset types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/types","href":"/ar/api-reference/assets/lists-the-asset-types"},{"title":"Lists the hardware types a custom asset can be given. \u003cb>Deprecated:\u003c/b> use `GET /v1/assets/types`.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom/hardware-types","href":"/ar/api-reference/assets/lists-the-hardware-types-a-custom-asset-can-be-given-\u003cb>deprecated:\u003cb>-use-`get-v1assetstypes`"},{"title":"Lists uptime checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uptime","href":"/ar/api-reference/assets/lists-uptime-checks"},{"title":"Creates an uptime check.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/uptime","href":"/ar/api-reference/assets/creates-an-uptime-check"},{"title":"Gets a single uptime check by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uptime/{uptimeId}","href":"/ar/api-reference/assets/gets-a-single-uptime-check-by-id"},{"title":"Deletes an uptime check.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/uptime/{uptimeId}","href":"/ar/api-reference/assets/deletes-an-uptime-check"},{"title":"Updates an uptime check. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/uptime/{uptimeId}","href":"/ar/api-reference/assets/updates-an-uptime-check-send-only-the-fields-you-want-to-change"}]},{"group":"Attachments","pages":[{"title":"Uploads a file and returns a link to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/attachments","href":"/ar/api-reference/attachments/uploads-a-file-and-returns-a-link-to-it"}]},{"group":"Billing","pages":[{"title":"Downloads the rendered PDF for an invoice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices/{invoiceId}/pdf","href":"/ar/api-reference/billing/downloads-the-rendered-pdf-for-an-invoice"},{"title":"Lists billing roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing-roles","href":"/ar/api-reference/billing/lists-billing-roles"},{"title":"Lists work types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/work-types","href":"/ar/api-reference/billing/lists-work-types"},{"title":"Lists the tax rates configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxes","href":"/ar/api-reference/billing/lists-the-tax-rates-configured-for-the-service-provider"},{"title":"Lists logged time across every ticket and task, narrowed by any of the filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/time-entries","href":"/ar/api-reference/billing/lists-logged-time-across-every-ticket-and-task-narrowed-by-any-of-the-filters"},{"title":"Logs time against a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/time-entries","href":"/ar/api-reference/billing/logs-time-against-a-ticket"},{"title":"Gets a single time entry by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/time-entries/{timeEntryId}","href":"/ar/api-reference/billing/gets-a-single-time-entry-by-id"},{"title":"Deletes a time entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/time-entries/{timeEntryId}","href":"/ar/api-reference/billing/deletes-a-time-entry"},{"title":"Partially updates a time entry. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/time-entries/{timeEntryId}","href":"/ar/api-reference/billing/partially-updates-a-time-entry-send-only-the-fields-you-want-to-change"},{"title":"Lists billing contracts, each with the service lines it is made of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contracts","href":"/ar/api-reference/billing/lists-billing-contracts-each-with-the-service-lines-it-is-made-of"},{"title":"Everything about one contract, including each service line's actual products/labor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contracts/{contractId}","href":"/ar/api-reference/billing/everything-about-one-contract-including-each-service-lines-actual-productslabor"},{"title":"Deletes a contract.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contracts/{contractId}","href":"/ar/api-reference/billing/deletes-a-contract"},{"title":"Lists the service provider's invoices, filtered and sorted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices","href":"/ar/api-reference/billing/lists-the-service-providers-invoices-filtered-and-sorted"},{"title":"Raises a manual invoice against a client, with line items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/invoices","href":"/ar/api-reference/billing/raises-a-manual-invoice-against-a-client-with-line-items"},{"title":"Gets one invoice, with its attachments and line items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices/{invoiceId}","href":"/ar/api-reference/billing/gets-one-invoice-with-its-attachments-and-line-items"},{"title":"Deletes or voids an invoice, depending on its current status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/invoices/{invoiceId}","href":"/ar/api-reference/billing/deletes-or-voids-an-invoice-depending-on-its-current-status"},{"title":"Records a payment received outside Gorelo against an approved invoice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/payments","href":"/ar/api-reference/billing/records-a-payment-received-outside-gorelo-against-an-approved-invoice"},{"title":"Deletes a payment that was recorded through the API.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/payments/{paymentId}","href":"/ar/api-reference/billing/deletes-a-payment-that-was-recorded-through-the-api"},{"title":"Lists the categories products are organised under, each with its subcategories.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items/categories","href":"/ar/api-reference/billing/lists-the-categories-products-are-organised-under-each-with-its-subcategories"},{"title":"Lists the service provider's item catalog: products and bundles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items","href":"/ar/api-reference/billing/lists-the-service-providers-item-catalog:-products-and-bundles"},{"title":"Creates a product or a bundle in the item catalog.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/items","href":"/ar/api-reference/billing/creates-a-product-or-a-bundle-in-the-item-catalog"},{"title":"A single catalog item — a product or a bundle.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items/{itemId}","href":"/ar/api-reference/billing/a-single-catalog-item-—-a-product-or-a-bundle"},{"title":"Deletes an item.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/items/{itemId}","href":"/ar/api-reference/billing/deletes-an-item"},{"title":"Partially updates an item. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/items/{itemId}","href":"/ar/api-reference/billing/partially-updates-an-item-send-only-the-fields-you-want-to-change"}]},{"group":"Clients","pages":[{"title":"Lists clients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients","href":"/ar/api-reference/clients/lists-clients"},{"title":"Creates a client (and its default location) for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/clients","href":"/ar/api-reference/clients/creates-a-client-and-its-default-location-for-the-service-provider"},{"title":"Gets a single client by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}","href":"/ar/api-reference/clients/gets-a-single-client-by-id"},{"title":"Deletes a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/clients/{clientId}","href":"/ar/api-reference/clients/deletes-a-client"},{"title":"Updates an existing client. Only supplied (non-null) fields are changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/clients/{clientId}","href":"/ar/api-reference/clients/updates-an-existing-client-only-supplied-non-null-fields-are-changed"},{"title":"Lists the locations for a given client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}/locations","href":"/ar/api-reference/clients/lists-the-locations-for-a-given-client"}]},{"group":"Contacts","pages":[{"title":"Gets a single contact by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contactId}","href":"/ar/api-reference/contacts/gets-a-single-contact-by-id"},{"title":"Deletes a contact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contactId}","href":"/ar/api-reference/contacts/deletes-a-contact"},{"title":"Updates an existing contact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contactId}","href":"/ar/api-reference/contacts/updates-an-existing-contact"},{"title":"Lists contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/ar/api-reference/contacts/lists-contacts"},{"title":"Creates a contact under a client, or a temporary contact when no client is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/ar/api-reference/contacts/creates-a-contact-under-a-client-or-a-temporary-contact-when-no-client-is-given"}]},{"group":"Deletions","pages":[{"title":"Lists deleted records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deletions","href":"/ar/api-reference/deletions/lists-deleted-records"}]},{"group":"Documents","pages":[{"title":"Lists the service provider's documents.","description":"Active documents only, unless statusIds names Archived. Archiving a\r\ndocument archives every document below it. To pick up only what changed since a previous\r\nsync, pass updatedSince: a new document counts as updated when it was\r\ncreated, so it is included.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents","href":"/ar/api-reference/documents/lists-the-service-providers-documents"},{"title":"Creates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents","href":"/ar/api-reference/documents/creates-a-document"},{"title":"Gets a single document.","description":"The body is the current version's. `Children` are the documents nested directly under\r\nthis one. Version history is its own endpoint, `GET /v1/documents/{documentId}/versions`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}","href":"/ar/api-reference/documents/gets-a-single-document"},{"title":"Updates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/documents/{documentId}","href":"/ar/api-reference/documents/updates-a-document"},{"title":"Duplicates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/duplicate","href":"/ar/api-reference/documents/duplicates-a-document"},{"title":"Downloads a document as a PDF.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/pdf","href":"/ar/api-reference/documents/downloads-a-document-as-a-pdf"},{"title":"Lists a document's versions, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/versions","href":"/ar/api-reference/documents/lists-a-documents-versions-newest-first"},{"title":"Gets one version of a document, with its body and attachments.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/versions/{versionId}","href":"/ar/api-reference/documents/gets-one-version-of-a-document-with-its-body-and-attachments"},{"title":"Makes an earlier version the current one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/versions/{versionId}/restore","href":"/ar/api-reference/documents/makes-an-earlier-version-the-current-one"},{"title":"Lists the records a document is related to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/related-items","href":"/ar/api-reference/documents/lists-the-records-a-document-is-related-to"},{"title":"Relates a document to other records.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/related-items","href":"/ar/api-reference/documents/relates-a-document-to-other-records"},{"title":"Removes one related item from a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/documents/{documentId}/related-items/{relatedItemId}","href":"/ar/api-reference/documents/removes-one-related-item-from-a-document"}]},{"group":"Forms","pages":[{"title":"Lists the service provider's forms, most recently updated first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/forms","href":"/ar/api-reference/forms/lists-the-service-providers-forms-most-recently-updated-first"},{"title":"Lists a form's submitted responses, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/forms/{formId}/responses","href":"/ar/api-reference/forms/lists-a-forms-submitted-responses-newest-first"},{"title":"Issues a link through which the form can be submitted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/forms/{formId}/submission-links","href":"/ar/api-reference/forms/issues-a-link-through-which-the-form-can-be-submitted"}]},{"group":"Organization","pages":[{"title":"Lists users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/users","href":"/ar/api-reference/organization/lists-users"},{"title":"Lists the service provider's API keys using cursor pagination, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/api-keys","href":"/ar/api-reference/organization/lists-the-service-providers-api-keys-using-cursor-pagination-newest-first"},{"title":"Creates an API key for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/api-keys","href":"/ar/api-reference/organization/creates-an-api-key-for-the-authenticated-service-provider"},{"title":"Revokes an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/api-keys/{apiKeyId}","href":"/ar/api-reference/organization/revokes-an-api-key"},{"title":"Lists the technician groups configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/groups","href":"/ar/api-reference/organization/lists-the-technician-groups-configured-for-the-service-provider"}]},{"group":"Projects","pages":[{"title":"Lists the projects visible to the authenticated service provider, newest activity first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects","href":"/ar/api-reference/projects/lists-the-projects-visible-to-the-authenticated-service-provider-newest-activity-first"},{"title":"Creates a project for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects","href":"/ar/api-reference/projects/creates-a-project-for-the-authenticated-service-provider"},{"title":"Gets a single project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}","href":"/ar/api-reference/projects/gets-a-single-project"},{"title":"Deletes a project and every task in it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}","href":"/ar/api-reference/projects/deletes-a-project-and-every-task-in-it"},{"title":"Updates a project. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}","href":"/ar/api-reference/projects/updates-a-project-send-only-the-fields-you-want-to-change"},{"title":"Lists the project tags configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/tags","href":"/ar/api-reference/projects/lists-the-project-tags-configured-for-the-service-provider"},{"title":"Lists the project types configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/types","href":"/ar/api-reference/projects/lists-the-project-types-configured-for-the-service-provider"},{"title":"Lists a project's sections.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/sections","href":"/ar/api-reference/projects/lists-a-projects-sections"},{"title":"Adds a section to a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/sections","href":"/ar/api-reference/projects/adds-a-section-to-a-project"},{"title":"Deletes a section and every task in it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/sections/{sectionId}","href":"/ar/api-reference/projects/deletes-a-section-and-every-task-in-it"},{"title":"Updates a section's title or colour. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/sections/{sectionId}","href":"/ar/api-reference/projects/updates-a-sections-title-or-colour-send-only-the-fields-you-want-to-change"},{"title":"Lists a project's tasks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks","href":"/ar/api-reference/projects/lists-a-projects-tasks"},{"title":"Creates a task on a project's board.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks","href":"/ar/api-reference/projects/creates-a-task-on-a-projects-board"},{"title":"Returns a project's comments, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/comments","href":"/ar/api-reference/projects/returns-a-projects-comments-newest-first"},{"title":"Posts a comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/comments","href":"/ar/api-reference/projects/posts-a-comment-on-a-project"},{"title":"Returns one comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/comments/{commentId}","href":"/ar/api-reference/projects/returns-one-comment-on-a-project"},{"title":"Deletes one comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/comments/{commentId}","href":"/ar/api-reference/projects/deletes-one-comment-on-a-project"},{"title":"Returns one task in full.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}","href":"/ar/api-reference/projects/returns-one-task-in-full"},{"title":"Deletes a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/tasks/{taskId}","href":"/ar/api-reference/projects/deletes-a-task"},{"title":"Updates a task. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/tasks/{taskId}","href":"/ar/api-reference/projects/updates-a-task-send-only-the-fields-you-want-to-change"},{"title":"Returns a task's comments, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/comments","href":"/ar/api-reference/projects/returns-a-tasks-comments-newest-first"},{"title":"Posts a comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/comments","href":"/ar/api-reference/projects/posts-a-comment-on-a-task"},{"title":"Starts a side conversation on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/conversations/side-conversation","href":"/ar/api-reference/projects/starts-a-side-conversation-on-a-task"},{"title":"Asks contacts to approve something on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/conversations/approval","href":"/ar/api-reference/projects/asks-contacts-to-approve-something-on-a-task"},{"title":"Returns one comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/ar/api-reference/projects/returns-one-comment-on-a-task"},{"title":"Deletes one comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/ar/api-reference/projects/deletes-one-comment-on-a-task"},{"title":"Lists the conversations on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/conversations","href":"/ar/api-reference/projects/lists-the-conversations-on-a-task"},{"title":"Gets one approval on a task, with its approvers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/approvals/{approvalId}","href":"/ar/api-reference/projects/gets-one-approval-on-a-task-with-its-approvers"}]},{"group":"Tickets","pages":[{"title":"Lists tickets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets","href":"/ar/api-reference/tickets/lists-tickets"},{"title":"Creates a ticket for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets","href":"/ar/api-reference/tickets/creates-a-ticket-for-the-authenticated-service-provider"},{"title":"Gets a single ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}","href":"/ar/api-reference/tickets/gets-a-single-ticket"},{"title":"Deletes a ticket and its time entries.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tickets/{ticketId}","href":"/ar/api-reference/tickets/deletes-a-ticket-and-its-time-entries"},{"title":"Partially updates a ticket. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tickets/{ticketId}","href":"/ar/api-reference/tickets/partially-updates-a-ticket-send-only-the-fields-you-want-to-change"},{"title":"Gets a ticket comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/comments/{commentId}","href":"/ar/api-reference/tickets/gets-a-ticket-comment"},{"title":"Deletes a private comment from a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tickets/{ticketId}/comments/{commentId}","href":"/ar/api-reference/tickets/deletes-a-private-comment-from-a-ticket"},{"title":"Lists the ticket statuses configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/statuses","href":"/ar/api-reference/tickets/lists-the-ticket-statuses-configured-for-the-service-provider"},{"title":"Lists the ticket tags configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/tags","href":"/ar/api-reference/tickets/lists-the-ticket-tags-configured-for-the-service-provider"},{"title":"Lists the ticket types configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/types","href":"/ar/api-reference/tickets/lists-the-ticket-types-configured-for-the-service-provider"},{"title":"Lists ticket comments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/comments","href":"/ar/api-reference/tickets/lists-ticket-comments"},{"title":"Adds a comment to a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/comments","href":"/ar/api-reference/tickets/adds-a-comment-to-a-ticket"},{"title":"Lists ticket conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/conversations","href":"/ar/api-reference/tickets/lists-ticket-conversations"},{"title":"Gets a ticket approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/approvals/{approvalId}","href":"/ar/api-reference/tickets/gets-a-ticket-approval"},{"title":"Creates an approval on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/conversations/approval","href":"/ar/api-reference/tickets/creates-an-approval-on-a-ticket"},{"title":"Creates a side conversation on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/conversations/side-conversation","href":"/ar/api-reference/tickets/creates-a-side-conversation-on-a-ticket"}]}]}]}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-br/api-reference/documents/creates-a-document"}]},{"language":"fr-CA","pages":[{"title":"fr-CA","href":"/fr-ca/api-reference/documents/creates-a-document"}]},{"language":"ca","pages":[{"title":"ca","href":"/ca/api-reference/documents/creates-a-document"}]},{"language":"cn","pages":[{"title":"cn","href":"/cn/api-reference/documents/creates-a-document"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/documents/creates-a-document"}]}]},"title":"Creates a document. - Gorelo Documentation","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-R3M_BF4L.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}