Internal notes attached to the lead. See the LeadNotes schema for the array shape (each note has content + created_at + optional user_id). Replaces the existing notes array. Pass null or omit to skip.
Lead status. Before the lead books, its form answers set its status. After it books, its calls set it. You can still write a status here, and it is saved as sent, but Aura's status sync later puts back the status its calls give. The sync checks up to 100 of an organization's leads each hour, so in a large organization this can take days. To change it for good, change the call's outcome. A won call beats a disqualifying form: while the lead's current call is won, the sync never puts back disqualified.
Lead's timezone. Must be an IANA zone (e.g. Europe/Berlin); the common aliases EST, CET, PST8PDT and US/Pacific are accepted, and surrounding whitespace is trimmed. Anything else is DISCARDED rather than rejected: the request still succeeds and every other field is applied. On create the timezone is left empty; on update the lead's existing timezone is left UNCHANGED, never cleared. If an unusable timezone is the only field supplied to an update, the request is rejected, because nothing would have been applied. Rejecting outright at the boundary is planned once telemetry shows nobody depends on the current leniency (AUR-2090).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aura API","description":"REST and GraphQL APIs for partner integrations","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#6D28D9"},"favicon":"https://mintcdn.com/aura-84f04a78/ysSUChuBcy4CPcDn/favicon.png?fit=max\u0026auto=format\u0026n=ysSUChuBcy4CPcDn\u0026q=85\u0026s=8ccf8e6924b6cad812298ed2ea32fc94","navbar":{"links":[{"href":"https://app.aura-app.ai","label":"Aura"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aura-84f04a78","hasAudioNarration":false,"actualSubdomain":"aura-84f04a78","customDomains":["docs.api.aura-app.ai"],"gitSource":{"type":"github","owner":"aura-app-ai","repo":"aura","deployBranch":"main","contentDirectory":"apps/api-docs/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adc184e0a0572dc1e6a8a62","collectionId":"088fa338-5010-438a-996a-01f21e70c0d1","liveDeploymentHistoryId":"6adc184e0a0572dc1e6a8a62","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adc197a3dbc661bca0dff4d","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"GraphQL API","count":114},{"language":"default","tag":"Types","count":86},{"language":"default","tag":"REST API","count":55},{"language":"default","tag":"API reference","count":49},{"language":"default","tag":"Queries","count":19},{"language":"default","tag":"Calls","count":10},{"language":"default","tag":"Mutations","count":9},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Leads","count":7},{"language":"default","tag":"Analytics","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"openapi/v1/leads/id/patch","slug":"/openapi/v1/leads/id/patch","pageMetadata":{"title":"Update lead","description":"\nUpdate fields on an existing lead.\n\nOnly provided fields will be updated; all others remain unchanged.\n\n**Updatable fields:**\n- `full_name`, `email`, `phone`, `company`, `status`, `timezone`, `notes`\n\nAt least one field is required — an empty body returns `400 VALIDATION_ERROR`.\n ","openapi":"openapi.json PATCH /v1/leads/{id}","href":"/openapi/v1/leads/id/patch"},"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 strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Update fields on an existing lead.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Only provided fields will be updated; all others remain unchanged.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Updatable fields:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"full_name\"\n }), \", \", _jsx(_components.code, {\n children: \"email\"\n }), \", \", _jsx(_components.code, {\n children: \"phone\"\n }), \", \", _jsx(_components.code, {\n children: \"company\"\n }), \", \", _jsx(_components.code, {\n children: \"status\"\n }), \", \", _jsx(_components.code, {\n children: \"timezone\"\n }), \", \", _jsx(_components.code, {\n children: \"notes\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"At least one field is required — an empty body returns \", _jsx(_components.code, {\n children: \"400 VALIDATION_ERROR\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Update fields on an existing lead.`}),`\n`,_jsx(_components.p,{children:`Only provided fields will be updated; all others remain unchanged.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Updatable fields:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`full_name`}),`, `,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`phone`}),`, `,_jsx(_components.code,{children:`company`}),`, `,_jsx(_components.code,{children:`status`}),`, `,_jsx(_components.code,{children:`timezone`}),`, `,_jsx(_components.code,{children:`notes`})]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`At least one field is required — an empty body returns `,_jsx(_components.code,{children:`400 VALIDATION_ERROR`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update lead","description":"\nUpdate fields on an existing lead.\n\nOnly provided fields will be updated; all others remain unchanged.\n\n**Updatable fields:**\n- `full_name`, `email`, `phone`, `company`, `status`, `timezone`, `notes`\n\nAt least one field is required — an empty body returns `400 VALIDATION_ERROR`.\n ","openapi":"openapi.json PATCH /v1/leads/{id}","href":"/openapi/v1/leads/id/patch"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/aura-84f04a78/a23b3099adac29d9/search-focus.js"],"openApiReferenceData":{"operation":{"description":"\nUpdate fields on an existing lead.\n\nOnly provided fields will be updated; all others remain unchanged.\n\n**Updatable fields:**\n- `full_name`, `email`, `phone`, `company`, `status`, `timezone`, `notes`\n\nAt least one field is required — an empty body returns `400 VALIDATION_ERROR`.\n ","parameters":["a9fbb137-db8b-4df9-8fef-6a53ea90f366"],"requestBody":"ee493dd6-6678-4c0b-bc74-a8cc1f2d9413","responses":{"200":"d93c0534-3f44-47c2-b2c7-68dbf631a72e","400":"ad9a35e7-0342-4e11-b549-47018f7ce023","401":"b4eb981e-d5e8-4783-a83d-b4c013f77342","402":"e5445bb0-ec0b-48c5-9d7f-1889a3231d55","403":"5ceeabe1-9620-47f4-9575-ebf2eae0fe5d","404":"189ffda3-4b9b-4b56-b040-052cef2b5a88","408":"7b3f117d-5753-4456-a238-448868c8f634","413":"961f32f9-80fb-4d4a-bf8e-f624589204c2","429":"b32883b5-b218-4c28-9467-d1fc52f16cc2","500":"b3b08a59-a8be-4373-9487-a6e895752f95"},"security":["eebeaedc-3226-4bf6-b1b5-3b5d2ccd13ae"],"summary":"Update lead","tags":["Leads"],"method":"patch","type":"path","servers":["5221a7e1-3d3d-4c69-849e-b4d57dd9af35","171a8e50-7771-4b7a-972e-29a2e587af64","5e31f02a-c4b3-4824-b16e-80268ce26955"],"path":"/v1/leads/{id}","baseUrlOptions":["https://api.aura-app.ai","https://staging-api.aura-app.ai","http://localhost:3001"],"title":"Update lead","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a9fbb137-db8b-4df9-8fef-6a53ea90f366":{"description":"Lead ID (UUID)","in":"path","name":"id","required":true,"schema":{"description":"Lead ID (UUID)","example":"550e8400-e29b-41d4-a716-446655440000","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"company":{"description":"Company name","example":"Acme Corp","type":"string","uniqueKey":"company","typeLabel":"string"},"email":{"description":"Email address","example":"john@example.com","format":"email","type":"string","uniqueKey":"email","typeLabel":"string\u003cemail>"},"full_name":{"description":"Full name of the lead","example":"John Doe","type":"string","uniqueKey":"full_name","typeLabel":"string"},"notes":{"oneOf":[{"description":"Internal notes attached to the lead. See the LeadNotes schema for the array shape (each note has content + created_at + optional user_id). Replaces the existing notes array. Pass null or omit to skip.","items":{"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"notes.oneOf.0.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"null"},"properties":{"content":{"description":"Note body. Plain text or markdown.","type":"string","isRequired":true,"uniqueKey":"notes.oneOf.0.items.[INDEX].content","typeLabel":"string"},"created_at":{"description":"ISO 8601 timestamp when the note was created.","example":"2026-05-08T14:23:11.000Z","type":"string","isRequired":true,"uniqueKey":"notes.oneOf.0.items.[INDEX].created_at","typeLabel":"string"},"user_id":{"oneOf":[{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"string","uniqueKey":"notes.oneOf.0.items.[INDEX].user_id.oneOf.0","typeLabel":"string"},{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"null","uniqueKey":"notes.oneOf.0.items.[INDEX].user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes.oneOf.0.items.[INDEX].user_id","typeLabel":"string | null"}},"required":["content","created_at"],"type":"object","uniqueKey":"notes.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"notes.oneOf.0","typeLabel":"object[]"},{"description":"Internal notes attached to the lead. See the LeadNotes schema for the array shape (each note has content + created_at + optional user_id). Replaces the existing notes array. Pass null or omit to skip.","items":{"additionalProperties":{"oneOf":[{},{"type":"null"}]},"properties":{"content":{"description":"Note body. Plain text or markdown.","type":"string"},"created_at":{"description":"ISO 8601 timestamp when the note was created.","example":"2026-05-08T14:23:11.000Z","type":"string"},"user_id":{"oneOf":[{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"string"},{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"null"}]}},"required":["content","created_at"],"type":"object"},"type":"null","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"object[] | null"},"phone":{"description":"Phone number in E.164 format (validated): `+` followed by country code and digits, no spaces or hyphens.","example":"+14155552671","pattern":"^\\+[1-9]\\d{1,14}$","type":"string","uniqueKey":"phone","typeLabel":"string"},"status":{"description":"Lead status. Before the lead books, its form answers set its status. After it books, its calls set it. You can still write a status here, and it is saved as sent, but Aura's status sync later puts back the status its calls give. The sync checks up to 100 of an organization's leads each hour, so in a large organization this can take days. To change it for good, change the call's outcome. A won call beats a disqualifying form: while the lead's current call is won, the sync never puts back `disqualified`.","example":"qualified","type":"string","uniqueKey":"status","typeLabel":"string"},"timezone":{"description":"Lead's timezone. Must be an IANA zone (e.g. Europe/Berlin); the common aliases EST, CET, PST8PDT and US/Pacific are accepted, and surrounding whitespace is trimmed. Anything else is DISCARDED rather than rejected: the request still succeeds and every other field is applied. On create the timezone is left empty; on update the lead's existing timezone is left UNCHANGED, never cleared. If an unusable timezone is the only field supplied to an update, the request is rejected, because nothing would have been applied. Rejecting outright at the boundary is planned once telemetry shows nobody depends on the current leniency (AUR-2090).","example":"America/New_York","type":"string","uniqueKey":"timezone","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"company":"Acme Corp","email":"john@example.com","full_name":"John Doe","notes":[{"content":"\u003cstring>","created_at":"2026-05-08T14:23:11.000Z","user_id":"\u003cstring>"}],"phone":"+14155552671","status":"qualified","timezone":"America/New_York"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"d93c0534-3f44-47c2-b2c7-68dbf631a72e":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"attribution":{"oneOf":[{"additionalProperties":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Flat map of every attribution parameter the record carried, returned under its own name. Known and provider-specific keys share one object. New keys may appear without a contract version change.","example":{"am_wuid":"wuid_4o251b0b130v3z6d5q0n","fbclid":"IwAR_sample_fbclid","utm_source":"facebook"},"properties":{"attribution_platform":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.attribution_platform","typeLabel":"string"},"city":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.city","typeLabel":"string"},"country":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.country","typeLabel":"string"},"country_code":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.country_code","typeLabel":"string"},"epik":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.epik","typeLabel":"string"},"fbc":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.fbc","typeLabel":"string"},"fbclid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.fbclid","typeLabel":"string"},"fbp":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.fbp","typeLabel":"string"},"gbraid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.gbraid","typeLabel":"string"},"gclid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.gclid","typeLabel":"string"},"hyclid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.hyclid","typeLabel":"string"},"landing_page":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.landing_page","typeLabel":"string"},"li_fat_id":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.li_fat_id","typeLabel":"string"},"msclkid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.msclkid","typeLabel":"string"},"rdt_cid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.rdt_cid","typeLabel":"string"},"referrer":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.referrer","typeLabel":"string"},"region":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.region","typeLabel":"string"},"sc_cid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.sc_cid","typeLabel":"string"},"ttclid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.ttclid","typeLabel":"string"},"twclid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.twclid","typeLabel":"string"},"utm_campaign":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.utm_campaign","typeLabel":"string"},"utm_content":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.utm_content","typeLabel":"string"},"utm_id":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.utm_id","typeLabel":"string"},"utm_medium":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.utm_medium","typeLabel":"string"},"utm_source":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.utm_source","typeLabel":"string"},"utm_term":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.utm_term","typeLabel":"string"},"wbraid":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.0.wbraid","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"data.attribution.oneOf.0","typeLabel":"object"},{"additionalProperties":{"maxLength":500,"minLength":1,"type":"string","uniqueKey":"data.attribution.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Flat map of every attribution parameter the record carried, returned under its own name. Known and provider-specific keys share one object. New keys may appear without a contract version change.","example":{"am_wuid":"wuid_4o251b0b130v3z6d5q0n","fbclid":"IwAR_sample_fbclid","utm_source":"facebook"},"properties":{"attribution_platform":{"maxLength":500,"minLength":1,"type":"string"},"city":{"maxLength":500,"minLength":1,"type":"string"},"country":{"maxLength":500,"minLength":1,"type":"string"},"country_code":{"maxLength":500,"minLength":1,"type":"string"},"epik":{"maxLength":500,"minLength":1,"type":"string"},"fbc":{"maxLength":500,"minLength":1,"type":"string"},"fbclid":{"maxLength":500,"minLength":1,"type":"string"},"fbp":{"maxLength":500,"minLength":1,"type":"string"},"gbraid":{"maxLength":500,"minLength":1,"type":"string"},"gclid":{"maxLength":500,"minLength":1,"type":"string"},"hyclid":{"maxLength":500,"minLength":1,"type":"string"},"landing_page":{"maxLength":500,"minLength":1,"type":"string"},"li_fat_id":{"maxLength":500,"minLength":1,"type":"string"},"msclkid":{"maxLength":500,"minLength":1,"type":"string"},"rdt_cid":{"maxLength":500,"minLength":1,"type":"string"},"referrer":{"maxLength":500,"minLength":1,"type":"string"},"region":{"maxLength":500,"minLength":1,"type":"string"},"sc_cid":{"maxLength":500,"minLength":1,"type":"string"},"ttclid":{"maxLength":500,"minLength":1,"type":"string"},"twclid":{"maxLength":500,"minLength":1,"type":"string"},"utm_campaign":{"maxLength":500,"minLength":1,"type":"string"},"utm_content":{"maxLength":500,"minLength":1,"type":"string"},"utm_id":{"maxLength":500,"minLength":1,"type":"string"},"utm_medium":{"maxLength":500,"minLength":1,"type":"string"},"utm_source":{"maxLength":500,"minLength":1,"type":"string"},"utm_term":{"maxLength":500,"minLength":1,"type":"string"},"wbraid":{"maxLength":500,"minLength":1,"type":"string"}},"type":"null","isRequired":true,"uniqueKey":"data.attribution.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attribution","typeLabel":"object | null"},"company":{"oneOf":[{"description":"Company name","example":"Acme Corp","type":"string","isRequired":true,"uniqueKey":"data.company.oneOf.0","typeLabel":"string"},{"description":"Company name","example":"Acme Corp","type":"null","isRequired":true,"uniqueKey":"data.company.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.company","typeLabel":"string | null"},"consent":{"description":"Every consent box and what the person chose, in the order they were recorded. This includes Aura's own box for appointment texts, and STOP replies. `agreed` is true only while they agree for the lead's current phone number. An empty list means no consent is on file: that is not the same as `declined`, but treat it as no consent. A box they did not tick is only recorded once they finish the form. Consent can change after you read it, for example when the person replies STOP, so read the lead again right before you text them. The phone number is sent either way.","example":[{"agreed":true,"at":"2026-10-08T10:00:00.000Z","disclosure":null,"granted_at":null,"id":"6f1b2c3d-0000-4000-8000-000000000001","kind":"custom","label":"I agree to receive appointment reminder texts from Acme Inc. Msg \u0026 data rates may apply. Reply STOP to opt out.","links":[{"text":"SMS Terms","url":"https://example.com/sms-terms"},{"text":"Privacy Policy","url":"https://example.com/privacy"}],"phone":"+15551234567","source":"booking_form","state":"granted"},{"agreed":false,"at":"2026-10-08T10:00:00.000Z","disclosure":null,"granted_at":null,"id":"6f1b2c3d-0000-4000-8000-000000000002","kind":"custom","label":"I agree to receive promotional texts from Acme Inc.","links":[],"phone":"+15551234567","source":"booking_form","state":"declined"}],"items":{"description":"One consent box and what the person chose: a box on the booking form, or Aura's own box for appointment texts.","example":{"agreed":true,"at":"2026-10-08T10:00:00.000Z","disclosure":null,"granted_at":null,"id":"6f1b2c3d-0000-4000-8000-000000000001","kind":"custom","label":"I agree to receive appointment reminder texts from Acme Inc. Msg \u0026 data rates may apply. Reply STOP to opt out.","links":[{"text":"SMS Terms","url":"https://example.com/sms-terms"},{"text":"Privacy Policy","url":"https://example.com/privacy"}],"phone":"+15551234567","source":"booking_form","state":"granted"},"properties":{"agreed":{"description":"True only while the person agrees and the choice was made for the lead's current phone number. False if they never ticked the box, unticked it later, replied STOP, or agreed for a different number (see `phone`).","example":true,"type":"boolean","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].agreed","typeLabel":"boolean"},"at":{"description":"When the current choice was made (ISO 8601): when they agreed, took it back, or finished the form without ticking the box.","example":"2026-10-08T10:00:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"disclosure":{"oneOf":[{"description":"The fine print shown beside the box, when it had any. For Aura's box for appointment texts: how often texts come, that rates may apply, and how to stop them. Null for other boxes.","example":null,"type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].disclosure.oneOf.0","typeLabel":"string"},{"description":"The fine print shown beside the box, when it had any. For Aura's box for appointment texts: how often texts come, that rates may apply, and how to stop them. Null for other boxes.","example":null,"type":"null","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].disclosure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent.items.[INDEX].disclosure","typeLabel":"string | null"},"granted_at":{"oneOf":[{"description":"For a `withdrawn` box, when they first agreed (ISO 8601). Null for every other state.","example":null,"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].granted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"For a `withdrawn` box, when they first agreed (ISO 8601). Null for every other state.","example":null,"format":"date-time","type":"null","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].granted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent.items.[INDEX].granted_at","typeLabel":"string\u003cdate-time> | null"},"id":{"description":"Which box this is, stable when its wording changes: the box's own id for a box your team added, `aura_sms` for Aura's box for appointment texts, `data_consent` for the data-processing box. Match on this, not on `label`.","example":"6f1b2c3d-0000-4000-8000-000000000001","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].id","typeLabel":"string"},"kind":{"description":"`custom`: a box your team added. `aura_sms`: Aura's own box for appointment texts. `data_consent`: the box for using personal data.","enum":["custom","data_consent","aura_sms"],"example":"custom","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"label":{"description":"The words on the box, as the person saw them.","example":"I agree to receive appointment reminder texts from Acme Inc. Msg \u0026 data rates may apply. Reply STOP to opt out.","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].label","typeLabel":"string"},"links":{"description":"The links the box showed, such as SMS terms or a privacy policy.","items":{"description":"A link a consent box showed, such as the SMS terms or the privacy policy.","properties":{"text":{"description":"The link's words, as the person saw them.","example":"SMS Terms","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].links.items.[INDEX].text","typeLabel":"string"},"url":{"description":"Where the link went.","example":"https://example.com/sms-terms","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].links.items.[INDEX].url","typeLabel":"string"}},"required":["text","url"],"type":"object","uniqueKey":"data.consent.items.[INDEX].links.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].links","typeLabel":"object[]"},"phone":{"oneOf":[{"description":"The phone number this choice was made for. If it is not the lead's phone now, `agreed` is false. Null for a choice made before Aura kept the number; that choice counts for the lead's phone now.","example":"+15551234567","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"description":"The phone number this choice was made for. If it is not the lead's phone now, `agreed` is false. Null for a choice made before Aura kept the number; that choice counts for the lead's phone now.","example":"+15551234567","type":"null","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent.items.[INDEX].phone","typeLabel":"string | null"},"source":{"oneOf":[{"description":"How the choice reached Aura. `booking_form`: the booking form. `sms_reply_stop` or `sms_reply_start`: the person texted STOP or START. `carrier_block`: their phone company blocked texts. `admin`: someone on the team changed it. `import`: it came in with imported data. Null when Aura did not record how.","enum":["booking_form","sms_reply_stop","sms_reply_start","carrier_block","admin","import",null],"example":"booking_form","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].source.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"How the choice reached Aura. `booking_form`: the booking form. `sms_reply_stop` or `sms_reply_start`: the person texted STOP or START. `carrier_block`: their phone company blocked texts. `admin`: someone on the team changed it. `import`: it came in with imported data. Null when Aura did not record how.","enum":["booking_form","sms_reply_stop","sms_reply_start","carrier_block","admin","import",null],"example":"booking_form","type":"null","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent.items.[INDEX].source","typeLabel":"enum\u003cstring> | null"},"state":{"description":"`granted`: they ticked the box. `withdrawn`: they agreed, then took it back, by unticking the box or replying STOP. `declined`: they finished the form without ticking the box, or said no before they ever agreed.","enum":["granted","withdrawn","declined"],"example":"granted","type":"string","isRequired":true,"uniqueKey":"data.consent.items.[INDEX].state","typeLabel":"enum\u003cstring>"}},"required":["id","kind","label","disclosure","agreed","state","at","granted_at","phone","source","links"],"type":"object","uniqueKey":"data.consent.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.consent","typeLabel":"object[]"},"consent_by_type":{"description":"One answer for each kind of message: booking texts, marketing texts, marketing emails and data use. Each answer is `yes`, `no` or `not_asked`, with when it last changed. Your team chooses which consent box asks about each kind, in Settings. Booking texts can also come from Aura's own box for appointment texts. `not_asked` means nothing the guest answered asks about that kind yet. Answers can change later (for example, the guest replies STOP), so check again right before you send.","example":{"data_processing":{"at":null,"id":null,"source":null,"state":"not_asked"},"email_marketing":{"at":null,"id":null,"source":null,"state":"not_asked"},"sms_booking":{"at":"2026-10-08T10:00:00.000Z","id":"6f1b2c3d-0000-4000-8000-000000000001","source":"box","state":"yes"},"sms_marketing":{"at":"2026-10-08T10:00:00.000Z","id":"6f1b2c3d-0000-4000-8000-000000000002","source":"box","state":"no"}},"properties":{"data_processing":{"description":"Data use: agreeing to your privacy policy, in a box your team added.","properties":{"at":{"oneOf":[{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.id.oneOf.0","typeLabel":"string"},{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.id","typeLabel":"string | null"},"source":{"oneOf":[{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.source.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.source","typeLabel":"enum\u003cstring> | null"},"state":{"description":"`yes`: they agreed. `no`: they left the box unticked or took it back (for example, by replying STOP). For texts, `no` also means they agreed for a different phone number. `not_asked`: no answer on file.","enum":["yes","no","not_asked"],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing.state","typeLabel":"enum\u003cstring>"}},"required":["state","at","source","id"],"type":"object","isRequired":true,"uniqueKey":"data.consent_by_type.data_processing","typeLabel":"object"},"email_marketing":{"description":"Marketing emails: emails with offers and newsletters.","properties":{"at":{"oneOf":[{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.id.oneOf.0","typeLabel":"string"},{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.id","typeLabel":"string | null"},"source":{"oneOf":[{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.source.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.source","typeLabel":"enum\u003cstring> | null"},"state":{"description":"`yes`: they agreed. `no`: they left the box unticked or took it back (for example, by replying STOP). For texts, `no` also means they agreed for a different phone number. `not_asked`: no answer on file.","enum":["yes","no","not_asked"],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing.state","typeLabel":"enum\u003cstring>"}},"required":["state","at","source","id"],"type":"object","isRequired":true,"uniqueKey":"data.consent_by_type.email_marketing","typeLabel":"object"},"sms_booking":{"description":"Booking texts: texts about their booked call, like reminders.","properties":{"at":{"oneOf":[{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.id.oneOf.0","typeLabel":"string"},{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.id","typeLabel":"string | null"},"source":{"oneOf":[{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.source.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.source","typeLabel":"enum\u003cstring> | null"},"state":{"description":"`yes`: they agreed. `no`: they left the box unticked or took it back (for example, by replying STOP). For texts, `no` also means they agreed for a different phone number. `not_asked`: no answer on file.","enum":["yes","no","not_asked"],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking.state","typeLabel":"enum\u003cstring>"}},"required":["state","at","source","id"],"type":"object","isRequired":true,"uniqueKey":"data.consent_by_type.sms_booking","typeLabel":"object"},"sms_marketing":{"description":"Marketing texts: texts with offers and promotions.","properties":{"at":{"oneOf":[{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the answer last changed (ISO 8601, UTC). Null when not asked.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.at","typeLabel":"string\u003cdate-time> | null"},"id":{"oneOf":[{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.id.oneOf.0","typeLabel":"string"},{"description":"The consent box the answer came from, the same `id` as in `consent`. Null when not asked.","type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.id","typeLabel":"string | null"},"source":{"oneOf":[{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.source.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Where the answer came from. `box`: one of your consent boxes. `aura_sms_opt_in`: Aura's own box for appointment texts, which a STOP reply turns off. Null when not asked.","enum":["box","aura_sms_opt_in",null],"type":"null","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.source","typeLabel":"enum\u003cstring> | null"},"state":{"description":"`yes`: they agreed. `no`: they left the box unticked or took it back (for example, by replying STOP). For texts, `no` also means they agreed for a different phone number. `not_asked`: no answer on file.","enum":["yes","no","not_asked"],"type":"string","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing.state","typeLabel":"enum\u003cstring>"}},"required":["state","at","source","id"],"type":"object","isRequired":true,"uniqueKey":"data.consent_by_type.sms_marketing","typeLabel":"object"}},"required":["sms_booking","sms_marketing","email_marketing","data_processing"],"type":"object","isRequired":true,"uniqueKey":"data.consent_by_type","typeLabel":"object"},"created_at":{"description":"ISO 8601 timestamp when lead was created","example":"2026-01-17T08:00:00Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"disqualification_data":{"oneOf":[{"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.disqualification_data.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.disqualification_data.oneOf.0.additionalProperties","typeLabel":"null"},"description":"Snapshot of the form-field state and ruleset that disqualified this lead during booking. Null when the lead was not disqualified. See the DisqualificationData schema for the full shape.","properties":{"archived_at":{"description":"ISO 8601 timestamp when the lead was archived.","type":"string","uniqueKey":"data.disqualification_data.oneOf.0.archived_at","typeLabel":"string"},"booking_link_id":{"oneOf":[{"description":"Booking link whose rule produced this disqualification.","type":"string","uniqueKey":"data.disqualification_data.oneOf.0.booking_link_id.oneOf.0","typeLabel":"string"},{"description":"Booking link whose rule produced this disqualification.","type":"null","uniqueKey":"data.disqualification_data.oneOf.0.booking_link_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.disqualification_data.oneOf.0.booking_link_id","typeLabel":"string | null"},"field_key":{"description":"Booking-form field key whose answer triggered disqualification (e.g. 'budget'). Present when the form disqualification rule produced this record.","type":"string","uniqueKey":"data.disqualification_data.oneOf.0.field_key","typeLabel":"string"},"field_label":{"description":"Human-readable label of the triggering field.","type":"string","uniqueKey":"data.disqualification_data.oneOf.0.field_label","typeLabel":"string"},"reason":{"description":"Free-text reason. Present when the lead was archived rather than disqualified by a form rule.","type":"string","uniqueKey":"data.disqualification_data.oneOf.0.reason","typeLabel":"string"},"timestamp":{"description":"ISO 8601 timestamp when the rule was evaluated.","example":"2026-05-08T14:23:11.000Z","type":"string","uniqueKey":"data.disqualification_data.oneOf.0.timestamp","typeLabel":"string"},"value":{"oneOf":[{"description":"The answer the lead gave that triggered disqualification.","uniqueKey":"data.disqualification_data.oneOf.0.value.oneOf.0","typeLabel":"any"},{"description":"The answer the lead gave that triggered disqualification.","type":"null","uniqueKey":"data.disqualification_data.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.disqualification_data.oneOf.0.value","typeLabel":"any | null"}},"type":"object","isRequired":true,"uniqueKey":"data.disqualification_data.oneOf.0","typeLabel":"object"},{"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.disqualification_data.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.disqualification_data.oneOf.1.additionalProperties","typeLabel":"null"},"description":"Snapshot of the form-field state and ruleset that disqualified this lead during booking. Null when the lead was not disqualified. See the DisqualificationData schema for the full shape.","properties":{"archived_at":{"description":"ISO 8601 timestamp when the lead was archived.","type":"string"},"booking_link_id":{"oneOf":[{"description":"Booking link whose rule produced this disqualification.","type":"string"},{"description":"Booking link whose rule produced this disqualification.","type":"null"}]},"field_key":{"description":"Booking-form field key whose answer triggered disqualification (e.g. 'budget'). Present when the form disqualification rule produced this record.","type":"string"},"field_label":{"description":"Human-readable label of the triggering field.","type":"string"},"reason":{"description":"Free-text reason. Present when the lead was archived rather than disqualified by a form rule.","type":"string"},"timestamp":{"description":"ISO 8601 timestamp when the rule was evaluated.","example":"2026-05-08T14:23:11.000Z","type":"string"},"value":{"oneOf":[{"description":"The answer the lead gave that triggered disqualification."},{"description":"The answer the lead gave that triggered disqualification.","type":"null"}]}},"type":"null","isRequired":true,"uniqueKey":"data.disqualification_data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.disqualification_data","typeLabel":"object | null"},"email":{"oneOf":[{"description":"Email address","example":"john@example.com","type":"string","isRequired":true,"uniqueKey":"data.email.oneOf.0","typeLabel":"string"},{"description":"Email address","example":"john@example.com","type":"null","isRequired":true,"uniqueKey":"data.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.email","typeLabel":"string | null"},"full_name":{"oneOf":[{"description":"Full name of the lead","example":"John Doe","type":"string","isRequired":true,"uniqueKey":"data.full_name.oneOf.0","typeLabel":"string"},{"description":"Full name of the lead","example":"John Doe","type":"null","isRequired":true,"uniqueKey":"data.full_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.full_name","typeLabel":"string | null"},"id":{"description":"Unique identifier for the lead","example":"550e8400-e29b-41d4-a716-446655440000","type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"last_payment_at":{"oneOf":[{"description":"Last payment timestamp","type":"string","isRequired":true,"uniqueKey":"data.last_payment_at.oneOf.0","typeLabel":"string"},{"description":"Last payment timestamp","type":"null","isRequired":true,"uniqueKey":"data.last_payment_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.last_payment_at","typeLabel":"string | null"},"metadata":{"oneOf":[{"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.additionalProperties","typeLabel":"null"},"description":"Lead attribution + browser + geolocation. JSONB with documented camelCase keys (utmSource, utmMedium, fbclid, gclid, referrer, etc.). Forward-compatible: unknown keys are accepted and round-trip unchanged. See the LeadMetadata schema for the full set of documented fields.","properties":{"city":{"oneOf":[{"description":"City name from IP geolocation.","type":"string","uniqueKey":"data.metadata.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City name from IP geolocation.","type":"null","uniqueKey":"data.metadata.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Country name from IP geolocation.","type":"string","uniqueKey":"data.metadata.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Country name from IP geolocation.","type":"null","uniqueKey":"data.metadata.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.country","typeLabel":"string | null"},"countryCode":{"oneOf":[{"description":"ISO 3166-1 alpha-2 country code from IP geolocation.","example":"US","type":"string","uniqueKey":"data.metadata.oneOf.0.countryCode.oneOf.0","typeLabel":"string"},{"description":"ISO 3166-1 alpha-2 country code from IP geolocation.","example":"US","type":"null","uniqueKey":"data.metadata.oneOf.0.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.countryCode","typeLabel":"string | null"},"dataConsentAcceptedAt":{"oneOf":[{"description":"ISO 8601 timestamp when GDPR data consent was accepted. Generated server-side at consent capture.","example":"2026-05-08T14:23:11.000Z","type":"string","uniqueKey":"data.metadata.oneOf.0.dataConsentAcceptedAt.oneOf.0","typeLabel":"string"},{"description":"ISO 8601 timestamp when GDPR data consent was accepted. Generated server-side at consent capture.","example":"2026-05-08T14:23:11.000Z","type":"null","uniqueKey":"data.metadata.oneOf.0.dataConsentAcceptedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.dataConsentAcceptedAt","typeLabel":"string | null"},"dclid":{"oneOf":[{"description":"Google Display Network click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.dclid.oneOf.0","typeLabel":"string"},{"description":"Google Display Network click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.dclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.dclid","typeLabel":"string | null"},"epik":{"oneOf":[{"description":"Pinterest click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.epik.oneOf.0","typeLabel":"string"},{"description":"Pinterest click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.epik.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.epik","typeLabel":"string | null"},"fbclid":{"oneOf":[{"description":"Meta (Facebook + Instagram) click ID. Pixel computes _fbc cookie from this.","type":"string","uniqueKey":"data.metadata.oneOf.0.fbclid.oneOf.0","typeLabel":"string"},{"description":"Meta (Facebook + Instagram) click ID. Pixel computes _fbc cookie from this.","type":"null","uniqueKey":"data.metadata.oneOf.0.fbclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.fbclid","typeLabel":"string | null"},"gadSource":{"oneOf":[{"description":"Google Ads source attribute (e.g. 'AdWords').","type":"string","uniqueKey":"data.metadata.oneOf.0.gadSource.oneOf.0","typeLabel":"string"},{"description":"Google Ads source attribute (e.g. 'AdWords').","type":"null","uniqueKey":"data.metadata.oneOf.0.gadSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.gadSource","typeLabel":"string | null"},"gbraid":{"oneOf":[{"description":"Google Ads iOS-era click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.gbraid.oneOf.0","typeLabel":"string"},{"description":"Google Ads iOS-era click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.gbraid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.gbraid","typeLabel":"string | null"},"gclid":{"oneOf":[{"description":"Google Ads classic click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.gclid.oneOf.0","typeLabel":"string"},{"description":"Google Ads classic click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.gclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.gclid","typeLabel":"string | null"},"gclsrc":{"oneOf":[{"description":"Google Ads source identifier.","type":"string","uniqueKey":"data.metadata.oneOf.0.gclsrc.oneOf.0","typeLabel":"string"},{"description":"Google Ads source identifier.","type":"null","uniqueKey":"data.metadata.oneOf.0.gclsrc.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.gclsrc","typeLabel":"string | null"},"hyclid":{"oneOf":[{"description":"Hyros click ID. Aura's primary attribution platform.","type":"string","uniqueKey":"data.metadata.oneOf.0.hyclid.oneOf.0","typeLabel":"string"},{"description":"Hyros click ID. Aura's primary attribution platform.","type":"null","uniqueKey":"data.metadata.oneOf.0.hyclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.hyclid","typeLabel":"string | null"},"ipAddress":{"oneOf":[{"description":"Client IP address. Used for geolocation enrichment.","type":"string","uniqueKey":"data.metadata.oneOf.0.ipAddress.oneOf.0","typeLabel":"string"},{"description":"Client IP address. Used for geolocation enrichment.","type":"null","uniqueKey":"data.metadata.oneOf.0.ipAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.ipAddress","typeLabel":"string | null"},"landingPage":{"oneOf":[{"description":"Originating landing-page URL (host + pathname, query string excluded). Forwarded by the Aura embed script from the host page's own location, so two landing pages sharing one booking link and identical UTMs stay distinguishable. Unlike `referrer`, this preserves the page path. Absent for direct (non-embedded) bookings.","example":"acme.com/sales-manager","type":"string","uniqueKey":"data.metadata.oneOf.0.landingPage.oneOf.0","typeLabel":"string"},{"description":"Originating landing-page URL (host + pathname, query string excluded). Forwarded by the Aura embed script from the host page's own location, so two landing pages sharing one booking link and identical UTMs stay distinguishable. Unlike `referrer`, this preserves the page path. Absent for direct (non-embedded) bookings.","example":"acme.com/sales-manager","type":"null","uniqueKey":"data.metadata.oneOf.0.landingPage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.landingPage","typeLabel":"string | null"},"landingUrl":{"oneOf":[{"description":"The full address of the host page, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API is stored as sent. Surfaced on the lead as `source.landing_url`. Absent for direct (non-embedded) bookings.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"string","uniqueKey":"data.metadata.oneOf.0.landingUrl.oneOf.0","typeLabel":"string"},{"description":"The full address of the host page, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API is stored as sent. Surfaced on the lead as `source.landing_url`. Absent for direct (non-embedded) bookings.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"null","uniqueKey":"data.metadata.oneOf.0.landingUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.landingUrl","typeLabel":"string | null"},"language":{"oneOf":[{"description":"Browser language preference (e.g. 'en-US').","example":"en-US","type":"string","uniqueKey":"data.metadata.oneOf.0.language.oneOf.0","typeLabel":"string"},{"description":"Browser language preference (e.g. 'en-US').","example":"en-US","type":"null","uniqueKey":"data.metadata.oneOf.0.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.language","typeLabel":"string | null"},"latitude":{"oneOf":[{"description":"Latitude from IP geolocation.","type":"number","uniqueKey":"data.metadata.oneOf.0.latitude.oneOf.0","typeLabel":"number"},{"description":"Latitude from IP geolocation.","type":"null","uniqueKey":"data.metadata.oneOf.0.latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.latitude","typeLabel":"number | null"},"liFatId":{"oneOf":[{"description":"LinkedIn Ads first-party ad tracking ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.liFatId.oneOf.0","typeLabel":"string"},{"description":"LinkedIn Ads first-party ad tracking ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.liFatId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.liFatId","typeLabel":"string | null"},"longitude":{"oneOf":[{"description":"Longitude from IP geolocation.","type":"number","uniqueKey":"data.metadata.oneOf.0.longitude.oneOf.0","typeLabel":"number"},{"description":"Longitude from IP geolocation.","type":"null","uniqueKey":"data.metadata.oneOf.0.longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.longitude","typeLabel":"number | null"},"msclkid":{"oneOf":[{"description":"Microsoft Ads (Bing) click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.msclkid.oneOf.0","typeLabel":"string"},{"description":"Microsoft Ads (Bing) click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.msclkid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.msclkid","typeLabel":"string | null"},"partner":{"oneOf":[{"description":"Partner program name or ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.partner.oneOf.0","typeLabel":"string"},{"description":"Partner program name or ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.partner.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.partner","typeLabel":"string | null"},"rdtCid":{"oneOf":[{"description":"Reddit click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.rdtCid.oneOf.0","typeLabel":"string"},{"description":"Reddit click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.rdtCid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.rdtCid","typeLabel":"string | null"},"ref":{"oneOf":[{"description":"Generic referral code or partner attribution identifier.","type":"string","uniqueKey":"data.metadata.oneOf.0.ref.oneOf.0","typeLabel":"string"},{"description":"Generic referral code or partner attribution identifier.","type":"null","uniqueKey":"data.metadata.oneOf.0.ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.ref","typeLabel":"string | null"},"referrer":{"oneOf":[{"description":"HTTP referrer URL. For embeds, the host page where the booking widget was displayed (e.g. 'acme.com/book-a-call'). For direct visits, the traffic source URL.","example":"https://acme.com/book-a-call","type":"string","uniqueKey":"data.metadata.oneOf.0.referrer.oneOf.0","typeLabel":"string"},{"description":"HTTP referrer URL. For embeds, the host page where the booking widget was displayed (e.g. 'acme.com/book-a-call'). For direct visits, the traffic source URL.","example":"https://acme.com/book-a-call","type":"null","uniqueKey":"data.metadata.oneOf.0.referrer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.referrer","typeLabel":"string | null"},"region":{"oneOf":[{"description":"Region/state from IP geolocation.","type":"string","uniqueKey":"data.metadata.oneOf.0.region.oneOf.0","typeLabel":"string"},{"description":"Region/state from IP geolocation.","type":"null","uniqueKey":"data.metadata.oneOf.0.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.region","typeLabel":"string | null"},"scCid":{"oneOf":[{"description":"Snapchat click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.scCid.oneOf.0","typeLabel":"string"},{"description":"Snapchat click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.scCid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.scCid","typeLabel":"string | null"},"screenHeight":{"oneOf":[{"description":"Screen height in pixels.","type":"number","uniqueKey":"data.metadata.oneOf.0.screenHeight.oneOf.0","typeLabel":"number"},{"description":"Screen height in pixels.","type":"null","uniqueKey":"data.metadata.oneOf.0.screenHeight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.screenHeight","typeLabel":"number | null"},"screenWidth":{"oneOf":[{"description":"Screen width in pixels.","type":"number","uniqueKey":"data.metadata.oneOf.0.screenWidth.oneOf.0","typeLabel":"number"},{"description":"Screen width in pixels.","type":"null","uniqueKey":"data.metadata.oneOf.0.screenWidth.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.screenWidth","typeLabel":"number | null"},"setterCode":{"oneOf":[{"description":"The first setter link code saved for this lead (`?aura_setter=`). It may come from a later visit than the lead's first, and it does not record who set any call. Use a call's `setter_id` for that.","type":"string","uniqueKey":"data.metadata.oneOf.0.setterCode.oneOf.0","typeLabel":"string"},{"description":"The first setter link code saved for this lead (`?aura_setter=`). It may come from a later visit than the lead's first, and it does not record who set any call. Use a call's `setter_id` for that.","type":"null","uniqueKey":"data.metadata.oneOf.0.setterCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.setterCode","typeLabel":"string | null"},"ttclid":{"oneOf":[{"description":"TikTok Ads click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.ttclid.oneOf.0","typeLabel":"string"},{"description":"TikTok Ads click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.ttclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.ttclid","typeLabel":"string | null"},"twclid":{"oneOf":[{"description":"X (Twitter) Ads click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.twclid.oneOf.0","typeLabel":"string"},{"description":"X (Twitter) Ads click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.twclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.twclid","typeLabel":"string | null"},"userAgent":{"oneOf":[{"description":"Browser user agent string. Used for device/browser analytics.","type":"string","uniqueKey":"data.metadata.oneOf.0.userAgent.oneOf.0","typeLabel":"string"},{"description":"Browser user agent string. Used for device/browser analytics.","type":"null","uniqueKey":"data.metadata.oneOf.0.userAgent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.userAgent","typeLabel":"string | null"},"utmCampaign":{"oneOf":[{"description":"UTM campaign param (e.g. 'summer_promo'). Identifies the specific campaign.","example":"spring-2026","type":"string","uniqueKey":"data.metadata.oneOf.0.utmCampaign.oneOf.0","typeLabel":"string"},{"description":"UTM campaign param (e.g. 'summer_promo'). Identifies the specific campaign.","example":"spring-2026","type":"null","uniqueKey":"data.metadata.oneOf.0.utmCampaign.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.utmCampaign","typeLabel":"string | null"},"utmContent":{"oneOf":[{"description":"UTM content param. Differentiates ad creatives or A/B test variants.","type":"string","uniqueKey":"data.metadata.oneOf.0.utmContent.oneOf.0","typeLabel":"string"},{"description":"UTM content param. Differentiates ad creatives or A/B test variants.","type":"null","uniqueKey":"data.metadata.oneOf.0.utmContent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.utmContent","typeLabel":"string | null"},"utmId":{"oneOf":[{"description":"GA4 utm_id parameter for cross-platform attribution.","type":"string","uniqueKey":"data.metadata.oneOf.0.utmId.oneOf.0","typeLabel":"string"},{"description":"GA4 utm_id parameter for cross-platform attribution.","type":"null","uniqueKey":"data.metadata.oneOf.0.utmId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.utmId","typeLabel":"string | null"},"utmMedium":{"oneOf":[{"description":"UTM medium param (e.g. 'cpc', 'email', 'social'). Identifies the marketing channel type.","example":"cpc","type":"string","uniqueKey":"data.metadata.oneOf.0.utmMedium.oneOf.0","typeLabel":"string"},{"description":"UTM medium param (e.g. 'cpc', 'email', 'social'). Identifies the marketing channel type.","example":"cpc","type":"null","uniqueKey":"data.metadata.oneOf.0.utmMedium.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.utmMedium","typeLabel":"string | null"},"utmSource":{"oneOf":[{"description":"UTM source param (e.g. 'google', 'facebook'). Identifies the traffic platform that drove the lead.","example":"google","type":"string","uniqueKey":"data.metadata.oneOf.0.utmSource.oneOf.0","typeLabel":"string"},{"description":"UTM source param (e.g. 'google', 'facebook'). Identifies the traffic platform that drove the lead.","example":"google","type":"null","uniqueKey":"data.metadata.oneOf.0.utmSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.utmSource","typeLabel":"string | null"},"utmTerm":{"oneOf":[{"description":"UTM term param. Paid search keywords or targeting criteria.","type":"string","uniqueKey":"data.metadata.oneOf.0.utmTerm.oneOf.0","typeLabel":"string"},{"description":"UTM term param. Paid search keywords or targeting criteria.","type":"null","uniqueKey":"data.metadata.oneOf.0.utmTerm.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.utmTerm","typeLabel":"string | null"},"wbraid":{"oneOf":[{"description":"Google Ads web-to-app click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.wbraid.oneOf.0","typeLabel":"string"},{"description":"Google Ads web-to-app click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.wbraid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.wbraid","typeLabel":"string | null"},"yclid":{"oneOf":[{"description":"Yandex click ID.","type":"string","uniqueKey":"data.metadata.oneOf.0.yclid.oneOf.0","typeLabel":"string"},{"description":"Yandex click ID.","type":"null","uniqueKey":"data.metadata.oneOf.0.yclid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.0.yclid","typeLabel":"string | null"}},"type":"object","isRequired":true,"uniqueKey":"data.metadata.oneOf.0","typeLabel":"object"},{"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.metadata.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.oneOf.1.additionalProperties","typeLabel":"null"},"description":"Lead attribution + browser + geolocation. JSONB with documented camelCase keys (utmSource, utmMedium, fbclid, gclid, referrer, etc.). Forward-compatible: unknown keys are accepted and round-trip unchanged. See the LeadMetadata schema for the full set of documented fields.","properties":{"city":{"oneOf":[{"description":"City name from IP geolocation.","type":"string"},{"description":"City name from IP geolocation.","type":"null"}]},"country":{"oneOf":[{"description":"Country name from IP geolocation.","type":"string"},{"description":"Country name from IP geolocation.","type":"null"}]},"countryCode":{"oneOf":[{"description":"ISO 3166-1 alpha-2 country code from IP geolocation.","example":"US","type":"string"},{"description":"ISO 3166-1 alpha-2 country code from IP geolocation.","example":"US","type":"null"}]},"dataConsentAcceptedAt":{"oneOf":[{"description":"ISO 8601 timestamp when GDPR data consent was accepted. Generated server-side at consent capture.","example":"2026-05-08T14:23:11.000Z","type":"string"},{"description":"ISO 8601 timestamp when GDPR data consent was accepted. Generated server-side at consent capture.","example":"2026-05-08T14:23:11.000Z","type":"null"}]},"dclid":{"oneOf":[{"description":"Google Display Network click ID.","type":"string"},{"description":"Google Display Network click ID.","type":"null"}]},"epik":{"oneOf":[{"description":"Pinterest click ID.","type":"string"},{"description":"Pinterest click ID.","type":"null"}]},"fbclid":{"oneOf":[{"description":"Meta (Facebook + Instagram) click ID. Pixel computes _fbc cookie from this.","type":"string"},{"description":"Meta (Facebook + Instagram) click ID. Pixel computes _fbc cookie from this.","type":"null"}]},"gadSource":{"oneOf":[{"description":"Google Ads source attribute (e.g. 'AdWords').","type":"string"},{"description":"Google Ads source attribute (e.g. 'AdWords').","type":"null"}]},"gbraid":{"oneOf":[{"description":"Google Ads iOS-era click ID.","type":"string"},{"description":"Google Ads iOS-era click ID.","type":"null"}]},"gclid":{"oneOf":[{"description":"Google Ads classic click ID.","type":"string"},{"description":"Google Ads classic click ID.","type":"null"}]},"gclsrc":{"oneOf":[{"description":"Google Ads source identifier.","type":"string"},{"description":"Google Ads source identifier.","type":"null"}]},"hyclid":{"oneOf":[{"description":"Hyros click ID. Aura's primary attribution platform.","type":"string"},{"description":"Hyros click ID. Aura's primary attribution platform.","type":"null"}]},"ipAddress":{"oneOf":[{"description":"Client IP address. Used for geolocation enrichment.","type":"string"},{"description":"Client IP address. Used for geolocation enrichment.","type":"null"}]},"landingPage":{"oneOf":[{"description":"Originating landing-page URL (host + pathname, query string excluded). Forwarded by the Aura embed script from the host page's own location, so two landing pages sharing one booking link and identical UTMs stay distinguishable. Unlike `referrer`, this preserves the page path. Absent for direct (non-embedded) bookings.","example":"acme.com/sales-manager","type":"string"},{"description":"Originating landing-page URL (host + pathname, query string excluded). Forwarded by the Aura embed script from the host page's own location, so two landing pages sharing one booking link and identical UTMs stay distinguishable. Unlike `referrer`, this preserves the page path. Absent for direct (non-embedded) bookings.","example":"acme.com/sales-manager","type":"null"}]},"landingUrl":{"oneOf":[{"description":"The full address of the host page, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API is stored as sent. Surfaced on the lead as `source.landing_url`. Absent for direct (non-embedded) bookings.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"string"},{"description":"The full address of the host page, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API is stored as sent. Surfaced on the lead as `source.landing_url`. Absent for direct (non-embedded) bookings.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"null"}]},"language":{"oneOf":[{"description":"Browser language preference (e.g. 'en-US').","example":"en-US","type":"string"},{"description":"Browser language preference (e.g. 'en-US').","example":"en-US","type":"null"}]},"latitude":{"oneOf":[{"description":"Latitude from IP geolocation.","type":"number"},{"description":"Latitude from IP geolocation.","type":"null"}]},"liFatId":{"oneOf":[{"description":"LinkedIn Ads first-party ad tracking ID.","type":"string"},{"description":"LinkedIn Ads first-party ad tracking ID.","type":"null"}]},"longitude":{"oneOf":[{"description":"Longitude from IP geolocation.","type":"number"},{"description":"Longitude from IP geolocation.","type":"null"}]},"msclkid":{"oneOf":[{"description":"Microsoft Ads (Bing) click ID.","type":"string"},{"description":"Microsoft Ads (Bing) click ID.","type":"null"}]},"partner":{"oneOf":[{"description":"Partner program name or ID.","type":"string"},{"description":"Partner program name or ID.","type":"null"}]},"rdtCid":{"oneOf":[{"description":"Reddit click ID.","type":"string"},{"description":"Reddit click ID.","type":"null"}]},"ref":{"oneOf":[{"description":"Generic referral code or partner attribution identifier.","type":"string"},{"description":"Generic referral code or partner attribution identifier.","type":"null"}]},"referrer":{"oneOf":[{"description":"HTTP referrer URL. For embeds, the host page where the booking widget was displayed (e.g. 'acme.com/book-a-call'). For direct visits, the traffic source URL.","example":"https://acme.com/book-a-call","type":"string"},{"description":"HTTP referrer URL. For embeds, the host page where the booking widget was displayed (e.g. 'acme.com/book-a-call'). For direct visits, the traffic source URL.","example":"https://acme.com/book-a-call","type":"null"}]},"region":{"oneOf":[{"description":"Region/state from IP geolocation.","type":"string"},{"description":"Region/state from IP geolocation.","type":"null"}]},"scCid":{"oneOf":[{"description":"Snapchat click ID.","type":"string"},{"description":"Snapchat click ID.","type":"null"}]},"screenHeight":{"oneOf":[{"description":"Screen height in pixels.","type":"number"},{"description":"Screen height in pixels.","type":"null"}]},"screenWidth":{"oneOf":[{"description":"Screen width in pixels.","type":"number"},{"description":"Screen width in pixels.","type":"null"}]},"setterCode":{"oneOf":[{"description":"The first setter link code saved for this lead (`?aura_setter=`). It may come from a later visit than the lead's first, and it does not record who set any call. Use a call's `setter_id` for that.","type":"string"},{"description":"The first setter link code saved for this lead (`?aura_setter=`). It may come from a later visit than the lead's first, and it does not record who set any call. Use a call's `setter_id` for that.","type":"null"}]},"ttclid":{"oneOf":[{"description":"TikTok Ads click ID.","type":"string"},{"description":"TikTok Ads click ID.","type":"null"}]},"twclid":{"oneOf":[{"description":"X (Twitter) Ads click ID.","type":"string"},{"description":"X (Twitter) Ads click ID.","type":"null"}]},"userAgent":{"oneOf":[{"description":"Browser user agent string. Used for device/browser analytics.","type":"string"},{"description":"Browser user agent string. Used for device/browser analytics.","type":"null"}]},"utmCampaign":{"oneOf":[{"description":"UTM campaign param (e.g. 'summer_promo'). Identifies the specific campaign.","example":"spring-2026","type":"string"},{"description":"UTM campaign param (e.g. 'summer_promo'). Identifies the specific campaign.","example":"spring-2026","type":"null"}]},"utmContent":{"oneOf":[{"description":"UTM content param. Differentiates ad creatives or A/B test variants.","type":"string"},{"description":"UTM content param. Differentiates ad creatives or A/B test variants.","type":"null"}]},"utmId":{"oneOf":[{"description":"GA4 utm_id parameter for cross-platform attribution.","type":"string"},{"description":"GA4 utm_id parameter for cross-platform attribution.","type":"null"}]},"utmMedium":{"oneOf":[{"description":"UTM medium param (e.g. 'cpc', 'email', 'social'). Identifies the marketing channel type.","example":"cpc","type":"string"},{"description":"UTM medium param (e.g. 'cpc', 'email', 'social'). Identifies the marketing channel type.","example":"cpc","type":"null"}]},"utmSource":{"oneOf":[{"description":"UTM source param (e.g. 'google', 'facebook'). Identifies the traffic platform that drove the lead.","example":"google","type":"string"},{"description":"UTM source param (e.g. 'google', 'facebook'). Identifies the traffic platform that drove the lead.","example":"google","type":"null"}]},"utmTerm":{"oneOf":[{"description":"UTM term param. Paid search keywords or targeting criteria.","type":"string"},{"description":"UTM term param. Paid search keywords or targeting criteria.","type":"null"}]},"wbraid":{"oneOf":[{"description":"Google Ads web-to-app click ID.","type":"string"},{"description":"Google Ads web-to-app click ID.","type":"null"}]},"yclid":{"oneOf":[{"description":"Yandex click ID.","type":"string"},{"description":"Yandex click ID.","type":"null"}]}},"type":"null","isRequired":true,"uniqueKey":"data.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object | null"},"notes":{"oneOf":[{"description":"Internal notes attached to the lead, ordered oldest-first. Each note has content + created_at + optional user_id. See the LeadNote schema for the full shape.","items":{"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.notes.oneOf.0.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.notes.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"null"},"properties":{"content":{"description":"Note body. Plain text or markdown.","type":"string","isRequired":true,"uniqueKey":"data.notes.oneOf.0.items.[INDEX].content","typeLabel":"string"},"created_at":{"description":"ISO 8601 timestamp when the note was created.","example":"2026-05-08T14:23:11.000Z","type":"string","isRequired":true,"uniqueKey":"data.notes.oneOf.0.items.[INDEX].created_at","typeLabel":"string"},"user_id":{"oneOf":[{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"string","uniqueKey":"data.notes.oneOf.0.items.[INDEX].user_id.oneOf.0","typeLabel":"string"},{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"null","uniqueKey":"data.notes.oneOf.0.items.[INDEX].user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.notes.oneOf.0.items.[INDEX].user_id","typeLabel":"string | null"}},"required":["content","created_at"],"type":"object","uniqueKey":"data.notes.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.notes.oneOf.0","typeLabel":"object[]"},{"description":"Internal notes attached to the lead, ordered oldest-first. Each note has content + created_at + optional user_id. See the LeadNote schema for the full shape.","items":{"additionalProperties":{"oneOf":[{},{"type":"null"}]},"properties":{"content":{"description":"Note body. Plain text or markdown.","type":"string"},"created_at":{"description":"ISO 8601 timestamp when the note was created.","example":"2026-05-08T14:23:11.000Z","type":"string"},"user_id":{"oneOf":[{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"string"},{"description":"ID of the user who created the note. Null for system-generated notes (e.g. notes synced from external CRMs via the API).","type":"null"}]}},"required":["content","created_at"],"type":"object"},"type":"null","isRequired":true,"uniqueKey":"data.notes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.notes","typeLabel":"object[] | null"},"payment_count":{"oneOf":[{"description":"Number of payments received","type":"number","isRequired":true,"uniqueKey":"data.payment_count.oneOf.0","typeLabel":"number"},{"description":"Number of payments received","type":"null","isRequired":true,"uniqueKey":"data.payment_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.payment_count","typeLabel":"number | null"},"payment_status":{"oneOf":[{"description":"Rolled-up payment state for this lead: `partial` once any payment has been recorded, `pending` before the first one or after refunds return the total to zero. It does not report whether a deal is paid in full, so do not treat `partial` as a shortfall — use total_paid_cents for the amount.","type":"string","isRequired":true,"uniqueKey":"data.payment_status.oneOf.0","typeLabel":"string"},{"description":"Rolled-up payment state for this lead: `partial` once any payment has been recorded, `pending` before the first one or after refunds return the total to zero. It does not report whether a deal is paid in full, so do not treat `partial` as a shortfall — use total_paid_cents for the amount.","type":"null","isRequired":true,"uniqueKey":"data.payment_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.payment_status","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number in E.164 format","example":"+14155552671","type":"string","isRequired":true,"uniqueKey":"data.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number in E.164 format","example":"+14155552671","type":"null","isRequired":true,"uniqueKey":"data.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.phone","typeLabel":"string | null"},"pipeline_stage":{"oneOf":[{"description":"The column the lead is in on the Opportunities board right now, worked out from its calls each time you read it. Use this to show where a lead stands. `status` is a stored value that can lag behind: when a guest confirms a call, `pipeline_stage` says `confirmed` at once, while `status` can still say `booked` until Aura's status sync updates it. The same value as `stage` on the lead's opportunities. For up to an hour after a disqualification rule changes, it can differ from the board, which applies the new rule on its next sync. Null only if Aura could not read the lead's calls.","enum":["interested","disqualified","qualified","booked","confirmed","declined","cancelled","attended","unfit","no_show","follow_up","lost","won",null],"example":"confirmed","type":"string","isRequired":true,"uniqueKey":"data.pipeline_stage.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The column the lead is in on the Opportunities board right now, worked out from its calls each time you read it. Use this to show where a lead stands. `status` is a stored value that can lag behind: when a guest confirms a call, `pipeline_stage` says `confirmed` at once, while `status` can still say `booked` until Aura's status sync updates it. The same value as `stage` on the lead's opportunities. For up to an hour after a disqualification rule changes, it can differ from the board, which applies the new rule on its next sync. Null only if Aura could not read the lead's calls.","enum":["interested","disqualified","qualified","booked","confirmed","declined","cancelled","attended","unfit","no_show","follow_up","lost","won",null],"example":"confirmed","type":"null","isRequired":true,"uniqueKey":"data.pipeline_stage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.pipeline_stage","typeLabel":"enum\u003cstring> | null"},"source":{"oneOf":[{"description":"Lead source attribution. Use with booking_link_id on calls to get the full picture: which campaign drove this lead, from which page, into which funnel.","properties":{"attribution_platform":{"oneOf":[{"description":"Derived ad platform (meta, google, tiktok, linkedin, …) from click IDs or utm_source","example":"google","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.attribution_platform.oneOf.0","typeLabel":"string"},{"description":"Derived ad platform (meta, google, tiktok, linkedin, …) from click IDs or utm_source","example":"google","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.attribution_platform.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.attribution_platform","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City detected from the visitor's IP address","example":"San Francisco","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City detected from the visitor's IP address","example":"San Francisco","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"description":"Country detected from the visitor's IP address","example":"US","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"Country detected from the visitor's IP address","example":"US","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.country","typeLabel":"string | null"},"country_code":{"oneOf":[{"description":"ISO 3166-1 alpha-2 country code","example":"US","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"description":"ISO 3166-1 alpha-2 country code","example":"US","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.country_code","typeLabel":"string | null"},"epik":{"oneOf":[{"description":"Pinterest Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.epik.oneOf.0","typeLabel":"string"},{"description":"Pinterest Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.epik.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.epik","typeLabel":"string | null"},"fbc":{"oneOf":[{"description":"Meta _fbc cookie (framed click ID)","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.fbc.oneOf.0","typeLabel":"string"},{"description":"Meta _fbc cookie (framed click ID)","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.fbc.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.fbc","typeLabel":"string | null"},"fbclid":{"oneOf":[{"description":"Meta (Facebook/Instagram) click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.fbclid.oneOf.0","typeLabel":"string"},{"description":"Meta (Facebook/Instagram) click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.fbclid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.fbclid","typeLabel":"string | null"},"fbp":{"oneOf":[{"description":"Meta _fbp cookie (browser ID)","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.fbp.oneOf.0","typeLabel":"string"},{"description":"Meta _fbp cookie (browser ID)","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.fbp.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.fbp","typeLabel":"string | null"},"gbraid":{"oneOf":[{"description":"Google Ads iOS app-to-web click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.gbraid.oneOf.0","typeLabel":"string"},{"description":"Google Ads iOS app-to-web click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.gbraid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.gbraid","typeLabel":"string | null"},"gclid":{"oneOf":[{"description":"Google Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.gclid.oneOf.0","typeLabel":"string"},{"description":"Google Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.gclid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.gclid","typeLabel":"string | null"},"hyclid":{"oneOf":[{"description":"Hyros click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.hyclid.oneOf.0","typeLabel":"string"},{"description":"Hyros click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.hyclid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.hyclid","typeLabel":"string | null"},"landing_page":{"oneOf":[{"description":"Originating landing-page URL (host + pathname). Preserves the page path that `referrer` loses cross-origin, so pages sharing one booking link and identical UTMs stay distinguishable.","example":"acme.com/sales-manager","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.landing_page.oneOf.0","typeLabel":"string"},{"description":"Originating landing-page URL (host + pathname). Preserves the page path that `referrer` loses cross-origin, so pages sharing one booking link and identical UTMs stay distinguishable.","example":"acme.com/sales-manager","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.landing_page.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.landing_page","typeLabel":"string | null"},"li_fat_id":{"oneOf":[{"description":"LinkedIn Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.li_fat_id.oneOf.0","typeLabel":"string"},{"description":"LinkedIn Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.li_fat_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.li_fat_id","typeLabel":"string | null"},"msclkid":{"oneOf":[{"description":"Microsoft/Bing Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.msclkid.oneOf.0","typeLabel":"string"},{"description":"Microsoft/Bing Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.msclkid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.msclkid","typeLabel":"string | null"},"rdt_cid":{"oneOf":[{"description":"Reddit Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.rdt_cid.oneOf.0","typeLabel":"string"},{"description":"Reddit Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.rdt_cid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.rdt_cid","typeLabel":"string | null"},"referrer":{"oneOf":[{"description":"HTTP referrer URL. For embeds, this is the host page where the booking widget was displayed. For direct visits, this is the traffic source URL.","example":"https://acme.com/book-a-call","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.referrer.oneOf.0","typeLabel":"string"},{"description":"HTTP referrer URL. For embeds, this is the host page where the booking widget was displayed. For direct visits, this is the traffic source URL.","example":"https://acme.com/book-a-call","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.referrer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.referrer","typeLabel":"string | null"},"region":{"oneOf":[{"description":"State/region detected from the visitor's IP address","example":"CA","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.region.oneOf.0","typeLabel":"string"},{"description":"State/region detected from the visitor's IP address","example":"CA","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.region.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.region","typeLabel":"string | null"},"sc_cid":{"oneOf":[{"description":"Snapchat Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.sc_cid.oneOf.0","typeLabel":"string"},{"description":"Snapchat Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.sc_cid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.sc_cid","typeLabel":"string | null"},"ttclid":{"oneOf":[{"description":"TikTok Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.ttclid.oneOf.0","typeLabel":"string"},{"description":"TikTok Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.ttclid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.ttclid","typeLabel":"string | null"},"twclid":{"oneOf":[{"description":"X (Twitter) Ads click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.twclid.oneOf.0","typeLabel":"string"},{"description":"X (Twitter) Ads click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.twclid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.twclid","typeLabel":"string | null"},"utm_campaign":{"oneOf":[{"description":"UTM campaign parameter — identifies the specific marketing campaign","example":"summer_promo","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_campaign.oneOf.0","typeLabel":"string"},{"description":"UTM campaign parameter — identifies the specific marketing campaign","example":"summer_promo","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_campaign.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_campaign","typeLabel":"string | null"},"utm_content":{"oneOf":[{"description":"UTM content parameter — differentiates ad creatives or A/B test variants","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_content.oneOf.0","typeLabel":"string"},{"description":"UTM content parameter — differentiates ad creatives or A/B test variants","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_content","typeLabel":"string | null"},"utm_id":{"oneOf":[{"description":"GA4 campaign ID (utm_id)","example":"1234567890","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_id.oneOf.0","typeLabel":"string"},{"description":"GA4 campaign ID (utm_id)","example":"1234567890","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_id","typeLabel":"string | null"},"utm_medium":{"oneOf":[{"description":"UTM medium parameter — identifies the marketing channel type (e.g., cpc, email, social)","example":"cpc","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_medium.oneOf.0","typeLabel":"string"},{"description":"UTM medium parameter — identifies the marketing channel type (e.g., cpc, email, social)","example":"cpc","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_medium.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_medium","typeLabel":"string | null"},"utm_source":{"oneOf":[{"description":"UTM source parameter — identifies the traffic platform (e.g., google, facebook, twitter)","example":"google","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_source.oneOf.0","typeLabel":"string"},{"description":"UTM source parameter — identifies the traffic platform (e.g., google, facebook, twitter)","example":"google","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_source","typeLabel":"string | null"},"utm_term":{"oneOf":[{"description":"UTM term parameter — paid search keywords or targeting criteria","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_term.oneOf.0","typeLabel":"string"},{"description":"UTM term parameter — paid search keywords or targeting criteria","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_term.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.utm_term","typeLabel":"string | null"},"wbraid":{"oneOf":[{"description":"Google Ads web-to-iOS click ID","type":"string","isRequired":true,"uniqueKey":"data.source.oneOf.0.wbraid.oneOf.0","typeLabel":"string"},{"description":"Google Ads web-to-iOS click ID","type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.0.wbraid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source.oneOf.0.wbraid","typeLabel":"string | null"},"landing_url":{"oneOf":[{"description":"The full address of the page the lead landed on, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API as `metadata.landingUrl` is stored as sent. Null when the lead has none. Optional: a client must not require it.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"string","uniqueKey":"data.source.oneOf.0.landing_url.oneOf.0","typeLabel":"string"},{"description":"The full address of the page the lead landed on, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API as `metadata.landingUrl` is stored as sent. Null when the lead has none. Optional: a client must not require it.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"null","uniqueKey":"data.source.oneOf.0.landing_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.source.oneOf.0.landing_url","typeLabel":"string | null"}},"required":["utm_source","utm_medium","utm_campaign","utm_term","utm_content","referrer","landing_page","utm_id","city","region","country","country_code","fbclid","gclid","fbc","fbp","gbraid","wbraid","msclkid","li_fat_id","ttclid","twclid","hyclid","epik","sc_cid","rdt_cid","attribution_platform"],"type":"object","isRequired":true,"uniqueKey":"data.source.oneOf.0","typeLabel":"object"},{"description":"Lead source attribution. Use with booking_link_id on calls to get the full picture: which campaign drove this lead, from which page, into which funnel.","properties":{"attribution_platform":{"oneOf":[{"description":"Derived ad platform (meta, google, tiktok, linkedin, …) from click IDs or utm_source","example":"google","type":"string"},{"description":"Derived ad platform (meta, google, tiktok, linkedin, …) from click IDs or utm_source","example":"google","type":"null"}]},"city":{"oneOf":[{"description":"City detected from the visitor's IP address","example":"San Francisco","type":"string"},{"description":"City detected from the visitor's IP address","example":"San Francisco","type":"null"}]},"country":{"oneOf":[{"description":"Country detected from the visitor's IP address","example":"US","type":"string"},{"description":"Country detected from the visitor's IP address","example":"US","type":"null"}]},"country_code":{"oneOf":[{"description":"ISO 3166-1 alpha-2 country code","example":"US","type":"string"},{"description":"ISO 3166-1 alpha-2 country code","example":"US","type":"null"}]},"epik":{"oneOf":[{"description":"Pinterest Ads click ID","type":"string"},{"description":"Pinterest Ads click ID","type":"null"}]},"fbc":{"oneOf":[{"description":"Meta _fbc cookie (framed click ID)","type":"string"},{"description":"Meta _fbc cookie (framed click ID)","type":"null"}]},"fbclid":{"oneOf":[{"description":"Meta (Facebook/Instagram) click ID","type":"string"},{"description":"Meta (Facebook/Instagram) click ID","type":"null"}]},"fbp":{"oneOf":[{"description":"Meta _fbp cookie (browser ID)","type":"string"},{"description":"Meta _fbp cookie (browser ID)","type":"null"}]},"gbraid":{"oneOf":[{"description":"Google Ads iOS app-to-web click ID","type":"string"},{"description":"Google Ads iOS app-to-web click ID","type":"null"}]},"gclid":{"oneOf":[{"description":"Google Ads click ID","type":"string"},{"description":"Google Ads click ID","type":"null"}]},"hyclid":{"oneOf":[{"description":"Hyros click ID","type":"string"},{"description":"Hyros click ID","type":"null"}]},"landing_page":{"oneOf":[{"description":"Originating landing-page URL (host + pathname). Preserves the page path that `referrer` loses cross-origin, so pages sharing one booking link and identical UTMs stay distinguishable.","example":"acme.com/sales-manager","type":"string"},{"description":"Originating landing-page URL (host + pathname). Preserves the page path that `referrer` loses cross-origin, so pages sharing one booking link and identical UTMs stay distinguishable.","example":"acme.com/sales-manager","type":"null"}]},"landing_url":{"oneOf":[{"description":"The full address of the page the lead landed on, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API as `metadata.landingUrl` is stored as sent. Null when the lead has none. Optional: a client must not require it.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"string"},{"description":"The full address of the page the lead landed on, query string included. Recorded by the Aura embed loaders with credentials removed. Like the UTM fields it is visitor-supplied attribution, not a verified address; a value supplied through this API as `metadata.landingUrl` is stored as sent. Null when the lead has none. Optional: a client must not require it.","example":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","type":"null"}]},"li_fat_id":{"oneOf":[{"description":"LinkedIn Ads click ID","type":"string"},{"description":"LinkedIn Ads click ID","type":"null"}]},"msclkid":{"oneOf":[{"description":"Microsoft/Bing Ads click ID","type":"string"},{"description":"Microsoft/Bing Ads click ID","type":"null"}]},"rdt_cid":{"oneOf":[{"description":"Reddit Ads click ID","type":"string"},{"description":"Reddit Ads click ID","type":"null"}]},"referrer":{"oneOf":[{"description":"HTTP referrer URL. For embeds, this is the host page where the booking widget was displayed. For direct visits, this is the traffic source URL.","example":"https://acme.com/book-a-call","type":"string"},{"description":"HTTP referrer URL. For embeds, this is the host page where the booking widget was displayed. For direct visits, this is the traffic source URL.","example":"https://acme.com/book-a-call","type":"null"}]},"region":{"oneOf":[{"description":"State/region detected from the visitor's IP address","example":"CA","type":"string"},{"description":"State/region detected from the visitor's IP address","example":"CA","type":"null"}]},"sc_cid":{"oneOf":[{"description":"Snapchat Ads click ID","type":"string"},{"description":"Snapchat Ads click ID","type":"null"}]},"ttclid":{"oneOf":[{"description":"TikTok Ads click ID","type":"string"},{"description":"TikTok Ads click ID","type":"null"}]},"twclid":{"oneOf":[{"description":"X (Twitter) Ads click ID","type":"string"},{"description":"X (Twitter) Ads click ID","type":"null"}]},"utm_campaign":{"oneOf":[{"description":"UTM campaign parameter — identifies the specific marketing campaign","example":"summer_promo","type":"string"},{"description":"UTM campaign parameter — identifies the specific marketing campaign","example":"summer_promo","type":"null"}]},"utm_content":{"oneOf":[{"description":"UTM content parameter — differentiates ad creatives or A/B test variants","type":"string"},{"description":"UTM content parameter — differentiates ad creatives or A/B test variants","type":"null"}]},"utm_id":{"oneOf":[{"description":"GA4 campaign ID (utm_id)","example":"1234567890","type":"string"},{"description":"GA4 campaign ID (utm_id)","example":"1234567890","type":"null"}]},"utm_medium":{"oneOf":[{"description":"UTM medium parameter — identifies the marketing channel type (e.g., cpc, email, social)","example":"cpc","type":"string"},{"description":"UTM medium parameter — identifies the marketing channel type (e.g., cpc, email, social)","example":"cpc","type":"null"}]},"utm_source":{"oneOf":[{"description":"UTM source parameter — identifies the traffic platform (e.g., google, facebook, twitter)","example":"google","type":"string"},{"description":"UTM source parameter — identifies the traffic platform (e.g., google, facebook, twitter)","example":"google","type":"null"}]},"utm_term":{"oneOf":[{"description":"UTM term parameter — paid search keywords or targeting criteria","type":"string"},{"description":"UTM term parameter — paid search keywords or targeting criteria","type":"null"}]},"wbraid":{"oneOf":[{"description":"Google Ads web-to-iOS click ID","type":"string"},{"description":"Google Ads web-to-iOS click ID","type":"null"}]}},"required":["utm_source","utm_medium","utm_campaign","utm_term","utm_content","referrer","landing_page","utm_id","city","region","country","country_code","fbclid","gclid","fbc","fbp","gbraid","wbraid","msclkid","li_fat_id","ttclid","twclid","hyclid","epik","sc_cid","rdt_cid","attribution_platform"],"type":"null","isRequired":true,"uniqueKey":"data.source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source","typeLabel":"object | null"},"status":{"description":"Lead status","example":"new","type":"string","isRequired":true,"uniqueKey":"data.status","typeLabel":"string"},"timezone":{"oneOf":[{"description":"Lead's timezone","example":"America/New_York","type":"string","isRequired":true,"uniqueKey":"data.timezone.oneOf.0","typeLabel":"string"},{"description":"Lead's timezone","example":"America/New_York","type":"null","isRequired":true,"uniqueKey":"data.timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.timezone","typeLabel":"string | null"},"total_paid_cents":{"oneOf":[{"description":"Total amount paid in cents","type":"number","isRequired":true,"uniqueKey":"data.total_paid_cents.oneOf.0","typeLabel":"number"},{"description":"Total amount paid in cents","type":"null","isRequired":true,"uniqueKey":"data.total_paid_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.total_paid_cents","typeLabel":"number | null"},"updated_at":{"description":"ISO 8601 timestamp when lead was last updated","example":"2026-01-17T09:30:00Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","full_name","email","phone","company","status","pipeline_stage","notes","metadata","source","attribution","timezone","disqualification_data","payment_status","payment_count","total_paid_cents","last_payment_at","consent","consent_by_type","created_at","updated_at"],"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"success":{"enum":[true],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"}},"required":["success","data"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"attribution":{"am_wuid":"wuid_4o251b0b130v3z6d5q0n","fbclid":"IwAR_sample_fbclid","utm_source":"facebook"},"company":"Acme Corp","consent":[{"agreed":true,"at":"2026-10-08T10:00:00.000Z","disclosure":null,"granted_at":null,"id":"6f1b2c3d-0000-4000-8000-000000000001","kind":"custom","label":"I agree to receive appointment reminder texts from Acme Inc. Msg \u0026 data rates may apply. Reply STOP to opt out.","links":[{"text":"SMS Terms","url":"https://example.com/sms-terms"},{"text":"Privacy Policy","url":"https://example.com/privacy"}],"phone":"+15551234567","source":"booking_form","state":"granted"},{"agreed":false,"at":"2026-10-08T10:00:00.000Z","disclosure":null,"granted_at":null,"id":"6f1b2c3d-0000-4000-8000-000000000002","kind":"custom","label":"I agree to receive promotional texts from Acme Inc.","links":[],"phone":"+15551234567","source":"booking_form","state":"declined"}],"consent_by_type":{"data_processing":{"at":null,"id":null,"source":null,"state":"not_asked"},"email_marketing":{"at":null,"id":null,"source":null,"state":"not_asked"},"sms_booking":{"at":"2026-10-08T10:00:00.000Z","id":"6f1b2c3d-0000-4000-8000-000000000001","source":"box","state":"yes"},"sms_marketing":{"at":"2026-10-08T10:00:00.000Z","id":"6f1b2c3d-0000-4000-8000-000000000002","source":"box","state":"no"}},"created_at":"2026-01-17T08:00:00Z","disqualification_data":{"archived_at":"\u003cstring>","booking_link_id":"\u003cstring>","field_key":"\u003cstring>","field_label":"\u003cstring>","reason":"\u003cstring>","timestamp":"2026-05-08T14:23:11.000Z","value":"\u003cunknown>"},"email":"john@example.com","full_name":"John Doe","id":"550e8400-e29b-41d4-a716-446655440000","last_payment_at":"\u003cstring>","metadata":{"city":"\u003cstring>","country":"\u003cstring>","countryCode":"US","dataConsentAcceptedAt":"2026-05-08T14:23:11.000Z","dclid":"\u003cstring>","epik":"\u003cstring>","fbclid":"\u003cstring>","gadSource":"\u003cstring>","gbraid":"\u003cstring>","gclid":"\u003cstring>","gclsrc":"\u003cstring>","hyclid":"\u003cstring>","ipAddress":"\u003cstring>","landingPage":"acme.com/sales-manager","landingUrl":"https://acme.com/sales-manager?utm_source=google\u0026variant=b","language":"en-US","latitude":123,"liFatId":"\u003cstring>","longitude":123,"msclkid":"\u003cstring>","partner":"\u003cstring>","rdtCid":"\u003cstring>","ref":"\u003cstring>","referrer":"https://acme.com/book-a-call","region":"\u003cstring>","scCid":"\u003cstring>","screenHeight":123,"screenWidth":123,"setterCode":"\u003cstring>","ttclid":"\u003cstring>","twclid":"\u003cstring>","userAgent":"\u003cstring>","utmCampaign":"spring-2026","utmContent":"\u003cstring>","utmId":"\u003cstring>","utmMedium":"cpc","utmSource":"google","utmTerm":"\u003cstring>","wbraid":"\u003cstring>","yclid":"\u003cstring>"},"notes":[{"content":"\u003cstring>","created_at":"2026-05-08T14:23:11.000Z","user_id":"\u003cstring>"}],"payment_count":123,"payment_status":"\u003cstring>","phone":"+14155552671","pipeline_stage":"confirmed","source":{"attribution_platform":"google","city":"San Francisco","country":"US","country_code":"US","epik":"\u003cstring>","fbc":"\u003cstring>","fbclid":"\u003cstring>","fbp":"\u003cstring>","gbraid":"\u003cstring>","gclid":"\u003cstring>","hyclid":"\u003cstring>","landing_page":"acme.com/sales-manager","li_fat_id":"\u003cstring>","msclkid":"\u003cstring>","rdt_cid":"\u003cstring>","referrer":"https://acme.com/book-a-call","region":"CA","sc_cid":"\u003cstring>","ttclid":"\u003cstring>","twclid":"\u003cstring>","utm_campaign":"summer_promo","utm_content":"\u003cstring>","utm_id":"1234567890","utm_medium":"cpc","utm_source":"google","utm_term":"\u003cstring>","wbraid":"\u003cstring>","landing_url":"https://acme.com/sales-manager?utm_source=google\u0026variant=b"},"status":"new","timezone":"America/New_York","total_paid_cents":123,"updated_at":"2026-01-17T09:30:00Z"},"success":true}}},"exampleType":"generated"}},"description":"Successfully updated lead","exampleType":"generated"},"ad9a35e7-0342-4e11-b549-47018f7ce023":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code for programmatic handling","example":"NOT_FOUND","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"description":"Human-readable error message","example":"Lead not found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"description":"Request ID for support debugging","example":"req_abc123","type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","error":"Lead not found","success":false,"requestId":"req_abc123"}}},"exampleType":"generated"}},"description":"Validation error (e.g., empty body or invalid field)","exampleType":"generated"},"b4eb981e-d5e8-4783-a83d-b4c013f77342":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code for programmatic handling","example":"NOT_FOUND","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"description":"Human-readable error message","example":"Lead not found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"description":"Request ID for support debugging","example":"req_abc123","type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","error":"Lead not found","success":false,"requestId":"req_abc123"}}},"exampleType":"generated"}},"description":"Invalid or missing API key","exampleType":"generated"},"e5445bb0-ec0b-48c5-9d7f-1889a3231d55":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The organization's subscription is not active","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"5ceeabe1-9620-47f4-9575-ebf2eae0fe5d":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The API key does not have the required scope","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"189ffda3-4b9b-4b56-b040-052cef2b5a88":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code for programmatic handling","example":"NOT_FOUND","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"description":"Human-readable error message","example":"Lead not found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"description":"Request ID for support debugging","example":"req_abc123","type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","error":"Lead not found","success":false,"requestId":"req_abc123"}}},"exampleType":"generated"}},"description":"Lead not found","exampleType":"generated"},"7b3f117d-5753-4456-a238-448868c8f634":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The request exceeded its processing time limit. Check the outcome before retrying a write","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"961f32f9-80fb-4d4a-bf8e-f624589204c2":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The request body exceeds 256KB","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"b32883b5-b218-4c28-9467-d1fc52f16cc2":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Rate limit exceeded. Wait before retrying","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed in the current window","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Window reset as a Unix timestamp","schema":{"type":"string"}},"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"},"b3b08a59-a8be-4373-9487-a6e895752f95":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"success":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"requestId":{"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["success","error","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","error":"\u003cstring>","success":false,"requestId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Unexpected server failure. Include the request identifier when contacting support","headers":{"X-Request-Id":{"description":"Request identifier for support","schema":{"type":"string"}}},"exampleType":"generated"}},"security":{"eebeaedc-3226-4bf6-b1b5-3b5d2ccd13ae":{"bearerAuth":{"$ref":"56e72429-aa35-437e-be77-86bf3e446da7","scopes":[]}}},"servers":{"5221a7e1-3d3d-4c69-849e-b4d57dd9af35":{"description":"Production","url":"https://api.aura-app.ai"},"171a8e50-7771-4b7a-972e-29a2e587af64":{"description":"Staging","url":"https://staging-api.aura-app.ai"},"5e31f02a-c4b3-4824-b16e-80268ce26955":{"description":"Local Development","url":"http://localhost:3001"}}},"originalFileLocation":"openapi.json"},"subdomain":"aura-84f04a78","siteName":"Aura API","title":"Update lead - Aura API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T04:36:14.311Z","originalFileLocation":"openapi/v1/leads/id/patch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update fields on an existing lead. Only provided fields will be updated; all others remain unchanged. Updatable fields: - full_name, email, phone, company, status, timezone, notes At least one field is required — an empty body returns 400 VALIDATION_ERROR.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aura API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update lead - Aura API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update fields on an existing lead. Only provided fields will be updated; all others remain unchanged. Updatable fields: - full_name, email, phone, company, status, timezone, notes At least one field is required — an empty body returns 400 VALIDATION_ERROR.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aura API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aura-84f04a78.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=Update+lead\u0026amp;description=%0AUpdate+fields+on+an+existing+lead.%0A%0AOnly+provided+fields+will+be+updated%3B+all+others+remain+unchanged.%0A%0A**Updatable+fields%3A**%0A-+%60full_name%60%2C+%60email%60%2C+%60phone%60%2C+\u0026amp;theme=913ff3c47c90e1d37f4e1ee0\u0026amp;signature=694dbd9230d466af97df70ebcaa50b1e04caf16aec411ed077260e0fb9940d03\">\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=\"Update lead - Aura API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update fields on an existing lead. Only provided fields will be updated; all others remain unchanged. Updatable fields: - full_name, email, phone, company, status, timezone, notes At least one field is required — an empty body returns 400 VALIDATION_ERROR.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aura-84f04a78.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=Update+lead\u0026amp;description=%0AUpdate+fields+on+an+existing+lead.%0A%0AOnly+provided+fields+will+be+updated%3B+all+others+remain+unchanged.%0A%0A**Updatable+fields%3A**%0A-+%60full_name%60%2C+%60email%60%2C+%60phone%60%2C+\u0026amp;theme=913ff3c47c90e1d37f4e1ee0\u0026amp;signature=694dbd9230d466af97df70ebcaa50b1e04caf16aec411ed077260e0fb9940d03\">\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/aura-84f04a78/cStcaL859tMNjx1b/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aura API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/openapi/v1/leads/id/patch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.api.aura-app.ai/#organization\",\"name\":\"Aura API\",\"url\":\"https://docs.api.aura-app.ai\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.api.aura-app.ai#website\",\"name\":\"Aura API\",\"url\":\"https://docs.api.aura-app.ai\",\"publisher\":{\"@id\":\"https://docs.api.aura-app.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch#webpage\",\"url\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch\",\"name\":\"Update lead\",\"description\":\"Update fields on an existing lead. Only provided fields will be updated; all others remain unchanged. Updatable fields: - full_name, email, phone, company, status, timezone, notes At least one field is required — an empty body returns 400 VALIDATION_ERROR.\",\"dateModified\":\"2026-09-28T04:36:14.311Z\",\"isPartOf\":{\"@id\":\"https://docs.api.aura-app.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/leads/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Leads\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/leads/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update lead\",\"item\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch#apireference\",\"headline\":\"Update lead\",\"name\":\"Update lead\",\"description\":\"Update fields on an existing lead. Only provided fields will be updated; all others remain unchanged. Updatable fields: - full_name, email, phone, company, status, timezone, notes At least one field is required — an empty body returns 400 VALIDATION_ERROR.\",\"url\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.api.aura-app.ai/openapi/v1/leads/id/patch#webpage\"},\"dateModified\":\"2026-09-28T04:36:14.311Z\",\"publisher\":{\"@id\":\"https://docs.api.aura-app.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.api.aura-app.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aura API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aura API","nav":{"global":null,"tabs":[{"tab":"REST API","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":""}]},{"group":"Guides","pages":[{"title":"Making requests","href":"/requests"},{"title":"GraphQL","href":"/graphql"},{"title":"TypeScript client","href":"/sdk"},{"title":"MCP","href":"/mcp-connector"},{"title":"Webhooks","href":"/webhooks"}]},{"group":"API reference","pages":[{"group":"Leads","pages":[{"title":"List leads","openapi":"openapi.json GET /v1/leads","href":"/openapi/v1/leads/get"},{"title":"Archive lead","openapi":"openapi.json DELETE /v1/leads/{id}","href":"/openapi/v1/leads/id/delete"},{"title":"Get lead by ID","openapi":"openapi.json GET /v1/leads/{id}","href":"/openapi/v1/leads/id/get"},{"title":"List lead notes","openapi":"openapi.json GET /v1/leads/{id}/notes","href":"/openapi/v1/leads/id/notes/get"},{"title":"Add lead note","description":"\nAppend an internal note to a lead. The note is timestamped server-side and\nappears in the Aura dashboard immediately.\n\nAPI-created notes carry no `user_id` (system-note semantics — same as the\nGraphQL `leadAddNote` mutation, which shares this append path).\n\nReturns the lead's full notes array including the newly appended note.\n ","openapi":"openapi.json POST /v1/leads/{id}/notes","href":"/openapi/v1/leads/id/notes/post"},{"title":"Update lead","openapi":"openapi.json PATCH /v1/leads/{id}","href":"/openapi/v1/leads/id/patch"},{"title":"Create lead","description":"\nCreate a new lead in your organization.\n\n**Use Cases:**\n- Partner systems creating leads from external sources\n- CRM integrations syncing leads into Aura\n- Manual lead entry from external applications\n\n**Required fields:**\n- `email` - Must be a valid email address\n\n**Optional fields:**\n- `full_name`, `phone`, `company`, `timezone`, `visitor_id`, `metadata`\n\nNew leads are created with status \"new\" by default.\n ","openapi":"openapi.json POST /v1/leads","href":"/openapi/v1/leads/post"}]},{"group":"Calls","pages":[{"title":"List calls","openapi":"openapi.json GET /v1/calls","href":"/openapi/v1/calls/get"},{"title":"Get call analysis","openapi":"openapi.json GET /v1/calls/{id}/analysis","href":"/openapi/v1/calls/id/analysis/get"},{"title":"Get call form answers","openapi":"openapi.json GET /v1/calls/{id}/answers","href":"/openapi/v1/calls/id/answers/get"},{"title":"Cancel a booked call","openapi":"openapi.json POST /v1/calls/{id}/cancel","href":"/openapi/v1/calls/id/cancel/post"},{"title":"Get call by ID","openapi":"openapi.json GET /v1/calls/{id}","href":"/openapi/v1/calls/id/get"},{"title":"Set call outcome","openapi":"openapi.json POST /v1/calls/{id}/outcome","href":"/openapi/v1/calls/id/outcome/post"},{"title":"Update call","openapi":"openapi.json PATCH /v1/calls/{id}","href":"/openapi/v1/calls/id/patch"},{"title":"Reassign a booked call to a different closer","openapi":"openapi.json POST /v1/calls/{id}/reassign-closer","href":"/openapi/v1/calls/id/reassign-closer/post"},{"title":"Reschedule a booked call","openapi":"openapi.json POST /v1/calls/{id}/reschedule","href":"/openapi/v1/calls/id/reschedule/post"},{"title":"Create a booking","openapi":"openapi.json POST /v1/calls","href":"/openapi/v1/calls/post"}]},{"group":"Opportunities","pages":[{"title":"List opportunities","openapi":"openapi.json GET /v1/opportunities","href":"/openapi/v1/opportunities/get"},{"title":"Get opportunity by ID","openapi":"openapi.json GET /v1/opportunities/{id}","href":"/openapi/v1/opportunities/id/get"}]},{"group":"Lead qualifications","pages":[{"title":"Qualify a lead (preview)","openapi":"openapi.json POST /v1/lead-qualifications","href":"/openapi/v1/lead-qualifications/post"}]},{"group":"Schedulers","pages":[{"title":"List schedulers","openapi":"openapi.json GET /v1/booking-links","href":"/openapi/v1/booking-links/get"},{"title":"Get bookable time slots for a scheduler","openapi":"openapi.json GET /v1/booking-links/{id}/availability","href":"/openapi/v1/booking-links/id/availability/get"},{"title":"Get scheduler field schema","openapi":"openapi.json GET /v1/booking-links/{id}/fields","href":"/openapi/v1/booking-links/id/fields/get"},{"title":"Get scheduler by ID","openapi":"openapi.json GET /v1/booking-links/{id}","href":"/openapi/v1/booking-links/id/get"}]},{"group":"Team","pages":[{"title":"List team members","openapi":"openapi.json GET /v1/team","href":"/openapi/v1/team/get"},{"title":"Get team member by ID","openapi":"openapi.json GET /v1/team/{id}","href":"/openapi/v1/team/id/get"},{"title":"Get team performance summary","openapi":"openapi.json GET /v1/team/performance","href":"/openapi/v1/team/performance/get"}]},{"group":"Products","pages":[{"title":"List products","openapi":"openapi.json GET /v1/products","href":"/openapi/v1/products/get"},{"title":"Get product by ID","openapi":"openapi.json GET /v1/products/{id}","href":"/openapi/v1/products/id/get"}]},{"group":"Payments","pages":[{"title":"List payments","openapi":"openapi.json GET /v1/payments","href":"/openapi/v1/payments/get"},{"title":"Get payment by ID","openapi":"openapi.json GET /v1/payments/{id}","href":"/openapi/v1/payments/id/get"},{"title":"Update payment","openapi":"openapi.json PATCH /v1/payments/{id}","href":"/openapi/v1/payments/id/patch"},{"title":"Verify payment","openapi":"openapi.json POST /v1/payments/{id}/verify","href":"/openapi/v1/payments/id/verify/post"},{"title":"Record payment","openapi":"openapi.json POST /v1/payments","href":"/openapi/v1/payments/post"}]},{"group":"Analytics","pages":[{"title":"Get per-ad funnel performance","openapi":"openapi.json GET /v1/analytics/ad-performance","href":"/openapi/v1/analytics/ad-performance/get"},{"title":"Get campaign analytics","openapi":"openapi.json GET /v1/analytics/campaigns","href":"/openapi/v1/analytics/campaigns/get"},{"title":"Get dashboard analytics","openapi":"openapi.json GET /v1/analytics/dashboard","href":"/openapi/v1/analytics/dashboard/get"},{"title":"Get lead source analytics","openapi":"openapi.json GET /v1/analytics/lead-sources","href":"/openapi/v1/analytics/lead-sources/get"},{"title":"Get objection analytics","openapi":"openapi.json GET /v1/analytics/objections","href":"/openapi/v1/analytics/objections/get"},{"title":"Get revenue grouped by recorded currency","openapi":"openapi.json GET /v1/analytics/revenue","href":"/openapi/v1/analytics/revenue/get"}]},{"group":"Funnel","pages":[{"title":"Ingest an external funnel event","openapi":"openapi.json POST /v1/funnel/events","href":"/openapi/v1/funnel/events/post"}]},{"group":"Webhooks","pages":[{"title":"List webhook delivery logs","openapi":"openapi.json GET /v1/webhooks/deliveries","href":"/openapi/v1/webhooks/deliveries/get"},{"title":"List webhook subscriptions","openapi":"openapi.json GET /v1/webhooks","href":"/openapi/v1/webhooks/get"},{"title":"Delete webhook subscription","openapi":"openapi.json DELETE /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/delete"},{"title":"Get webhook subscription by ID","openapi":"openapi.json GET /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/get"},{"title":"Update webhook subscription","openapi":"openapi.json PATCH /v1/webhooks/{id}","href":"/openapi/v1/webhooks/id/patch"},{"title":"Rotate webhook secret","openapi":"openapi.json POST /v1/webhooks/{id}/rotate-secret","href":"/openapi/v1/webhooks/id/rotate-secret/post"},{"title":"Create webhook subscription","openapi":"openapi.json POST /v1/webhooks","href":"/openapi/v1/webhooks/post"},{"title":"Test webhook subscription","openapi":"openapi.json POST /v1/webhooks/test","href":"/openapi/v1/webhooks/test/post"}]}]}]},{"tab":"GraphQL API","pages":[{"title":"GraphQL API","href":"/graphql-reference/queries/adPerformance"}]}]},"title":"Update lead - Aura API","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}