Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on claim_url they sign up or sign in and press Claim. Someone new gets the trial’s workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial’s key stops working once it is claimed.
An agent-first onboarding: a trial agent built from a website before anyone had an account, and where it went.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Wiredesk","colors":{"primary":"#171717","light":"#ededed","dark":"#171717"},"logo":{"light":"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/logo/light.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=63b021338caf414206d5334f0e61c038","dark":"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/logo/dark.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=2ca01c30c77268a24a40f18a090284cc","href":"https://wiredesk.ai"},"favicon":"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/favicon.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=469d6712e7781effa2ffb0b5b6a4f1c1","navbar":{"links":[{"href":"https://wiredesk.ai/help","label":"Help centre"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.wiredesk.ai/dashboard"}},"footer":{"links":[{"header":"Wiredesk","items":[{"label":"Product","href":"https://wiredesk.ai/product"},{"label":"Pricing","href":"https://wiredesk.ai/pricing"},{"label":"Security","href":"https://wiredesk.ai/security"},{"label":"Contact","href":"https://wiredesk.ai/contact"}]}]},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wiredesk","hasAudioNarration":false,"actualSubdomain":"wiredesk","customDomains":["wiredesk.ai"],"gitSource":{"type":"github","owner":"mayur9210","repo":"wiredesk","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6ada84c182d526f16508665b"},"chroma":{"latestBuiltDeploymentHistoryId":"6adc2db11885992e09c78004","collectionId":"026f7a6e-57a5-4ef1-80f1-1c6597f04289","liveDeploymentHistoryId":"6adc2db11885992e09c78004","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adc2db11885992e09c78004","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Guides","count":84},{"language":"default","tag":"API reference","count":25},{"language":"default","tag":"Knowledge","count":15},{"language":"default","tag":"Developers","count":12},{"language":"default","tag":"Account and billing","count":11},{"language":"default","tag":"Actions","count":9},{"language":"default","tag":"Agents","count":8},{"language":"default","tag":"Your workspace","count":8},{"language":"default","tag":"Channels","count":7},{"language":"default","tag":"Chat widget","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/onboarding/claim-an-onboarding","slug":"/api-reference/onboarding/claim-an-onboarding","pageMetadata":{"title":"Claim an onboarding","description":"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on `claim_url` they sign up or sign in and press Claim. Someone new gets the trial's workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial's key stops working once it is claimed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/{onboarding_id}/claim","href":"/api-reference/onboarding/claim-an-onboarding","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on \", _jsx(_components.code, {\n children: \"claim_url\"\n }), \" they sign up or sign in and press Claim. Someone new gets the trial’s workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial’s key stops working once it is claimed.\"]\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":"Claim an onboarding","description":"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on `claim_url` they sign up or sign in and press Claim. Someone new gets the trial's workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial's key stops working once it is claimed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/{onboarding_id}/claim","href":"/api-reference/onboarding/claim-an-onboarding","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"claim_onboarding","tags":["Onboarding"],"summary":"Claim an onboarding","description":"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on `claim_url` they sign up or sign in and press Claim. Someone new gets the trial's workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial's key stops working once it is claimed.","parameters":["cbcd95e5-3a62-4bd7-afcf-d9eb619ae73a"],"requestBody":"bef94b31-56f2-48cf-9af0-0a2b954b66ae","responses":{"200":"c0a351bc-d65a-463c-9943-d514b75953cb","400":"d725b2fa-ce55-417c-a06a-64940b9d2d36","401":"10b0327f-ab70-4b46-813e-07814eddc02c","403":"e7f32fd0-a825-40b3-8ee4-a0abfeb4da95","404":"e6c4d8f3-ba3f-47a8-8349-c751f178ec8f","409":"41fa7496-2a2e-4675-9d8b-197f3a40e16e","429":"ad8146f1-7d02-4323-8f71-7d4c36e6f16c"},"method":"post","type":"path","servers":["29a18b8b-b0f4-4fe3-bd0c-620d44985920"],"security":["524f7325-6266-4e2e-aafa-e15694c7a4a2"],"path":"/onboarding/{onboarding_id}/claim","baseUrlOptions":["https://wiredesk.ai/api/v1"],"title":"Claim an onboarding","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cbcd95e5-3a62-4bd7-afcf-d9eb619ae73a":{"name":"onboarding_id","in":"path","required":true,"schema":{"type":"string","pattern":"^ob_[0-9a-f]{32}$","isRequired":true,"description":"The onboarding's id, `ob_` and 32 hex characters.","uniqueKey":"","typeLabel":"string"},"description":"The onboarding's id, `ob_` and 32 hex characters."}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":254,"uniqueKey":"email","typeLabel":"string\u003cemail>"}},"uniqueKey":"","typeLabel":"object"},"example":{"email":"jane@acmeplumbing.com"},"examples":{"Example":{"title":"Example","value":{"email":"jane@acmeplumbing.com"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c0a351bc-d65a-463c-9943-d514b75953cb":{"description":"The onboarding, with claim_url","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"An agent-first onboarding: a trial agent built from a website before anyone had an account, and where it went.","properties":{"id":{"type":"string","description":"`ob_` and 32 hex characters.","uniqueKey":"data.id","typeLabel":"string"},"object":{"type":"string","const":"onboarding","uniqueKey":"data.object","typeLabel":"string"},"status":{"type":"string","enum":["active","claimed","deleted","expired"],"description":"`active` until someone claims it, it is deleted, or its week runs out.","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"agent_id":{"oneOf":[{"type":"string","description":"The trial's agent; once claimed, the agent in the claimer's workspace.","uniqueKey":"data.agent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The trial's agent; once claimed, the agent in the claimer's workspace.","uniqueKey":"data.agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.agent_id","typeLabel":"string | null"},"website_url":{"type":"string","uniqueKey":"data.website_url","typeLabel":"string"},"setup_agent":{"oneOf":[{"type":"string","description":"The `agent_name` it was started with.","uniqueKey":"data.setup_agent.oneOf.0","typeLabel":"string"},{"type":"null","description":"The `agent_name` it was started with.","uniqueKey":"data.setup_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.setup_agent","typeLabel":"string | null"},"claim_url":{"type":"string","format":"uri","description":"The one link for the person: they chat with the agent there, and claim it.","uniqueKey":"data.claim_url","typeLabel":"string\u003curi>"},"claim":{"type":"object","properties":{"email":{"oneOf":[{"type":"string","description":"Prefilled on the sign-up form.","uniqueKey":"data.claim.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Prefilled on the sign-up form.","uniqueKey":"data.claim.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.claim.email","typeLabel":"string | null"},"plan":{"type":"string","const":"free","description":"A claimed agent is always on the Free plan.","uniqueKey":"data.claim.plan","typeLabel":"string"},"claimed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.claim.claimed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.claim.claimed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.claim.claimed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.claim","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","description":"Unclaimed by then, the trial is deleted.","uniqueKey":"data.expires_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","object":"onboarding","status":"active","agent_id":"\u003cstring>","website_url":"\u003cstring>","setup_agent":"\u003cstring>","claim_url":"\u003cstring>","claim":{"email":"\u003cstring>","plan":"free","claimed_at":"2023-11-07T05:31:56Z"},"created_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"d725b2fa-ce55-417c-a06a-64940b9d2d36":{"description":"Not an email address","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"10b0327f-ab70-4b46-813e-07814eddc02c":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"e7f32fd0-a825-40b3-8ee4-a0abfeb4da95":{"description":"Read-only key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"e6c4d8f3-ba3f-47a8-8349-c751f178ec8f":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"41fa7496-2a2e-4675-9d8b-197f3a40e16e":{"description":"Already claimed, deleted or expired","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"ad8146f1-7d02-4323-8f71-7d4c36e6f16c":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"}},"security":{"524f7325-6266-4e2e-aafa-e15694c7a4a2":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key, `wd_...`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"29a18b8b-b0f4-4fe3-bd0c-620d44985920":{"url":"https://wiredesk.ai/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key, `wd_...`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key, `wd_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"wiredesk","siteName":"Wiredesk","title":"Claim an onboarding - Wiredesk","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T20:14:24.257Z","originalFileLocation":"api-reference/onboarding/claim-an-onboarding.mdx"},"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=\"system\"}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=\"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on claim_url they sign up or sign in and press Claim. Someone new gets the trial\u0026#x27;s workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial\u0026#x27;s key stops working once it is claimed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wiredesk\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_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=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Claim an onboarding - Wiredesk\">\u003cmeta data-mint-head property=\"og:description\" content=\"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on claim_url they sign up or sign in and press Claim. Someone new gets the trial\u0026#x27;s workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial\u0026#x27;s key stops working once it is claimed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wiredesk\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wiredesk.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=Claim+an+onboarding\u0026amp;description=Saves+the+email+the+person+will+sign+up+with%2C+and+answers+the+link+where+they+claim+the+agent.+Claiming+itself+takes+the+person%3A+on+%60claim_url%60+they+sign+up+or+\u0026amp;theme=b556289cf0ea9284b957bed9\u0026amp;signature=487f782fbd3716fa15528fb595a6cf2d542d5d23c739b3adde9ad1dc3d5009c0\">\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=\"Claim an onboarding - Wiredesk\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on claim_url they sign up or sign in and press Claim. Someone new gets the trial\u0026#x27;s workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial\u0026#x27;s key stops working once it is claimed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wiredesk.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=Claim+an+onboarding\u0026amp;description=Saves+the+email+the+person+will+sign+up+with%2C+and+answers+the+link+where+they+claim+the+agent.+Claiming+itself+takes+the+person%3A+on+%60claim_url%60+they+sign+up+or+\u0026amp;theme=b556289cf0ea9284b957bed9\u0026amp;signature=487f782fbd3716fa15528fb595a6cf2d542d5d23c739b3adde9ad1dc3d5009c0\">\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=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wiredesk\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/onboarding/claim-an-onboarding.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://wiredesk.ai/#organization\",\"name\":\"Wiredesk\",\"url\":\"https://wiredesk.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/logo/light.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=63b021338caf414206d5334f0e61c038\"}},{\"@type\":\"WebSite\",\"@id\":\"https://wiredesk.ai/docs#website\",\"name\":\"Wiredesk\",\"url\":\"https://wiredesk.ai/docs\",\"publisher\":{\"@id\":\"https://wiredesk.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding#webpage\",\"url\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding\",\"name\":\"Claim an onboarding\",\"description\":\"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on claim_url they sign up or sign in and press Claim. Someone new gets the trial's workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial's key stops working once it is claimed.\",\"dateModified\":\"2026-10-22T20:14:24.257Z\",\"isPartOf\":{\"@id\":\"https://wiredesk.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboarding\",\"item\":\"https://wiredesk.ai/docs/api-reference/onboarding/start-an-onboarding\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Claim an onboarding\",\"item\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding#apireference\",\"headline\":\"Claim an onboarding\",\"name\":\"Claim an onboarding\",\"description\":\"Saves the email the person will sign up with, and answers the link where they claim the agent. Claiming itself takes the person: on claim_url they sign up or sign in and press Claim. Someone new gets the trial's workspace as it is; someone with a workspace gets the agent copied into it. A claimed agent is on the Free plan; the person upgrades later under Billing. The trial's key stops working once it is claimed.\",\"url\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding\",\"mainEntityOfPage\":{\"@id\":\"https://wiredesk.ai/docs/api-reference/onboarding/claim-an-onboarding#webpage\"},\"dateModified\":\"2026-10-22T20:14:24.257Z\",\"publisher\":{\"@id\":\"https://wiredesk.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://wiredesk.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wiredesk\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wiredesk","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"Getting started","icon":"rocket","href":"/api-reference/introduction"},{"title":"Authentication","icon":"lock","href":"/api-reference/authentication"},{"title":"Conventions","icon":"book","href":"/api-reference/conventions"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agent_id}","href":"/api-reference/agents/get-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{agent_id}","href":"/api-reference/agents/update-an-agent"}]},{"group":"Chat","pages":[{"title":"Send a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{agent_id}/chat","href":"/api-reference/chat/send-a-message"}]},{"group":"Knowledge","pages":[{"title":"List knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agent_id}/knowledge","href":"/api-reference/knowledge/list-knowledge-sources"},{"title":"Add a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{agent_id}/knowledge","href":"/api-reference/knowledge/add-a-knowledge-source"},{"title":"Search knowledge","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agent_id}/knowledge/search","href":"/api-reference/knowledge/search-knowledge"},{"title":"Delete a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{agent_id}/knowledge/{source_id}","href":"/api-reference/knowledge/delete-a-knowledge-source"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/search","href":"/api-reference/conversations/search-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-messages"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /leads","href":"/api-reference/leads/list-leads"}]},{"group":"Onboarding","pages":[{"title":"Start an onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding","href":"/api-reference/onboarding/start-an-onboarding"},{"title":"Get an onboarding","description":"How the onboarding stands, and its setup checklist. Fix what is not `done` before you share `claim_url`; knowledge stays `pending` while the site is crawled, usually a minute or two. Works with the trial's key, and with a key of the workspace it was claimed into.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /onboarding/{onboarding_id}","href":"/api-reference/onboarding/get-an-onboarding"},{"title":"Claim an onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/{onboarding_id}/claim","href":"/api-reference/onboarding/claim-an-onboarding"},{"title":"Delete an onboarding","description":"Deletes an unclaimed trial: the agent, its workspace, and the trial's key, which stops working. For when the person does not want the agent or the setup went wrong. Deleting one already deleted or expired answers it as it is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /onboarding/{onboarding_id}","href":"/api-reference/onboarding/delete-an-onboarding"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Claim an onboarding - Wiredesk","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}