externalSystemID: your system’s identifier for this lead.
leadSource, leadStatus, leadValue: optional pipeline fields.
Use name values from GET /api/v1/settings/lead-sources and GET /api/v1/settings/lead-statuses.
noteText / noteType: optional initial lead note (noteType max 45 characters).
201:Location references the new lead; body includes entityKey, leadDetailID, and leadNoteID when a note was created.
If a lead with the same name, surname and email already exists, that lead is returned and any note is added to it.
400: Validation failed, or a client (not a lead) with the same name, surname and email already exists.
Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OnboardMe","description":"Partner API for OnboardMe. Sync clients, send eForms, run KYC, and manage proposals from your own system.","colors":{"primary":"#993260","light":"#E8A0C0","dark":"#7A284E"},"logo":{"light":"https://mintcdn.com/onboardme/BGT2lBPDj7LQtXX6/images/favicon.png?fit=max\u0026auto=format\u0026n=BGT2lBPDj7LQtXX6\u0026q=85\u0026s=62da32dbe9d1a2ffc277ab6f5e2cf015","dark":"https://mintcdn.com/onboardme/BGT2lBPDj7LQtXX6/images/favicon.png?fit=max\u0026auto=format\u0026n=BGT2lBPDj7LQtXX6\u0026q=85\u0026s=62da32dbe9d1a2ffc277ab6f5e2cf015","href":"https://www.onboardme.app/"},"favicon":{"light":"https://mintcdn.com/onboardme/BGT2lBPDj7LQtXX6/images/favicon.png?fit=max\u0026auto=format\u0026n=BGT2lBPDj7LQtXX6\u0026q=85\u0026s=62da32dbe9d1a2ffc277ab6f5e2cf015","dark":"https://mintcdn.com/onboardme/BGT2lBPDj7LQtXX6/images/favicon.png?fit=max\u0026auto=format\u0026n=BGT2lBPDj7LQtXX6\u0026q=85\u0026s=62da32dbe9d1a2ffc277ab6f5e2cf015"},"api":{"openapi":"https://anzapi.onboardme.app/swagger/v1-external/swagger.json"},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://www.onboardme.app/","label":"Website"},{"href":"https://anzapi.onboardme.app/swagger/v1-external/swagger.json","label":"OpenAPI"}],"primary":{"type":"button","label":"Dashboard","href":"https://anz.onboardme.app/"}},"footer":{"socials":{"facebook":"https://www.facebook.com/onboardmeapp","linkedin":"https://www.linkedin.com/company/onboardmeapp","website":"https://www.onboardme.app/"}},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter","weight":400}},"icons":{"library":"fontawesome"},"styling":{"latex":false},"contextual":{"options":["copy","view","download-spec","chatgpt","cursor"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onboardme","hasAudioNarration":false,"actualSubdomain":"onboardme","customDomains":["docs.onboardme.app"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-onboardme-bfcbb9c1","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aed669856455cf9c00ca356","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":205},{"language":"default","tag":"Endpoints","count":193},{"language":"default","tag":"Proposal options","count":28},{"language":"default","tag":"Onboarding management","count":23},{"language":"default","tag":"Proposal updates","count":21},{"language":"default","tag":"Bills","count":15},{"language":"default","tag":"eForms","count":14},{"language":"default","tag":"Proposals","count":12},{"language":"default","tag":"MCP server","count":12},{"language":"default","tag":"Documentation","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/leads/create","slug":"/api-reference/endpoints/leads/create","pageMetadata":{"title":"Create a lead","sidebarTitle":"Create a lead","openapi":"POST /api/v1/leads","description":"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request.\r\n\r\nRequires an API client with **write** access (`canWrite` from `/api/v1/auth/validate`).\r\n\r\n**Body fields (common)**\r\n\r\n- `entityType` / `entityTypeID`: see `/api/v1/settings/entity-types`. Defaults to Individual when omitted.\r\n- **Naming (depends on entity type):**\r\n - **Individual / Sole Trader:** `entityName` (required) = given/first name; `entitySurname` = family/last name. Optional `otherName`, `entityInitials`. Names are **not** split automatically — send both fields.\r\n - **Company and other non-individual types:** `entityName` (required) = full legal or trading name; leave `entitySurname` unset.\r\n- `email`, `mobile`, `telephone`, addresses: optional contact fields.\r\n- `externalSystemID`: your system's identifier for this lead.\r\n- `leadSource`, `leadStatus`, `leadValue`: optional pipeline fields.\r\n Use **`name`** values from **GET `/api/v1/settings/lead-sources`** and **GET `/api/v1/settings/lead-statuses`**.\r\n- `noteText` / `noteType`: optional initial lead note (`noteType` max 45 characters).\r\n\r\n**Example (individual)**\r\n\r\n```json\r\n{\r\n \"entityType\": \"Individual\",\r\n \"entityName\": \"Alex\",\r\n \"entitySurname\": \"Morgan\",\r\n \"email\": \"[email protected]\",\r\n \"leadSource\": \"Website enquiry\",\r\n \"leadStatus\": \"New\"\r\n}\r\n```\r\n\r\n**201:** `Location` references the new lead; body includes `entityKey`, `leadDetailID`, and `leadNoteID` when a note was created.\r\nIf a lead with the same name, surname and email already exists, that lead is returned and any note is added to it.\r\n\r\n**400:** Validation failed, or a client (not a lead) with the same name, surname and email already exists.\r\n\r\n**403:** API client is read-only.\r\n\r\n**429:** Rate limit exceeded.","href":"/api-reference/endpoints/leads/create"},"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 li: \"li\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires an API client with \", _jsx(_components.strong, {\n children: \"write\"\n }), \" access (\", _jsx(_components.code, {\n children: \"canWrite\"\n }), \" from \", _jsx(_components.code, {\n children: \"/api/v1/auth/validate\"\n }), \").\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Body fields (common)\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"entityType\"\n }), \" / \", _jsx(_components.code, {\n children: \"entityTypeID\"\n }), \": see \", _jsx(_components.code, {\n children: \"/api/v1/settings/entity-types\"\n }), \". Defaults to Individual when omitted.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Naming (depends on entity type):\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Individual / Sole Trader:\"\n }), \" \", _jsx(_components.code, {\n children: \"entityName\"\n }), \" (required) = given/first name; \", _jsx(_components.code, {\n children: \"entitySurname\"\n }), \" = family/last name. Optional \", _jsx(_components.code, {\n children: \"otherName\"\n }), \", \", _jsx(_components.code, {\n children: \"entityInitials\"\n }), \". Names are \", _jsx(_components.strong, {\n children: \"not\"\n }), \" split automatically — send both fields.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Company and other non-individual types:\"\n }), \" \", _jsx(_components.code, {\n children: \"entityName\"\n }), \" (required) = full legal or trading name; leave \", _jsx(_components.code, {\n children: \"entitySurname\"\n }), \" unset.\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"email\"\n }), \", \", _jsx(_components.code, {\n children: \"mobile\"\n }), \", \", _jsx(_components.code, {\n children: \"telephone\"\n }), \", addresses: optional contact fields.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"externalSystemID\"\n }), \": your system’s identifier for this lead.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"leadSource\"\n }), \", \", _jsx(_components.code, {\n children: \"leadStatus\"\n }), \", \", _jsx(_components.code, {\n children: \"leadValue\"\n }), \": optional pipeline fields.\\r\\nUse \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"name\"\n })\n }), \" values from \", _jsxs(_components.strong, {\n children: [\"GET \", _jsx(_components.code, {\n children: \"/api/v1/settings/lead-sources\"\n })]\n }), \" and \", _jsxs(_components.strong, {\n children: [\"GET \", _jsx(_components.code, {\n children: \"/api/v1/settings/lead-statuses\"\n })]\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"noteText\"\n }), \" / \", _jsx(_components.code, {\n children: \"noteType\"\n }), \": optional initial lead note (\", _jsx(_components.code, {\n children: \"noteType\"\n }), \" max 45 characters).\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example (individual)\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"8\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"8\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"entityType\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Individual\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"entityName\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Alex\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"entitySurname\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Morgan\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"email\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"[email protected]\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"leadSource\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Website enquiry\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"leadStatus\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"New\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"201:\"\n }), \" \", _jsx(_components.code, {\n children: \"Location\"\n }), \" references the new lead; body includes \", _jsx(_components.code, {\n children: \"entityKey\"\n }), \", \", _jsx(_components.code, {\n children: \"leadDetailID\"\n }), \", and \", _jsx(_components.code, {\n children: \"leadNoteID\"\n }), \" when a note was created.\\r\\nIf a lead with the same name, surname and email already exists, that lead is returned and any note is added to it.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"400:\"\n }), \" Validation failed, or a client (not a lead) with the same name, surname and email already exists.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"403:\"\n }), \" API client is read-only.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"429:\"\n }), \" Rate limit exceeded.\"]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function DensityStyles(){return _jsx(`style`,{children:`#page-title{font-size:1.5rem!important;line-height:1.25!important;letter-spacing:-.02em;margin-bottom:.4rem!important}#content-area{font-size:.9375rem;line-height:1.55}#content-area p{margin-top:.55em;margin-bottom:.55em}#api-playground-input,#request-example,#response-example{font-size:.8125rem}api-section-heading-title{font-size:1.5rem!important;line-height:1.25!important}api-section-heading{margin-bottom:.5rem}field{padding-top:.35rem;padding-bottom:.35rem;font-size:.875rem}tryit-button{font-size:.8rem}`})}function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`DensityStyles`,children:_jsx(DensityStyles,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{DensityStyles,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a lead","sidebarTitle":"Create a lead","openapi":"POST /api/v1/leads","description":"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request.\r\n\r\nRequires an API client with **write** access (`canWrite` from `/api/v1/auth/validate`).\r\n\r\n**Body fields (common)**\r\n\r\n- `entityType` / `entityTypeID`: see `/api/v1/settings/entity-types`. Defaults to Individual when omitted.\r\n- **Naming (depends on entity type):**\r\n - **Individual / Sole Trader:** `entityName` (required) = given/first name; `entitySurname` = family/last name. Optional `otherName`, `entityInitials`. Names are **not** split automatically — send both fields.\r\n - **Company and other non-individual types:** `entityName` (required) = full legal or trading name; leave `entitySurname` unset.\r\n- `email`, `mobile`, `telephone`, addresses: optional contact fields.\r\n- `externalSystemID`: your system's identifier for this lead.\r\n- `leadSource`, `leadStatus`, `leadValue`: optional pipeline fields.\r\n Use **`name`** values from **GET `/api/v1/settings/lead-sources`** and **GET `/api/v1/settings/lead-statuses`**.\r\n- `noteText` / `noteType`: optional initial lead note (`noteType` max 45 characters).\r\n\r\n**Example (individual)**\r\n\r\n```json\r\n{\r\n \"entityType\": \"Individual\",\r\n \"entityName\": \"Alex\",\r\n \"entitySurname\": \"Morgan\",\r\n \"email\": \"[email protected]\",\r\n \"leadSource\": \"Website enquiry\",\r\n \"leadStatus\": \"New\"\r\n}\r\n```\r\n\r\n**201:** `Location` references the new lead; body includes `entityKey`, `leadDetailID`, and `leadNoteID` when a note was created.\r\nIf a lead with the same name, surname and email already exists, that lead is returned and any note is added to it.\r\n\r\n**400:** Validation failed, or a client (not a lead) with the same name, surname and email already exists.\r\n\r\n**403:** API client is read-only.\r\n\r\n**429:** Rate limit exceeded.","href":"/api-reference/endpoints/leads/create"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[98,680,"const DensityStyles=()=>null;function _c"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Leads"],"summary":"Create a lead","description":"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request.\r\n\r\nRequires an API client with **write** access (`canWrite` from `/api/v1/auth/validate`).\r\n\r\n**Body fields (common)**\r\n\r\n- `entityType` / `entityTypeID`: see `/api/v1/settings/entity-types`. Defaults to Individual when omitted.\r\n- **Naming (depends on entity type):**\r\n - **Individual / Sole Trader:** `entityName` (required) = given/first name; `entitySurname` = family/last name. Optional `otherName`, `entityInitials`. Names are **not** split automatically — send both fields.\r\n - **Company and other non-individual types:** `entityName` (required) = full legal or trading name; leave `entitySurname` unset.\r\n- `email`, `mobile`, `telephone`, addresses: optional contact fields.\r\n- `externalSystemID`: your system's identifier for this lead.\r\n- `leadSource`, `leadStatus`, `leadValue`: optional pipeline fields.\r\n Use **`name`** values from **GET `/api/v1/settings/lead-sources`** and **GET `/api/v1/settings/lead-statuses`**.\r\n- `noteText` / `noteType`: optional initial lead note (`noteType` max 45 characters).\r\n\r\n**Example (individual)**\r\n\r\n```json\r\n{\r\n \"entityType\": \"Individual\",\r\n \"entityName\": \"Alex\",\r\n \"entitySurname\": \"Morgan\",\r\n \"email\": \"[email protected]\",\r\n \"leadSource\": \"Website enquiry\",\r\n \"leadStatus\": \"New\"\r\n}\r\n```\r\n\r\n**201:** `Location` references the new lead; body includes `entityKey`, `leadDetailID`, and `leadNoteID` when a note was created.\r\nIf a lead with the same name, surname and email already exists, that lead is returned and any note is added to it.\r\n\r\n**400:** Validation failed, or a client (not a lead) with the same name, surname and email already exists.\r\n\r\n**403:** API client is read-only.\r\n\r\n**429:** Rate limit exceeded.","requestBody":"fefb98eb-0416-4235-b3f3-e55d04fc3668","responses":{"201":"c6a9cc05-d9bb-41e7-b671-d7ab15f13c09","400":"a8355229-69ee-4a6f-b5d2-036cb7e72f7a","401":"1813d66e-158c-494e-9a1a-8c4eafde0cb0","403":"6a2a4032-3236-47c7-9703-0d4c19229c87","429":"27eca951-1a11-441b-8704-caa13dc7c07d","500":"9ff1433d-de67-4fcc-87ad-cc81f22404ca"},"method":"post","type":"path","servers":["ee345cd5-dcbe-4cfb-96f1-d1871b11b501","1e1159eb-15c3-4d91-96a3-b564747d61dd","3242db07-d6bc-4b9d-937d-3443a5fac374"],"security":["f9620114-7dcc-4ae5-a57e-92cb0e5f8c15"],"path":"/api/v1/leads","baseUrlOptions":["https://anzapi.onboardme.app","https://ukapi.onboardme.app","https://zaapi.onboardme.app"],"title":"Create a lead","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"entityTypeID":{"type":"integer","format":"int32","uniqueKey":"entityTypeID","typeLabel":"integer\u003cint32>"},"entityType":{"oneOf":[{"maxLength":50,"type":"string","uniqueKey":"entityType.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","uniqueKey":"entityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityType","typeLabel":"string | null"},"entityCode":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"entityCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"entityCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityCode","typeLabel":"string | null"},"externalSystemID":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"externalSystemID.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"externalSystemID.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSystemID","typeLabel":"string | null"},"entityName":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"entityName.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"entityName.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityName","typeLabel":"string | null"},"otherName":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"otherName.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"otherName.oneOf.1","typeLabel":"null"}],"uniqueKey":"otherName","typeLabel":"string | null"},"entitySurname":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"entitySurname.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"entitySurname.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitySurname","typeLabel":"string | null"},"entityInitials":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"entityInitials.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"entityInitials.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInitials","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"birthDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthDate","typeLabel":"string\u003cdate> | null"},"incorporationDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"incorporationDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"incorporationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"incorporationDate","typeLabel":"string\u003cdate> | null"},"birthPlace":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"birthPlace.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"birthPlace.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthPlace","typeLabel":"string | null"},"birthTown":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"birthTown.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"birthTown.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthTown","typeLabel":"string | null"},"birthState":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"birthState.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"birthState.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthState","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"telephone":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"telephone.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"telephone.oneOf.1","typeLabel":"null"}],"uniqueKey":"telephone","typeLabel":"string | null"},"mobile":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"mobile.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"mobile.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobile","typeLabel":"string | null"},"taxNumber":{"oneOf":[{"maxLength":15,"type":"string","uniqueKey":"taxNumber.oneOf.0","typeLabel":"string"},{"maxLength":15,"type":"null","uniqueKey":"taxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxNumber","typeLabel":"string | null"},"taxNotRequired":{"type":"boolean","uniqueKey":"taxNotRequired","typeLabel":"boolean"},"salesTaxNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"salesTaxNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"salesTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesTaxNumber","typeLabel":"string | null"},"regNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"regNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"regNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"regNumber","typeLabel":"string | null"},"idNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"idNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"idNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"idNumber","typeLabel":"string | null"},"gender":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"gender.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"gender","typeLabel":"string | null"},"note":{"oneOf":[{"maxLength":65535,"type":"string","uniqueKey":"note.oneOf.0","typeLabel":"string"},{"maxLength":65535,"type":"null","uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"physicalAddress":{"type":"object","properties":{"address1":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address1.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address2.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address3.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address3.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address3","typeLabel":"string | null"},"address4":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address4.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address4.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address4","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"physicalAddress.postcode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"physicalAddress.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"physicalAddress","typeLabel":"object"},"postalAddress":{"type":"object","properties":{"address1":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address1.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address2.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address3.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address3.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address3","typeLabel":"string | null"},"address4":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address4.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address4.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address4","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"postalAddress.postcode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"postalAddress.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"postalAddress","typeLabel":"object"},"leadSource":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"leadSource.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"leadSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadSource","typeLabel":"string | null"},"leadStatus":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"leadStatus.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"leadStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadStatus","typeLabel":"string | null"},"leadValue":{"oneOf":[{"maximum":99999999.99,"minimum":0,"type":"number","format":"double","uniqueKey":"leadValue.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":99999999.99,"minimum":0,"type":"null","format":"double","uniqueKey":"leadValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadValue","typeLabel":"number\u003cdouble> | null"},"ownerUserKey":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"ownerUserKey.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"ownerUserKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"ownerUserKey","typeLabel":"string\u003cuuid> | null"},"expectedCloseDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"expectedCloseDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"expectedCloseDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedCloseDate","typeLabel":"string\u003cdate> | null"},"rating":{"oneOf":[{"maximum":3,"minimum":1,"type":"integer","format":"int32","uniqueKey":"rating.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":3,"minimum":1,"type":"null","format":"int32","uniqueKey":"rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating","typeLabel":"integer\u003cint32> | null"},"referredBy":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"referredBy.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"referredBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"referredBy","typeLabel":"string | null"},"noteText":{"oneOf":[{"maxLength":65535,"type":"string","uniqueKey":"noteText.oneOf.0","typeLabel":"string"},{"maxLength":65535,"type":"null","uniqueKey":"noteText.oneOf.1","typeLabel":"null"}],"uniqueKey":"noteText","typeLabel":"string | null"},"noteType":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"noteType.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"noteType.oneOf.1","typeLabel":"null"}],"uniqueKey":"noteType","typeLabel":"string | null"}},"additionalProperties":false,"example":{"entityType":"Individual","entityName":"Alex","entitySurname":"Morgan","email":"[email protected]","mobile":"+61 400 555 010","externalSystemID":"CRM-LEAD-9901","leadSource":"Website enquiry","leadStatus":"New","leadValue":3200,"noteText":"Interested in annual compliance and bookkeeping.","noteType":"API intake"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityType":"Individual","entityName":"Alex","entitySurname":"Morgan","email":"[email protected]","mobile":"+61 400 555 010","externalSystemID":"CRM-LEAD-9901","leadSource":"Website enquiry","leadStatus":"New","leadValue":3200,"noteText":"Interested in annual compliance and bookkeeping.","noteType":"API intake"}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"entityTypeID":{"type":"integer","format":"int32","uniqueKey":"entityTypeID","typeLabel":"integer\u003cint32>"},"entityType":{"oneOf":[{"maxLength":50,"type":"string","uniqueKey":"entityType.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","uniqueKey":"entityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityType","typeLabel":"string | null"},"entityCode":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"entityCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"entityCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityCode","typeLabel":"string | null"},"externalSystemID":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"externalSystemID.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"externalSystemID.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSystemID","typeLabel":"string | null"},"entityName":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"entityName.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"entityName.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityName","typeLabel":"string | null"},"otherName":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"otherName.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"otherName.oneOf.1","typeLabel":"null"}],"uniqueKey":"otherName","typeLabel":"string | null"},"entitySurname":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"entitySurname.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"entitySurname.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitySurname","typeLabel":"string | null"},"entityInitials":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"entityInitials.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"entityInitials.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInitials","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"birthDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthDate","typeLabel":"string\u003cdate> | null"},"incorporationDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"incorporationDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"incorporationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"incorporationDate","typeLabel":"string\u003cdate> | null"},"birthPlace":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"birthPlace.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"birthPlace.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthPlace","typeLabel":"string | null"},"birthTown":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"birthTown.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"birthTown.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthTown","typeLabel":"string | null"},"birthState":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"birthState.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"birthState.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthState","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"telephone":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"telephone.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"telephone.oneOf.1","typeLabel":"null"}],"uniqueKey":"telephone","typeLabel":"string | null"},"mobile":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"mobile.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"mobile.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobile","typeLabel":"string | null"},"taxNumber":{"oneOf":[{"maxLength":15,"type":"string","uniqueKey":"taxNumber.oneOf.0","typeLabel":"string"},{"maxLength":15,"type":"null","uniqueKey":"taxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxNumber","typeLabel":"string | null"},"taxNotRequired":{"type":"boolean","uniqueKey":"taxNotRequired","typeLabel":"boolean"},"salesTaxNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"salesTaxNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"salesTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesTaxNumber","typeLabel":"string | null"},"regNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"regNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"regNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"regNumber","typeLabel":"string | null"},"idNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"idNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"idNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"idNumber","typeLabel":"string | null"},"gender":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"gender.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"gender","typeLabel":"string | null"},"note":{"oneOf":[{"maxLength":65535,"type":"string","uniqueKey":"note.oneOf.0","typeLabel":"string"},{"maxLength":65535,"type":"null","uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"physicalAddress":{"type":"object","properties":{"address1":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address1.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address2.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address3.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address3.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address3","typeLabel":"string | null"},"address4":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address4.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address4.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address4","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"physicalAddress.postcode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"physicalAddress.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"physicalAddress","typeLabel":"object"},"postalAddress":{"type":"object","properties":{"address1":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address1.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address2.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address3.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address3.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address3","typeLabel":"string | null"},"address4":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address4.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address4.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address4","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"postalAddress.postcode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"postalAddress.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"postalAddress","typeLabel":"object"},"leadSource":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"leadSource.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"leadSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadSource","typeLabel":"string | null"},"leadStatus":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"leadStatus.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"leadStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadStatus","typeLabel":"string | null"},"leadValue":{"oneOf":[{"maximum":99999999.99,"minimum":0,"type":"number","format":"double","uniqueKey":"leadValue.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":99999999.99,"minimum":0,"type":"null","format":"double","uniqueKey":"leadValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadValue","typeLabel":"number\u003cdouble> | null"},"ownerUserKey":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"ownerUserKey.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"ownerUserKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"ownerUserKey","typeLabel":"string\u003cuuid> | null"},"expectedCloseDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"expectedCloseDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"expectedCloseDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedCloseDate","typeLabel":"string\u003cdate> | null"},"rating":{"oneOf":[{"maximum":3,"minimum":1,"type":"integer","format":"int32","uniqueKey":"rating.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":3,"minimum":1,"type":"null","format":"int32","uniqueKey":"rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating","typeLabel":"integer\u003cint32> | null"},"referredBy":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"referredBy.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"referredBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"referredBy","typeLabel":"string | null"},"noteText":{"oneOf":[{"maxLength":65535,"type":"string","uniqueKey":"noteText.oneOf.0","typeLabel":"string"},{"maxLength":65535,"type":"null","uniqueKey":"noteText.oneOf.1","typeLabel":"null"}],"uniqueKey":"noteText","typeLabel":"string | null"},"noteType":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"noteType.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"noteType.oneOf.1","typeLabel":"null"}],"uniqueKey":"noteType","typeLabel":"string | null"}},"additionalProperties":false,"example":{"entityType":"Individual","entityName":"Alex","entitySurname":"Morgan","email":"[email protected]","mobile":"+61 400 555 010","externalSystemID":"CRM-LEAD-9901","leadSource":"Website enquiry","leadStatus":"New","leadValue":3200,"noteText":"Interested in annual compliance and bookkeeping.","noteType":"API intake"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityType":"Individual","entityName":"Alex","entitySurname":"Morgan","email":"[email protected]","mobile":"+61 400 555 010","externalSystemID":"CRM-LEAD-9901","leadSource":"Website enquiry","leadStatus":"New","leadValue":3200,"noteText":"Interested in annual compliance and bookkeeping.","noteType":"API intake"}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"entityTypeID":{"type":"integer","format":"int32","uniqueKey":"entityTypeID","typeLabel":"integer\u003cint32>"},"entityType":{"oneOf":[{"maxLength":50,"type":"string","uniqueKey":"entityType.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","uniqueKey":"entityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityType","typeLabel":"string | null"},"entityCode":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"entityCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"entityCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityCode","typeLabel":"string | null"},"externalSystemID":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"externalSystemID.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"externalSystemID.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSystemID","typeLabel":"string | null"},"entityName":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"entityName.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"entityName.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityName","typeLabel":"string | null"},"otherName":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"otherName.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"otherName.oneOf.1","typeLabel":"null"}],"uniqueKey":"otherName","typeLabel":"string | null"},"entitySurname":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"entitySurname.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"entitySurname.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitySurname","typeLabel":"string | null"},"entityInitials":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"entityInitials.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"entityInitials.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityInitials","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"birthDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"birthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthDate","typeLabel":"string\u003cdate> | null"},"incorporationDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"incorporationDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"incorporationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"incorporationDate","typeLabel":"string\u003cdate> | null"},"birthPlace":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"birthPlace.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"birthPlace.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthPlace","typeLabel":"string | null"},"birthTown":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"birthTown.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"birthTown.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthTown","typeLabel":"string | null"},"birthState":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"birthState.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"birthState.oneOf.1","typeLabel":"null"}],"uniqueKey":"birthState","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"telephone":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"telephone.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"telephone.oneOf.1","typeLabel":"null"}],"uniqueKey":"telephone","typeLabel":"string | null"},"mobile":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"mobile.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"mobile.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobile","typeLabel":"string | null"},"taxNumber":{"oneOf":[{"maxLength":15,"type":"string","uniqueKey":"taxNumber.oneOf.0","typeLabel":"string"},{"maxLength":15,"type":"null","uniqueKey":"taxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxNumber","typeLabel":"string | null"},"taxNotRequired":{"type":"boolean","uniqueKey":"taxNotRequired","typeLabel":"boolean"},"salesTaxNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"salesTaxNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"salesTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesTaxNumber","typeLabel":"string | null"},"regNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"regNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"regNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"regNumber","typeLabel":"string | null"},"idNumber":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"idNumber.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"idNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"idNumber","typeLabel":"string | null"},"gender":{"oneOf":[{"maxLength":10,"type":"string","uniqueKey":"gender.oneOf.0","typeLabel":"string"},{"maxLength":10,"type":"null","uniqueKey":"gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"gender","typeLabel":"string | null"},"note":{"oneOf":[{"maxLength":65535,"type":"string","uniqueKey":"note.oneOf.0","typeLabel":"string"},{"maxLength":65535,"type":"null","uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"physicalAddress":{"type":"object","properties":{"address1":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address1.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address2.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address3.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address3.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address3","typeLabel":"string | null"},"address4":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.address4.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.address4.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.address4","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"physicalAddress.postcode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"physicalAddress.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"physicalAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"physicalAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"physicalAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"physicalAddress","typeLabel":"object"},"postalAddress":{"type":"object","properties":{"address1":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address1.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address2.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address3.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address3.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address3","typeLabel":"string | null"},"address4":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.address4.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.address4.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.address4","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"maxLength":20,"type":"string","uniqueKey":"postalAddress.postcode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","uniqueKey":"postalAddress.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"maxLength":100,"type":"string","uniqueKey":"postalAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","uniqueKey":"postalAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"postalAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"postalAddress","typeLabel":"object"},"leadSource":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"leadSource.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"leadSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadSource","typeLabel":"string | null"},"leadStatus":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"leadStatus.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"leadStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadStatus","typeLabel":"string | null"},"leadValue":{"oneOf":[{"maximum":99999999.99,"minimum":0,"type":"number","format":"double","uniqueKey":"leadValue.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":99999999.99,"minimum":0,"type":"null","format":"double","uniqueKey":"leadValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadValue","typeLabel":"number\u003cdouble> | null"},"ownerUserKey":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"ownerUserKey.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"ownerUserKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"ownerUserKey","typeLabel":"string\u003cuuid> | null"},"expectedCloseDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"expectedCloseDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"expectedCloseDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedCloseDate","typeLabel":"string\u003cdate> | null"},"rating":{"oneOf":[{"maximum":3,"minimum":1,"type":"integer","format":"int32","uniqueKey":"rating.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":3,"minimum":1,"type":"null","format":"int32","uniqueKey":"rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating","typeLabel":"integer\u003cint32> | null"},"referredBy":{"oneOf":[{"maxLength":255,"type":"string","uniqueKey":"referredBy.oneOf.0","typeLabel":"string"},{"maxLength":255,"type":"null","uniqueKey":"referredBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"referredBy","typeLabel":"string | null"},"noteText":{"oneOf":[{"maxLength":65535,"type":"string","uniqueKey":"noteText.oneOf.0","typeLabel":"string"},{"maxLength":65535,"type":"null","uniqueKey":"noteText.oneOf.1","typeLabel":"null"}],"uniqueKey":"noteText","typeLabel":"string | null"},"noteType":{"oneOf":[{"maxLength":45,"type":"string","uniqueKey":"noteType.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","uniqueKey":"noteType.oneOf.1","typeLabel":"null"}],"uniqueKey":"noteType","typeLabel":"string | null"}},"additionalProperties":false,"example":{"entityType":"Individual","entityName":"Alex","entitySurname":"Morgan","email":"[email protected]","mobile":"+61 400 555 010","externalSystemID":"CRM-LEAD-9901","leadSource":"Website enquiry","leadStatus":"New","leadValue":3200,"noteText":"Interested in annual compliance and bookkeeping.","noteType":"API intake"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityType":"Individual","entityName":"Alex","entitySurname":"Morgan","email":"[email protected]","mobile":"+61 400 555 010","externalSystemID":"CRM-LEAD-9901","leadSource":"Website enquiry","leadStatus":"New","leadValue":3200,"noteText":"Interested in annual compliance and bookkeeping.","noteType":"API intake"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c6a9cc05-d9bb-41e7-b671-d7ab15f13c09":{"description":"Created","content":{"text/plain":{"schema":{"type":"object","properties":{"entityKey":{"oneOf":[{"type":"string","uniqueKey":"entityKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityKey","typeLabel":"string | null"},"leadDetailID":{"type":"integer","format":"int64","uniqueKey":"leadDetailID","typeLabel":"integer\u003cint64>"},"leadNoteID":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"leadNoteID.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"leadNoteID.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadNoteID","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"example":{"entityKey":"2c4f6a88-1b3d-5e7f-90ab-cdef12345678","leadDetailID":501,"leadNoteID":8801},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityKey":"2c4f6a88-1b3d-5e7f-90ab-cdef12345678","leadDetailID":501,"leadNoteID":8801}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"entityKey":{"oneOf":[{"type":"string","uniqueKey":"entityKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityKey","typeLabel":"string | null"},"leadDetailID":{"type":"integer","format":"int64","uniqueKey":"leadDetailID","typeLabel":"integer\u003cint64>"},"leadNoteID":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"leadNoteID.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"leadNoteID.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadNoteID","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"example":{"entityKey":"2c4f6a88-1b3d-5e7f-90ab-cdef12345678","leadDetailID":501,"leadNoteID":8801},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityKey":"2c4f6a88-1b3d-5e7f-90ab-cdef12345678","leadDetailID":501,"leadNoteID":8801}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"entityKey":{"oneOf":[{"type":"string","uniqueKey":"entityKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"entityKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"entityKey","typeLabel":"string | null"},"leadDetailID":{"type":"integer","format":"int64","uniqueKey":"leadDetailID","typeLabel":"integer\u003cint64>"},"leadNoteID":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"leadNoteID.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"leadNoteID.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadNoteID","typeLabel":"integer\u003cint64> | null"}},"additionalProperties":false,"example":{"entityKey":"2c4f6a88-1b3d-5e7f-90ab-cdef12345678","leadDetailID":501,"leadNoteID":8801},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entityKey":"2c4f6a88-1b3d-5e7f-90ab-cdef12345678","leadDetailID":501,"leadNoteID":8801}}},"exampleType":"generated"}},"exampleType":"generated"},"a8355229-69ee-4a6f-b5d2-036cb7e72f7a":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1813d66e-158c-494e-9a1a-8c4eafde0cb0":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6a2a4032-3236-47c7-9703-0d4c19229c87":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"27eca951-1a11-441b-8704-caa13dc7c07d":{"description":"Too Many Requests","content":{"text/plain":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ff1433d-de67-4fcc-87ad-cc81f22404ca":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"f9620114-7dcc-4ae5-a57e-92cb0e5f8c15":{"ApiClientCredentials":{"type":"http","description":"Swagger / Postman only: **Client ID** as username, **Client secret** as password. In Postman, set this once on the **collection** (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer **`X-OM-Auth-ID`** and **`X-OM-Auth-Key`** headers.","scheme":"basic","scopes":[],"schemeName":"ApiClientCredentials"}}},"servers":{"ee345cd5-dcbe-4cfb-96f1-d1871b11b501":{"url":"https://anzapi.onboardme.app","description":"Australia \u0026 New Zealand — ANZ-hosted practices"},"1e1159eb-15c3-4d91-96a3-b564747d61dd":{"url":"https://ukapi.onboardme.app","description":"United Kingdom — UK-hosted practices"},"3242db07-d6bc-4b9d-937d-3443a5fac374":{"url":"https://zaapi.onboardme.app","description":"South Africa — ZA-hosted practices"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Swagger / Postman only: **Client ID** as username, **Client secret** as password. In Postman, set this once on the **collection** (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer **`X-OM-Auth-ID`** and **`X-OM-Auth-Key`** headers.","scheme":"basic","scopes":[],"schemeName":"ApiClientCredentials"},"schema":{"title":"Basic Auth","type":"object","description":"Swagger / Postman only: **Client ID** as username, **Client secret** as password. In Postman, set this once on the **collection** (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer **`X-OM-Auth-ID`** and **`X-OM-Auth-Key`** headers.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"ApiClientCredentials","name":"Authorization"}],"title":"ApiClientCredentials"}]},"originalFileLocation":"https://anzapi.onboardme.app/swagger/v1-external/swagger.json"},"subdomain":"onboardme","siteName":"OnboardMe","title":"Create a lead - OnboardMe","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T10:01:59.348Z","originalFileLocation":"api-reference/endpoints/leads/create.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=\"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=\"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request. Requires an API client with write access (canWrite from /api/v1/auth/validate). Body fields (common) - entityType / entityTypeID: see /api/v1/settings/entity-types. Defaults to Individual when omitted. - Naming (depends on entity type): - Individual / Sole Trader: entityName (required) = given/first name; entitySurname = family/last name. Optional otherName, entityInitials. Names are not split automatically — send both fields. - Company and other non-individual types: entityName (required) = full legal or trading name; leave entitySurname unset. - email, mobile, telephone, addresses: optional contact fields. - externalSystemID: your system\u0026#x27;s identifier for this lead. - leadSource, leadStatus, leadValue: optional pipeline fields. Use name values from GET /api/v1/settings/lead-sources and GET /api/v1/settings/lead-statuses. - noteText / noteType: optional initial lead note (noteType max 45 characters). Example (individual) json { \u0026quot;entityType\u0026quot;: \u0026quot;Individual\u0026quot;, \u0026quot;entityName\u0026quot;: \u0026quot;Alex\u0026quot;, \u0026quot;entitySurname\u0026quot;: \u0026quot;Morgan\u0026quot;, \u0026quot;email\u0026quot;: \u0026quot;[email protected]\u0026quot;, \u0026quot;leadSource\u0026quot;: \u0026quot;Website enquiry\u0026quot;, \u0026quot;leadStatus\u0026quot;: \u0026quot;New\u0026quot; } 201: Location references the new lead; body includes entityKey, leadDetailID, and leadNoteID when a note was created. If a lead with the same name, surname and email already exists, that lead is returned and any note is added to it. 400: Validation failed, or a client (not a lead) with the same name, surname and email already exists. 403: API client is read-only. 429: Rate limit exceeded.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OnboardMe\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_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/onboardme/qOZJIJz2HwqXQVkm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a lead - OnboardMe\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request. Requires an API client with write access (canWrite from /api/v1/auth/validate). Body fields (common) - entityType / entityTypeID: see /api/v1/settings/entity-types. Defaults to Individual when omitted. - Naming (depends on entity type): - Individual / Sole Trader: entityName (required) = given/first name; entitySurname = family/last name. Optional otherName, entityInitials. Names are not split automatically — send both fields. - Company and other non-individual types: entityName (required) = full legal or trading name; leave entitySurname unset. - email, mobile, telephone, addresses: optional contact fields. - externalSystemID: your system\u0026#x27;s identifier for this lead. - leadSource, leadStatus, leadValue: optional pipeline fields. Use name values from GET /api/v1/settings/lead-sources and GET /api/v1/settings/lead-statuses. - noteText / noteType: optional initial lead note (noteType max 45 characters). Example (individual) json { \u0026quot;entityType\u0026quot;: \u0026quot;Individual\u0026quot;, \u0026quot;entityName\u0026quot;: \u0026quot;Alex\u0026quot;, \u0026quot;entitySurname\u0026quot;: \u0026quot;Morgan\u0026quot;, \u0026quot;email\u0026quot;: \u0026quot;[email protected]\u0026quot;, \u0026quot;leadSource\u0026quot;: \u0026quot;Website enquiry\u0026quot;, \u0026quot;leadStatus\u0026quot;: \u0026quot;New\u0026quot; } 201: Location references the new lead; body includes entityKey, leadDetailID, and leadNoteID when a note was created. If a lead with the same name, surname and email already exists, that lead is returned and any note is added to it. 400: Validation failed, or a client (not a lead) with the same name, surname and email already exists. 403: API client is read-only. 429: Rate limit exceeded.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OnboardMe\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onboardme.app/api-reference/endpoints/leads/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onboardme.mintlify.site/_mintlify/api/og/v2?division=Leads\u0026amp;title=Create+a+lead\u0026amp;description=Creates+a+new+lead+in+the+practice%3A+a+client+entity+with+lead+status%2C+lead+details%2C+and+optionally+an+initial+note+in+one+request.%0D%0A%0D%0ARequires+an+API+client+wit\u0026amp;theme=0d2dda3df682593863184312\u0026amp;signature=fa8f26db22a5def88eedba2cf7decdc5842b3d4cd52c48e298304d032ac756a6\">\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=\"Create a lead - OnboardMe\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request. Requires an API client with write access (canWrite from /api/v1/auth/validate). Body fields (common) - entityType / entityTypeID: see /api/v1/settings/entity-types. Defaults to Individual when omitted. - Naming (depends on entity type): - Individual / Sole Trader: entityName (required) = given/first name; entitySurname = family/last name. Optional otherName, entityInitials. Names are not split automatically — send both fields. - Company and other non-individual types: entityName (required) = full legal or trading name; leave entitySurname unset. - email, mobile, telephone, addresses: optional contact fields. - externalSystemID: your system\u0026#x27;s identifier for this lead. - leadSource, leadStatus, leadValue: optional pipeline fields. Use name values from GET /api/v1/settings/lead-sources and GET /api/v1/settings/lead-statuses. - noteText / noteType: optional initial lead note (noteType max 45 characters). Example (individual) json { \u0026quot;entityType\u0026quot;: \u0026quot;Individual\u0026quot;, \u0026quot;entityName\u0026quot;: \u0026quot;Alex\u0026quot;, \u0026quot;entitySurname\u0026quot;: \u0026quot;Morgan\u0026quot;, \u0026quot;email\u0026quot;: \u0026quot;[email protected]\u0026quot;, \u0026quot;leadSource\u0026quot;: \u0026quot;Website enquiry\u0026quot;, \u0026quot;leadStatus\u0026quot;: \u0026quot;New\u0026quot; } 201: Location references the new lead; body includes entityKey, leadDetailID, and leadNoteID when a note was created. If a lead with the same name, surname and email already exists, that lead is returned and any note is added to it. 400: Validation failed, or a client (not a lead) with the same name, surname and email already exists. 403: API client is read-only. 429: Rate limit exceeded.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onboardme.mintlify.site/_mintlify/api/og/v2?division=Leads\u0026amp;title=Create+a+lead\u0026amp;description=Creates+a+new+lead+in+the+practice%3A+a+client+entity+with+lead+status%2C+lead+details%2C+and+optionally+an+initial+note+in+one+request.%0D%0A%0D%0ARequires+an+API+client+wit\u0026amp;theme=0d2dda3df682593863184312\u0026amp;signature=fa8f26db22a5def88eedba2cf7decdc5842b3d4cd52c48e298304d032ac756a6\">\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/onboardme/qOZJIJz2HwqXQVkm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OnboardMe\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#993260\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onboardme.app/api-reference/endpoints/leads/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/leads/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onboardme.app/#organization\",\"name\":\"OnboardMe\",\"url\":\"https://docs.onboardme.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onboardme/BGT2lBPDj7LQtXX6/images/favicon.png?fit=max\u0026auto=format\u0026n=BGT2lBPDj7LQtXX6\u0026q=85\u0026s=62da32dbe9d1a2ffc277ab6f5e2cf015\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onboardme.app#website\",\"name\":\"OnboardMe\",\"url\":\"https://docs.onboardme.app\",\"publisher\":{\"@id\":\"https://docs.onboardme.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create#webpage\",\"url\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create\",\"name\":\"Create a lead\",\"description\":\"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request. Requires an API client with write access (canWrite from /api/v1/auth/validate). Body fields (common) - entityType / entityTypeID: see /api/v1/settings/entity-types. Defaults to Individual when omitted. - Naming (depends on entity type): - Individual / Sole Trader: entityName (required) = given/first name; entitySurname = family/last name. Optional otherName, entityInitials. Names are not split automatically — send both fields. - Company and other non-individual types: entityName (required) = full legal or trading name; leave entitySurname unset. - email, mobile, telephone, addresses: optional contact fields. - externalSystemID: your system's identifier for this lead. - leadSource, leadStatus, leadValue: optional pipeline fields. Use name values from GET /api/v1/settings/lead-sources and GET /api/v1/settings/lead-statuses. - noteText / noteType: optional initial lead note (noteType max 45 characters). Example (individual) json { \\\"entityType\\\": \\\"Individual\\\", \\\"entityName\\\": \\\"Alex\\\", \\\"entitySurname\\\": \\\"Morgan\\\", \\\"email\\\": \\\"[email protected]\\\", \\\"leadSource\\\": \\\"Website enquiry\\\", \\\"leadStatus\\\": \\\"New\\\" } 201: Location references the new lead; body includes entityKey, leadDetailID, and leadNoteID when a note was created. If a lead with the same name, surname and email already exists, that lead is returned and any note is added to it. 400: Validation failed, or a client (not a lead) with the same name, surname and email already exists. 403: API client is read-only. 429: Rate limit exceeded.\",\"dateModified\":\"2026-10-14T10:01:59.348Z\",\"isPartOf\":{\"@id\":\"https://docs.onboardme.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.onboardme.app/api-reference/endpoints/id-verifications/send\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Leads\",\"item\":\"https://docs.onboardme.app/api-reference/endpoints/leads/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a lead\",\"item\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create#apireference\",\"headline\":\"Create a lead\",\"name\":\"Create a lead\",\"description\":\"Creates a new lead in the practice: a client entity with lead status, lead details, and optionally an initial note in one request. Requires an API client with write access (canWrite from /api/v1/auth/validate). Body fields (common) - entityType / entityTypeID: see /api/v1/settings/entity-types. Defaults to Individual when omitted. - Naming (depends on entity type): - Individual / Sole Trader: entityName (required) = given/first name; entitySurname = family/last name. Optional otherName, entityInitials. Names are not split automatically — send both fields. - Company and other non-individual types: entityName (required) = full legal or trading name; leave entitySurname unset. - email, mobile, telephone, addresses: optional contact fields. - externalSystemID: your system's identifier for this lead. - leadSource, leadStatus, leadValue: optional pipeline fields. Use name values from GET /api/v1/settings/lead-sources and GET /api/v1/settings/lead-statuses. - noteText / noteType: optional initial lead note (noteType max 45 characters). Example (individual) json { \\\"entityType\\\": \\\"Individual\\\", \\\"entityName\\\": \\\"Alex\\\", \\\"entitySurname\\\": \\\"Morgan\\\", \\\"email\\\": \\\"[email protected]\\\", \\\"leadSource\\\": \\\"Website enquiry\\\", \\\"leadStatus\\\": \\\"New\\\" } 201: Location references the new lead; body includes entityKey, leadDetailID, and leadNoteID when a note was created. If a lead with the same name, surname and email already exists, that lead is returned and any note is added to it. 400: Validation failed, or a client (not a lead) with the same name, surname and email already exists. 403: API client is read-only. 429: Rate limit exceeded.\",\"url\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onboardme.app/api-reference/endpoints/leads/create#webpage\"},\"dateModified\":\"2026-10-14T10:01:59.348Z\",\"publisher\":{\"@id\":\"https://docs.onboardme.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onboardme.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OnboardMe\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OnboardMe\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/leads/create.md","siteName":"OnboardMe","nav":{"global":null,"tabs":[{"tab":"API Reference","groups":[{"group":"API documentation","icon":"book-open","expanded":true,"pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":"book-open","href":"/introduction"},{"title":"Get Started with OnboardMe Partner API","sidebarTitle":"Quick Start","icon":"rocket","href":"/quickstart"},{"title":"Authenticate with the Partner API","sidebarTitle":"Authentication","icon":"key","href":"/authentication"},{"title":"Errors and rate limits","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/errors"},{"title":"OpenAPI specification","sidebarTitle":"OpenAPI spec","icon":"file-code","href":"/openapi"}]},{"group":"Endpoints","icon":"code","pages":[{"group":"ID verifications","icon":"id-card","expanded":false,"pages":[{"title":"Send an identity verification","sidebarTitle":"Send verification","openapi":"POST /api/v1/id-verifications/send","href":"/api-reference/endpoints/id-verifications/send"},{"title":"Create an AML check","sidebarTitle":"AML check","openapi":"POST /api/v1/id-verifications/aml-checks","href":"/api-reference/endpoints/id-verifications/aml-checks"},{"title":"Download identity verification certificate","sidebarTitle":"Certificate PDF","openapi":"GET /api/v1/id-verifications/entities/{entityKey}/certificate","href":"/api-reference/endpoints/id-verifications/certificate"}]},{"group":"Entities","icon":"building","expanded":false,"pages":[{"title":"List client entities","sidebarTitle":"List clients","openapi":"GET /api/v1/entities/list","href":"/api-reference/endpoints/entities/list"},{"title":"Get entity by key","sidebarTitle":"Get client","openapi":"GET /api/v1/entities/{key}","href":"/api-reference/endpoints/entities/get"},{"title":"Create a client entity","sidebarTitle":"Create client","openapi":"POST /api/v1/entities","href":"/api-reference/endpoints/entities/create"},{"title":"Get linked integration IDs","sidebarTitle":"Integrations","openapi":"GET /api/v1/entities/{key}/integrations","href":"/api-reference/endpoints/entities/integrations"}]},{"group":"Deals","icon":"handshake","expanded":false,"pages":[{"title":"List deals","sidebarTitle":"List deals","openapi":"GET /api/v1/deals/list","href":"/api-reference/endpoints/deals/list"},{"title":"Create a deal","sidebarTitle":"Create a deal","openapi":"POST /api/v1/deals","href":"/api-reference/endpoints/deals/create"},{"title":"Get a deal","sidebarTitle":"Get a deal","openapi":"GET /api/v1/deals/{dealId}","href":"/api-reference/endpoints/deals/get"},{"title":"Update a deal","sidebarTitle":"Update a deal","openapi":"PUT /api/v1/deals/{dealId}","href":"/api-reference/endpoints/deals/update"},{"title":"Delete a deal","sidebarTitle":"Delete a deal","openapi":"DELETE /api/v1/deals/{dealId}","href":"/api-reference/endpoints/deals/delete"},{"title":"List deal notes","sidebarTitle":"List notes","openapi":"GET /api/v1/deals/{dealId}/notes","href":"/api-reference/endpoints/deals/list-notes"},{"title":"Add a note to a deal","sidebarTitle":"Add a note","openapi":"POST /api/v1/deals/{dealId}/notes","href":"/api-reference/endpoints/deals/add-note"}]},{"group":"Authentication","icon":"key","expanded":false,"pages":[{"title":"Validate API credentials","sidebarTitle":"Validate credentials","openapi":"GET /api/v1/auth/validate","href":"/api-reference/endpoints/auth/validate"}]},{"group":"Bills","icon":"receipt","expanded":false,"pages":[{"title":"List bills","sidebarTitle":"List bills","openapi":"GET /api/v1/bills/list","href":"/api-reference/endpoints/bills/list"},{"title":"Ledger connection status","sidebarTitle":"Ledger status","openapi":"GET /api/v1/bills/ledger/status","href":"/api-reference/endpoints/bills/ledger-status"},{"title":"List Xero revenue accounts","sidebarTitle":"Ledger accounts","openapi":"GET /api/v1/bills/ledger/accounts","href":"/api-reference/endpoints/bills/ledger-accounts"},{"title":"List Xero tax rates","sidebarTitle":"Tax rates","openapi":"GET /api/v1/bills/ledger/tax-rates","href":"/api-reference/endpoints/bills/ledger-tax-rates"},{"title":"List Xero branding themes","sidebarTitle":"Branding themes","openapi":"GET /api/v1/bills/ledger/branding-themes","href":"/api-reference/endpoints/bills/ledger-branding-themes"},{"title":"Create a bill","sidebarTitle":"Create a bill","openapi":"POST /api/v1/bills","href":"/api-reference/endpoints/bills/create"},{"title":"Download bill PDF","sidebarTitle":"Download PDF","openapi":"GET /api/v1/bills/{billingId}/pdf","href":"/api-reference/endpoints/bills/pdf"},{"title":"Load a bill","sidebarTitle":"Load a bill","openapi":"GET /api/v1/bills/{billingId}","href":"/api-reference/endpoints/bills/get"},{"title":"List payments for a bill","sidebarTitle":"Payments for a bill","openapi":"GET /api/v1/bills/{billingId}/payments","href":"/api-reference/endpoints/bills/payments"},{"title":"List Xero service mappings","sidebarTitle":"Account mappings","openapi":"GET /api/v1/bills/ledger/account-mappings","href":"/api-reference/endpoints/bills/ledger-account-mappings"},{"title":"List Xero sale items","sidebarTitle":"Sale items","openapi":"GET /api/v1/bills/ledger/sale-items","href":"/api-reference/endpoints/bills/ledger-sale-items"},{"title":"List Xero tracking categories","sidebarTitle":"Tracking categories","openapi":"GET /api/v1/bills/ledger/tracking-categories","href":"/api-reference/endpoints/bills/ledger-tracking-categories"},{"title":"Ledger defaults","sidebarTitle":"Ledger defaults","openapi":"GET /api/v1/bills/ledger/defaults","href":"/api-reference/endpoints/bills/ledger-defaults"},{"title":"List GreatSoft task codes for a client","sidebarTitle":"GreatSoft task codes","openapi":"GET /api/v1/bills/ledger/greatsoft-task-codes","href":"/api-reference/endpoints/bills/ledger-greatsoft-task-codes"},{"title":"List GreatSoft allocation codes","sidebarTitle":"GreatSoft allocation codes","openapi":"GET /api/v1/bills/ledger/greatsoft-allocation-codes","href":"/api-reference/endpoints/bills/ledger-greatsoft-allocation-codes"}]},{"group":"Payments","icon":"credit-card","expanded":false,"pages":[{"title":"List payments","sidebarTitle":"List payments","openapi":"GET /api/v1/payments/list","href":"/api-reference/endpoints/payments/list"},{"title":"Load a payment","sidebarTitle":"Get a payment","openapi":"GET /api/v1/payments/{paymentId}","href":"/api-reference/endpoints/payments/get"}]},{"group":"Debtors","icon":"scale-balanced","expanded":false,"pages":[{"title":"Debtors ageing summary","sidebarTitle":"Ageing","openapi":"GET /api/v1/debtors/ageing","href":"/api-reference/endpoints/debtors/ageing"},{"title":"List outstanding invoices","sidebarTitle":"Outstanding invoices","openapi":"GET /api/v1/debtors/invoices","href":"/api-reference/endpoints/debtors/invoices"},{"title":"Debtors movement","sidebarTitle":"Movement","openapi":"GET /api/v1/debtors/movement","href":"/api-reference/endpoints/debtors/movement"}]},{"group":"Statements","icon":"file-invoice-dollar","expanded":false,"pages":[{"title":"List statements for a client","sidebarTitle":"List statements","openapi":"GET /api/v1/statements/list","href":"/api-reference/endpoints/statements/list"},{"title":"Load a statement","sidebarTitle":"Get a statement","openapi":"GET /api/v1/statements/{statementId}","href":"/api-reference/endpoints/statements/get"},{"title":"Download statement PDF","sidebarTitle":"Download PDF","openapi":"GET /api/v1/statements/{statementId}/pdf","href":"/api-reference/endpoints/statements/pdf"}]},{"group":"Contacts","icon":"address-book","expanded":false,"pages":[{"title":"List client contacts","sidebarTitle":"List contacts","openapi":"GET /api/v1/contacts/list","href":"/api-reference/endpoints/contacts/list"},{"title":"List contacts for a client","sidebarTitle":"Contacts for a client","openapi":"GET /api/v1/entities/{entityKey}/contacts","href":"/api-reference/endpoints/contacts/list-for-client"},{"title":"Add a contact to a client","sidebarTitle":"Add a contact","openapi":"POST /api/v1/entities/{entityKey}/contacts","href":"/api-reference/endpoints/contacts/create"},{"title":"Get a client contact","sidebarTitle":"Get a contact","openapi":"GET /api/v1/entities/{entityKey}/contacts/{entityContactId}","href":"/api-reference/endpoints/contacts/get"},{"title":"Update a client contact","sidebarTitle":"Update a contact","openapi":"PUT /api/v1/entities/{entityKey}/contacts/{entityContactId}","href":"/api-reference/endpoints/contacts/update"}]},{"group":"Leads","icon":{"name":"user-plus","library":"lucide"},"expanded":false,"pages":[{"title":"List leads","sidebarTitle":"List leads","openapi":"GET /api/v1/leads/list","description":"Returns leads for your practice (clients with lead status).\r\n\r\nUse `lastUpdated` for incremental sync and `pageNumber` for paged exports (1-based, up to 10000).\r\n\r\nOptional filters: `name`, `email`, `leadStatus`, and `leadSource` apply case-insensitive substring matching.\r\n\r\nBy default, leads with status **Lost** are excluded. Set `includeLostLeads=true` to include them.\r\n\r\n**429:** Rate limit exceeded.","href":"/api-reference/endpoints/leads/list"},{"title":"Create a lead","sidebarTitle":"Create a lead","openapi":"POST /api/v1/leads","href":"/api-reference/endpoints/leads/create"},{"title":"Convert lead to client","sidebarTitle":"Convert to client","openapi":"POST /api/v1/leads/{entityKey}/convert-to-client","description":"Promotes a lead to an **Active** client by setting the underlying entity's client status from Lead to Active.\r\n\r\nThe same **`entityKey`** continues to identify the record; after conversion it appears in **`GET /api/v1/entities/list`** rather than lead list endpoints.\r\n\r\nRequires an API client with **write** access. Integration sync to connected practice-management systems runs in the background after conversion (same as updating a client in the app).\r\n\r\n**400:** Entity is already a client (not lead status).\r\n\r\n**404:** Lead not found for your practice.\r\n\r\n**403:** API client is read-only.\r\n\r\n**429:** Rate limit exceeded.","href":"/api-reference/endpoints/leads/convert"},{"title":"Get lead by entity key","sidebarTitle":"Get a lead","openapi":"GET /api/v1/leads/{entityKey}","href":"/api-reference/endpoints/leads/get"},{"title":"List notes for a lead","sidebarTitle":"List notes","openapi":"GET /api/v1/leads/{entityKey}/notes","href":"/api-reference/endpoints/leads/list-notes"},{"title":"Add a note to a lead","sidebarTitle":"Add a note","openapi":"POST /api/v1/leads/{entityKey}/notes","href":"/api-reference/endpoints/leads/add-note"}]},{"group":"Groups","icon":"users","expanded":false,"pages":[{"title":"List groups","sidebarTitle":"List groups","openapi":"GET /api/v1/groups/list","href":"/api-reference/endpoints/groups/list"}]},{"group":"eForms","icon":"file-lines","expanded":false,"pages":[{"title":"List eForm templates","sidebarTitle":"List templates","openapi":"GET /api/v1/eforms/templates","href":"/api-reference/endpoints/eforms/templates"},{"title":"Create and send an eForm","sidebarTitle":"Send eForm","openapi":"POST /api/v1/eforms/send","href":"/api-reference/endpoints/eforms/send"},{"title":"Create and send an eForm or eForm stack","sidebarTitle":"Create eForm","openapi":"POST /api/v1/eforms","href":"/api-reference/endpoints/eforms/create"},{"title":"List eForms","sidebarTitle":"List eForms","openapi":"GET /api/v1/eforms/list","href":"/api-reference/endpoints/eforms/list"},{"title":"Get an eForm with answers","sidebarTitle":"Get eForm","openapi":"GET /api/v1/eforms/{formKey}","href":"/api-reference/endpoints/eforms/get"},{"title":"Send a draft eForm","sidebarTitle":"Send draft","openapi":"POST /api/v1/eforms/{formKey}/send","href":"/api-reference/endpoints/eforms/send-draft"},{"title":"Resend an eForm invitation","sidebarTitle":"Resend","openapi":"POST /api/v1/eforms/{formKey}/resend","href":"/api-reference/endpoints/eforms/resend"},{"title":"Cancel an eForm","sidebarTitle":"Cancel","openapi":"POST /api/v1/eforms/{formKey}/cancel","href":"/api-reference/endpoints/eforms/cancel"},{"title":"eForm schema guide","sidebarTitle":"Schema guide","openapi":"GET /api/v1/eforms/schema-guide","href":"/api-reference/endpoints/eforms/schema-guide"},{"title":"Create an eForm template","sidebarTitle":"Create template","openapi":"POST /api/v1/eforms/templates","href":"/api-reference/endpoints/eforms/create-template"},{"title":"Get an eForm template","sidebarTitle":"Get template","openapi":"GET /api/v1/eforms/templates/{templateId}","href":"/api-reference/endpoints/eforms/get-template"},{"title":"Update an eForm template","sidebarTitle":"Update template","openapi":"PUT /api/v1/eforms/templates/{templateId}","href":"/api-reference/endpoints/eforms/update-template"},{"title":"Duplicate an eForm template","sidebarTitle":"Duplicate template","openapi":"POST /api/v1/eforms/templates/{templateId}/duplicate","href":"/api-reference/endpoints/eforms/duplicate-template"},{"title":"Deactivate an eForm template","sidebarTitle":"Deactivate template","openapi":"DELETE /api/v1/eforms/templates/{templateId}","href":"/api-reference/endpoints/eforms/deactivate-template"}]},{"group":"Onboardings","icon":"clipboard-check","expanded":false,"pages":[{"title":"List onboardings","sidebarTitle":"List onboardings","openapi":"GET /api/v1/onboardings/list","href":"/api-reference/endpoints/onboardings/list"},{"title":"Get onboarding by key","sidebarTitle":"Get onboarding","openapi":"GET /api/v1/onboardings/{key}","href":"/api-reference/endpoints/onboardings/get"},{"title":"Create a client onboarding","sidebarTitle":"Create onboarding","openapi":"POST /api/v1/onboardings/create","href":"/api-reference/endpoints/onboardings/create"},{"title":"List onboarding documents","sidebarTitle":"List documents","openapi":"GET /api/v1/onboardings/{key}/documents","href":"/api-reference/endpoints/onboardings/documents"},{"title":"Download an onboarding document","sidebarTitle":"Download a document","openapi":"GET /api/v1/onboardings/{key}/entities/{entityOnboardingId}/documents/{documentId}","href":"/api-reference/endpoints/onboardings/document"},{"title":"Download onboarding documents as a zip","sidebarTitle":"Download zip","openapi":"GET /api/v1/onboardings/{key}/entities/{entityOnboardingId}/documents/zip","href":"/api-reference/endpoints/onboardings/documents-zip"},{"title":"List onboarding statuses","sidebarTitle":"Statuses","openapi":"GET /api/v1/onboardings/statuses","href":"/api-reference/endpoints/onboardings/statuses"}]},{"group":"Onboarding management","icon":"list-check","expanded":false,"pages":[{"title":"Edit onboarding details","sidebarTitle":"Edit details","openapi":"PATCH /api/v1/onboardings/{key}/details","href":"/api-reference/endpoints/onboarding-management/edit-details"},{"title":"List onboarding clients","sidebarTitle":"List clients","openapi":"GET /api/v1/onboardings/{key}/clients","href":"/api-reference/endpoints/onboarding-management/list-clients"},{"title":"Get an onboarding client","sidebarTitle":"Get client","openapi":"GET /api/v1/onboardings/{key}/clients/{clientId}","href":"/api-reference/endpoints/onboarding-management/get-client"},{"title":"Replace onboarding clients","sidebarTitle":"Replace clients","openapi":"PUT /api/v1/onboardings/{key}/clients","href":"/api-reference/endpoints/onboarding-management/replace-clients"},{"title":"Edit onboarding clients","sidebarTitle":"Edit clients","openapi":"PATCH /api/v1/onboardings/{key}/clients","href":"/api-reference/endpoints/onboarding-management/edit-clients"},{"title":"Fill in client details","sidebarTitle":"Fill in client details","openapi":"PATCH /api/v1/onboardings/{key}/clients/{clientId}/details","href":"/api-reference/endpoints/onboarding-management/client-details"},{"title":"Set client custom fields","sidebarTitle":"Set custom fields","openapi":"PUT /api/v1/onboardings/{key}/clients/{clientId}/custom-fields","href":"/api-reference/endpoints/onboarding-management/custom-fields"},{"title":"List client contacts","sidebarTitle":"List contacts","openapi":"GET /api/v1/onboardings/{key}/clients/{clientId}/contacts","href":"/api-reference/endpoints/onboarding-management/list-contacts"},{"title":"Add a client contact","sidebarTitle":"Add contact","openapi":"POST /api/v1/onboardings/{key}/clients/{clientId}/contacts","href":"/api-reference/endpoints/onboarding-management/add-contact"},{"title":"Edit a client contact","sidebarTitle":"Edit contact","openapi":"PATCH /api/v1/onboardings/{key}/clients/{clientId}/contacts/{contactId}","href":"/api-reference/endpoints/onboarding-management/edit-contact"},{"title":"Remove a client contact","sidebarTitle":"Remove contact","openapi":"DELETE /api/v1/onboardings/{key}/clients/{clientId}/contacts/{contactId}","href":"/api-reference/endpoints/onboarding-management/remove-contact"},{"title":"List onboarding recipients","sidebarTitle":"List recipients","openapi":"GET /api/v1/onboardings/{key}/recipients","href":"/api-reference/endpoints/onboarding-management/list-recipients"},{"title":"Replace onboarding recipients","sidebarTitle":"Replace recipients","openapi":"PUT /api/v1/onboardings/{key}/recipients","href":"/api-reference/endpoints/onboarding-management/replace-recipients"},{"title":"Edit onboarding recipients","sidebarTitle":"Edit recipients","openapi":"PATCH /api/v1/onboardings/{key}/recipients","href":"/api-reference/endpoints/onboarding-management/edit-recipients"},{"title":"Request a document","sidebarTitle":"Request document","openapi":"POST /api/v1/onboardings/{key}/clients/{clientId}/documents","href":"/api-reference/endpoints/onboarding-management/request-document"},{"title":"Rename or bypass a document","sidebarTitle":"Rename or bypass document","openapi":"PATCH /api/v1/onboardings/{key}/documents/{documentId}","href":"/api-reference/endpoints/onboarding-management/update-document"},{"title":"Remove a requested document","sidebarTitle":"Remove document","openapi":"DELETE /api/v1/onboardings/{key}/documents/{documentId}","href":"/api-reference/endpoints/onboarding-management/remove-document"},{"title":"Upload a document file","sidebarTitle":"Upload file","openapi":"POST /api/v1/onboardings/{key}/documents/{documentId}/file","href":"/api-reference/endpoints/onboarding-management/upload-document-file"},{"title":"Delete an uploaded document file","sidebarTitle":"Delete file","openapi":"DELETE /api/v1/onboardings/{key}/documents/{documentId}/file","href":"/api-reference/endpoints/onboarding-management/delete-document-file"},{"title":"List onboarding notes","sidebarTitle":"List notes","openapi":"GET /api/v1/onboardings/{key}/notes","href":"/api-reference/endpoints/onboarding-management/list-notes"},{"title":"Add an onboarding note","sidebarTitle":"Add note","openapi":"POST /api/v1/onboardings/{key}/notes","href":"/api-reference/endpoints/onboarding-management/add-note"},{"title":"List client relationships","sidebarTitle":"List relationships","openapi":"GET /api/v1/onboardings/{key}/relationships","href":"/api-reference/endpoints/onboarding-management/list-relationships"},{"title":"Replace client relationships","sidebarTitle":"Replace relationships","openapi":"PUT /api/v1/onboardings/{key}/relationships","href":"/api-reference/endpoints/onboarding-management/replace-relationships"}]},{"group":"Onboarding actions","icon":"paper-plane","expanded":false,"pages":[{"title":"Send an onboarding","sidebarTitle":"Send","openapi":"POST /api/v1/onboardings/{key}/send","href":"/api-reference/endpoints/onboarding-actions/send"},{"title":"Send to a specific recipient","sidebarTitle":"Send to recipient","openapi":"POST /api/v1/onboardings/{key}/recipients/{recipientKey}/send","href":"/api-reference/endpoints/onboarding-actions/send-to-recipient"},{"title":"Resend onboardings","sidebarTitle":"Bulk resend","openapi":"POST /api/v1/onboardings/bulk-resend","href":"/api-reference/endpoints/onboarding-actions/bulk-resend"},{"title":"Send an onboarding for approval","sidebarTitle":"Send for approval","openapi":"POST /api/v1/onboardings/{key}/send-for-approval","href":"/api-reference/endpoints/onboarding-actions/send-for-approval"},{"title":"Approve and send an onboarding","sidebarTitle":"Approve","openapi":"POST /api/v1/onboardings/{key}/approve","href":"/api-reference/endpoints/onboarding-actions/approve"},{"title":"Cancel an onboarding","sidebarTitle":"Cancel","openapi":"POST /api/v1/onboardings/{key}/cancel","href":"/api-reference/endpoints/onboarding-actions/cancel"},{"title":"Complete an onboarding","sidebarTitle":"Complete","openapi":"POST /api/v1/onboardings/{key}/complete","href":"/api-reference/endpoints/onboarding-actions/complete"},{"title":"Reset onboarding reminders","sidebarTitle":"Reset reminders","openapi":"POST /api/v1/onboardings/{key}/reset-reminders","href":"/api-reference/endpoints/onboarding-actions/reset-reminders"},{"title":"Pause or resume onboarding reminders","sidebarTitle":"Pause reminders","openapi":"POST /api/v1/onboardings/{key}/pause-reminders","href":"/api-reference/endpoints/onboarding-actions/pause-reminders"},{"title":"Update the practice client from an onboarding client","sidebarTitle":"Push to client","openapi":"POST /api/v1/onboardings/{key}/clients/{clientId}/push-to-client","href":"/api-reference/endpoints/onboarding-actions/push-to-client"}]},{"group":"Recurring billing","icon":"rotate","expanded":false,"pages":[{"title":"List recurring billing schedules","sidebarTitle":"List schedules","openapi":"GET /api/v1/recurring-billing/list","href":"/api-reference/endpoints/recurring-billing/list"},{"title":"Load a recurring billing schedule","sidebarTitle":"Get a schedule","openapi":"GET /api/v1/recurring-billing/{recurringBillingId}","href":"/api-reference/endpoints/recurring-billing/get"},{"title":"List recurring billing runs","sidebarTitle":"List runs","openapi":"GET /api/v1/recurring-billing/{recurringBillingId}/runs","href":"/api-reference/endpoints/recurring-billing/runs"}]},{"group":"Practice","icon":"building-columns","expanded":false,"pages":[{"title":"Get practice details","sidebarTitle":"Practice info","openapi":"GET /api/v1/practice/info","href":"/api-reference/endpoints/practice/info"},{"title":"Get practice subscription","sidebarTitle":"Subscription","openapi":"GET /api/v1/practice/subscription","href":"/api-reference/endpoints/practice/subscription"}]},{"group":"Proposals","icon":"file-invoice","expanded":false,"pages":[{"title":"List proposals","sidebarTitle":"List proposals","openapi":"GET /api/v1/proposals/list","href":"/api-reference/endpoints/proposals/list"},{"title":"Get proposal by key","sidebarTitle":"Get proposal","openapi":"GET /api/v1/proposals/{key}","href":"/api-reference/endpoints/proposals/get"},{"title":"Create an adhoc proposal","sidebarTitle":"Create a proposal","openapi":"POST /api/v1/proposals","href":"/api-reference/endpoints/proposals/create"},{"title":"Create a proposal from a template","sidebarTitle":"From a template","openapi":"POST /api/v1/proposals/from-template","href":"/api-reference/endpoints/proposals/from-template"},{"title":"Duplicate a proposal","sidebarTitle":"Duplicate","openapi":"POST /api/v1/proposals/{key}/duplicate","href":"/api-reference/endpoints/proposals/duplicate"},{"title":"Download proposal PDF","sidebarTitle":"Download PDF","openapi":"GET /api/v1/proposals/{key}/pdf","href":"/api-reference/endpoints/proposals/pdf"},{"title":"Get proposal pricing","sidebarTitle":"Pricing","openapi":"GET /api/v1/proposals/{key}/pricing","href":"/api-reference/endpoints/proposals/pricing"},{"title":"Renew a proposal","sidebarTitle":"Renew","openapi":"POST /api/v1/proposals/{key}/renew","href":"/api-reference/endpoints/proposals/renew"},{"title":"Preview proposal renewal","sidebarTitle":"Renew preview","openapi":"GET /api/v1/proposals/{key}/renew-preview","href":"/api-reference/endpoints/proposals/renew-preview"},{"title":"List proposal templates","sidebarTitle":"Templates","openapi":"GET /api/v1/proposals/templates","href":"/api-reference/endpoints/proposals/templates"},{"title":"List proposal services","sidebarTitle":"Services","openapi":"GET /api/v1/proposals/services","href":"/api-reference/endpoints/proposals/services"},{"title":"List proposal packages","sidebarTitle":"Packages","openapi":"GET /api/v1/proposals/packages","href":"/api-reference/endpoints/proposals/packages"}]},{"group":"Proposal options","icon":"list","expanded":false,"pages":[{"title":"List terms and conditions templates","sidebarTitle":"Terms templates","openapi":"GET /api/v1/proposals/terms","href":"/api-reference/endpoints/proposal-options/terms"},{"title":"List STP authority templates","sidebarTitle":"STP authorities","openapi":"GET /api/v1/proposals/stp-authorities","href":"/api-reference/endpoints/proposal-options/stp-authorities"},{"title":"List additional proposal documents","sidebarTitle":"Additional documents","openapi":"GET /api/v1/proposals/documents","href":"/api-reference/endpoints/proposal-options/documents"},{"title":"List proposal PDF attachments","sidebarTitle":"PDF attachments","openapi":"GET /api/v1/proposals/attachments","href":"/api-reference/endpoints/proposal-options/attachments"},{"title":"List proposal cover pages","sidebarTitle":"Cover pages","openapi":"GET /api/v1/proposals/cover-pages","href":"/api-reference/endpoints/proposal-options/cover-pages"},{"title":"List welcome message templates","sidebarTitle":"Welcome messages","openapi":"GET /api/v1/proposals/welcome-messages","href":"/api-reference/endpoints/proposal-options/welcome-messages"},{"title":"List engagement lengths","sidebarTitle":"Engagement lengths","openapi":"GET /api/v1/proposals/lengths","href":"/api-reference/endpoints/proposal-options/lengths"},{"title":"List proposal currencies","sidebarTitle":"Currencies","openapi":"GET /api/v1/proposals/currencies","href":"/api-reference/endpoints/proposal-options/currencies"},{"title":"List proposal approvers for a user","sidebarTitle":"Approvers","openapi":"GET /api/v1/proposals/approvers","href":"/api-reference/endpoints/proposal-options/approvers"},{"title":"List checklist templates","sidebarTitle":"Checklist templates","openapi":"GET /api/v1/proposals/checklist-templates","href":"/api-reference/endpoints/proposal-options/checklist-templates"},{"title":"Get a checklist template","sidebarTitle":"Get checklist template","openapi":"GET /api/v1/proposals/checklist-templates/{templateId}","href":"/api-reference/endpoints/proposal-options/checklist-template"},{"title":"List identity verification methods","sidebarTitle":"Verification methods","openapi":"GET /api/v1/proposals/verification-methods","href":"/api-reference/endpoints/proposal-options/verification-methods"},{"title":"List service frequencies","sidebarTitle":"Service frequencies","openapi":"GET /api/v1/proposals/service-frequencies","href":"/api-reference/endpoints/proposal-options/service-frequencies"},{"title":"List ethical letter document presets","sidebarTitle":"Ethical letter presets","openapi":"GET /api/v1/proposals/ethical-letter-document-presets","href":"/api-reference/endpoints/proposal-options/ethical-letter-document-presets"},{"title":"List ethical letter templates","sidebarTitle":"Ethical letter templates","openapi":"GET /api/v1/proposals/ethical-letter-templates","href":"/api-reference/endpoints/proposal-options/ethical-letter-templates"},{"title":"List XPM job templates","sidebarTitle":"XPM job templates","openapi":"GET /api/v1/proposals/xpm-job-templates","href":"/api-reference/endpoints/proposals/xpm-job-templates"},{"title":"List XPM job categories","sidebarTitle":"XPM job categories","openapi":"GET /api/v1/proposals/xpm-job-categories","href":"/api-reference/endpoints/proposals/xpm-job-categories"},{"title":"List XPM tasks","sidebarTitle":"XPM tasks","openapi":"GET /api/v1/proposals/xpm-tasks","href":"/api-reference/endpoints/proposal-options/xpm-tasks"},{"title":"List XPM staff","sidebarTitle":"XPM staff","openapi":"GET /api/v1/proposals/xpm-staff","href":"/api-reference/endpoints/proposals/xpm-staff"},{"title":"List FYI job templates","sidebarTitle":"FYI job templates","openapi":"GET /api/v1/proposals/fyi-job-templates","href":"/api-reference/endpoints/proposals/fyi-job-templates"},{"title":"List FYI job states","sidebarTitle":"FYI job states","openapi":"GET /api/v1/proposals/fyi-job-states","href":"/api-reference/endpoints/proposals/fyi-job-states"},{"title":"List Karbon work templates","sidebarTitle":"Karbon work templates","openapi":"GET /api/v1/proposals/karbon-work-templates","href":"/api-reference/endpoints/proposal-options/karbon-work-templates"},{"title":"List Karbon work statuses for a work template","sidebarTitle":"Karbon work statuses","openapi":"GET /api/v1/proposals/karbon-work-statuses","href":"/api-reference/endpoints/proposal-options/karbon-work-statuses"},{"title":"List Karbon users","sidebarTitle":"Karbon users","openapi":"GET /api/v1/proposals/karbon-users","href":"/api-reference/endpoints/proposal-options/karbon-users"},{"title":"List GreatSoft standard tasks","sidebarTitle":"GreatSoft standard tasks","openapi":"GET /api/v1/proposals/greatsoft-std-tasks","href":"/api-reference/endpoints/proposal-options/greatsoft-std-tasks"},{"title":"List GreatSoft offices","sidebarTitle":"GreatSoft offices","openapi":"GET /api/v1/proposals/greatsoft-offices","href":"/api-reference/endpoints/proposal-options/greatsoft-offices"},{"title":"List GreatSoft staff","sidebarTitle":"GreatSoft staff","openapi":"GET /api/v1/proposals/greatsoft-staff","href":"/api-reference/endpoints/proposal-options/greatsoft-staff"},{"title":"List GreatSoft currencies","sidebarTitle":"GreatSoft currencies","openapi":"GET /api/v1/proposals/greatsoft-currencies","href":"/api-reference/endpoints/proposal-options/greatsoft-currencies"}]},{"group":"Proposal updates","icon":"pen-to-square","expanded":false,"pages":[{"title":"Replace a proposal","sidebarTitle":"Replace proposal","openapi":"PUT /api/v1/proposals/{key}","href":"/api-reference/endpoints/proposal-updates/replace"},{"title":"Replace proposal details","sidebarTitle":"Replace details","openapi":"PUT /api/v1/proposals/{key}/details","href":"/api-reference/endpoints/proposal-updates/replace-details"},{"title":"Edit proposal details","sidebarTitle":"Edit details","openapi":"PATCH /api/v1/proposals/{key}/details","href":"/api-reference/endpoints/proposal-updates/edit-details"},{"title":"Replace signatories","sidebarTitle":"Replace signatories","openapi":"PUT /api/v1/proposals/{key}/signatories","href":"/api-reference/endpoints/proposal-updates/replace-signatories"},{"title":"Edit signatories","sidebarTitle":"Edit signatories","openapi":"PATCH /api/v1/proposals/{key}/signatories","href":"/api-reference/endpoints/proposal-updates/edit-signatories"},{"title":"Replace services","sidebarTitle":"Replace services","openapi":"PUT /api/v1/proposals/{key}/services","href":"/api-reference/endpoints/proposal-updates/replace-services"},{"title":"Edit services","sidebarTitle":"Edit services","openapi":"PATCH /api/v1/proposals/{key}/services","href":"/api-reference/endpoints/proposal-updates/edit-services"},{"title":"Replace billing","sidebarTitle":"Replace billing","openapi":"PUT /api/v1/proposals/{key}/billing","href":"/api-reference/endpoints/proposal-updates/replace-billing"},{"title":"Edit billing","sidebarTitle":"Edit billing","openapi":"PATCH /api/v1/proposals/{key}/billing","href":"/api-reference/endpoints/proposal-updates/edit-billing"},{"title":"Replace XPM jobs","sidebarTitle":"Replace XPM jobs","openapi":"PUT /api/v1/proposals/{key}/xpm-jobs","href":"/api-reference/endpoints/proposal-updates/replace-xpm-jobs"},{"title":"Edit XPM jobs","sidebarTitle":"Edit XPM jobs","openapi":"PATCH /api/v1/proposals/{key}/xpm-jobs","href":"/api-reference/endpoints/proposal-updates/edit-xpm-jobs"},{"title":"Replace FYI jobs","sidebarTitle":"Replace FYI jobs","openapi":"PUT /api/v1/proposals/{key}/fyi-jobs","href":"/api-reference/endpoints/proposal-updates/replace-fyi-jobs"},{"title":"Edit FYI jobs","sidebarTitle":"Edit FYI jobs","openapi":"PATCH /api/v1/proposals/{key}/fyi-jobs","href":"/api-reference/endpoints/proposal-updates/edit-fyi-jobs"},{"title":"Replace Karbon work items","sidebarTitle":"Replace Karbon work","openapi":"PUT /api/v1/proposals/{key}/karbon-work-items","href":"/api-reference/endpoints/proposal-updates/replace-karbon-work-items"},{"title":"Edit Karbon work items","sidebarTitle":"Edit Karbon work","openapi":"PATCH /api/v1/proposals/{key}/karbon-work-items","href":"/api-reference/endpoints/proposal-updates/edit-karbon-work-items"},{"title":"Replace GreatSoft tasks","sidebarTitle":"Replace GreatSoft tasks","openapi":"PUT /api/v1/proposals/{key}/greatsoft-tasks","href":"/api-reference/endpoints/proposal-updates/replace-greatsoft-tasks"},{"title":"Edit GreatSoft tasks","sidebarTitle":"Edit GreatSoft tasks","openapi":"PATCH /api/v1/proposals/{key}/greatsoft-tasks","href":"/api-reference/endpoints/proposal-updates/edit-greatsoft-tasks"},{"title":"Replace FreeAgent projects","sidebarTitle":"Replace FreeAgent projects","openapi":"PUT /api/v1/proposals/{key}/freeagent-projects","href":"/api-reference/endpoints/proposal-updates/replace-freeagent-projects"},{"title":"Edit FreeAgent projects","sidebarTitle":"Edit FreeAgent projects","openapi":"PATCH /api/v1/proposals/{key}/freeagent-projects","href":"/api-reference/endpoints/proposal-updates/edit-freeagent-projects"},{"title":"Set the proposal eForm","sidebarTitle":"Set eForm","openapi":"PUT /api/v1/proposals/{key}/eform","href":"/api-reference/endpoints/proposal-updates/set-eform"},{"title":"Set the proposal checklist","sidebarTitle":"Set checklist","openapi":"PUT /api/v1/proposals/{key}/checklist","href":"/api-reference/endpoints/proposal-updates/set-checklist"}]},{"group":"Proposal actions","icon":"circle-check","expanded":false,"pages":[{"title":"Send a proposal","sidebarTitle":"Send","openapi":"POST /api/v1/proposals/{key}/send","href":"/api-reference/endpoints/proposal-actions/send"},{"title":"Approve and send a proposal","sidebarTitle":"Approve","openapi":"POST /api/v1/proposals/{key}/approve","href":"/api-reference/endpoints/proposal-actions/approve"},{"title":"Cancel a proposal","sidebarTitle":"Cancel","openapi":"POST /api/v1/proposals/{key}/cancel","href":"/api-reference/endpoints/proposal-actions/cancel"},{"title":"Reactivate a declined proposal","sidebarTitle":"Reactivate","openapi":"POST /api/v1/proposals/{key}/reactivate","href":"/api-reference/endpoints/proposal-actions/reactivate"},{"title":"Mark a proposal accepted","sidebarTitle":"Mark accepted","openapi":"POST /api/v1/proposals/{key}/mark-accepted","href":"/api-reference/endpoints/proposal-actions/mark-accepted"},{"title":"Mark a proposal completed","sidebarTitle":"Mark completed","openapi":"POST /api/v1/proposals/{key}/mark-completed","href":"/api-reference/endpoints/proposal-actions/mark-completed"},{"title":"Reset proposal reminders","sidebarTitle":"Reset reminders","openapi":"POST /api/v1/proposals/{key}/reset-reminders","href":"/api-reference/endpoints/proposal-actions/reset-reminders"}]},{"group":"System settings","icon":"gear","expanded":false,"pages":[{"title":"List entity types","sidebarTitle":"Entity types","openapi":"GET /api/v1/settings/entity-types","href":"/api-reference/endpoints/settings/entity-types"},{"title":"List deal sources","sidebarTitle":"Deal sources","openapi":"GET /api/v1/settings/deal-sources","href":"/api-reference/endpoints/settings/deal-sources"},{"title":"List deal statuses","sidebarTitle":"Deal statuses","openapi":"GET /api/v1/settings/deal-statuses","href":"/api-reference/endpoints/settings/deal-statuses"},{"title":"List lead sources","sidebarTitle":"Lead sources","openapi":"GET /api/v1/settings/lead-sources","href":"/api-reference/endpoints/settings/lead-sources"},{"title":"List lead statuses","sidebarTitle":"Lead statuses","openapi":"GET /api/v1/settings/lead-statuses","href":"/api-reference/endpoints/settings/lead-statuses"},{"title":"List assignable user roles","sidebarTitle":"Roles","openapi":"GET /api/v1/settings/roles","href":"/api-reference/endpoints/settings/roles"}]},{"group":"Users","icon":"user","expanded":false,"pages":[{"title":"List practice users","sidebarTitle":"List users","openapi":"GET /api/v1/users/list","href":"/api-reference/endpoints/users/list"},{"title":"Add a practice user","sidebarTitle":"Add a user","openapi":"POST /api/v1/users","href":"/api-reference/endpoints/users/create"},{"title":"Get a practice user","sidebarTitle":"Get a user","openapi":"GET /api/v1/users/{userKey}","href":"/api-reference/endpoints/users/get"},{"title":"Update a practice user","sidebarTitle":"Update a user","openapi":"PUT /api/v1/users/{userKey}","href":"/api-reference/endpoints/users/update"},{"title":"Disable a practice user","sidebarTitle":"Disable a user","openapi":"POST /api/v1/users/{userKey}/disable","href":"/api-reference/endpoints/users/disable"}]},{"group":"Webhooks","icon":"webhook","expanded":false,"pages":[{"title":"List outbound webhooks","sidebarTitle":"List webhooks","openapi":"GET /api/v1/webhooks","href":"/api-reference/endpoints/webhooks/list"},{"title":"Subscribe a webhook","sidebarTitle":"Subscribe","openapi":"POST /api/v1/webhooks","href":"/api-reference/endpoints/webhooks/create"},{"title":"List webhook events","sidebarTitle":"Events","openapi":"GET /api/v1/webhooks/events","href":"/api-reference/endpoints/webhooks/events"},{"title":"Unsubscribe a webhook","sidebarTitle":"Unsubscribe","openapi":"DELETE /api/v1/webhooks/{id}","href":"/api-reference/endpoints/webhooks/unsubscribe"},{"title":"Send a test webhook","sidebarTitle":"Send a test","openapi":"POST /api/v1/webhooks/{id}/test","href":"/api-reference/endpoints/webhooks/test"}]}]},{"group":"Building blocks","icon":"cubes","expanded":true,"pages":[{"title":"The Entity","sidebarTitle":"Entity","icon":"building","href":"/api-reference/objects/entity"},{"title":"The Lead","sidebarTitle":"Lead","icon":{"name":"user-plus","library":"lucide"},"href":"/api-reference/objects/lead"},{"title":"The Proposal","sidebarTitle":"Proposal","icon":"file-invoice","href":"/api-reference/objects/proposal"},{"title":"The eForm","sidebarTitle":"eForm","icon":"file-signature","href":"/api-reference/objects/eform"},{"title":"The Onboarding","sidebarTitle":"Onboarding","icon":"clipboard-check","href":"/api-reference/objects/onboarding"},{"title":"The Webhook","sidebarTitle":"Webhook","icon":"webhook","href":"/api-reference/objects/webhook"},{"title":"The Bill","sidebarTitle":"Bill","icon":"receipt","href":"/api-reference/objects/bill"}]}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/concepts/regions"}]},{"tab":"MCP server","pages":[{"title":"MCP server","href":"/mcp/overview"}]}]},"basePath":"","title":"Create a lead - OnboardMe","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}