Adds a case manager to a referral that belongs to the authenticated group.
name and at least one valid email are required. Phone numbers are stored
as digits. status_email defaults to true and co_sign_emails defaults
to false. The write stays on this referral.
Authorization: Bearer <api_token>. Reuse the same token on later requests
until it expires or is revoked. Do not request a new token for each call.
The token does not expire after 24 hours. Sandbox tokens come from Get
API keys and allow 2,000 successful requests or 7 days, or 90 days with
an access code. Failed 4xx/5xx responses do not consume the allowance.
Production tokens are issued from the group's API access tab and last
until the expiry set there, or until revoked when no expiry is set.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Scan.com API Documentation","colors":{"primary":"#003232","light":"#FF99B8","dark":"#003232"},"logo":{"light":"https://mintcdn.com/scan-com/_-KBidYPt8PW4M4Z/images/ca8ecc128f60c97d6de1a0d908bab6dbfff58b663f9828b8213265ec5d562cc9-small-scan.png?fit=max\u0026auto=format\u0026n=_-KBidYPt8PW4M4Z\u0026q=85\u0026s=972a9758501541167d6c2b5457da5ff4","dark":"https://mintcdn.com/scan-com/_-KBidYPt8PW4M4Z/images/6469ae1a627ec8c46696f1ff8585b2635a2de323b0d4b83c707c32315dfa374f-scan-light.png?fit=max\u0026auto=format\u0026n=_-KBidYPt8PW4M4Z\u0026q=85\u0026s=65196a41ef2e08bf2a90c67910e79b74"},"favicon":"https://mintcdn.com/scan-com/Zp6julhcqVvnDZpy/images/c0b4ca86b256219d03f5d9492ba898a70ee48ad1bef8cb521afe2ecc19014c3b-scan.ico?fit=max\u0026auto=format\u0026n=Zp6julhcqVvnDZpy\u0026q=85\u0026s=eefe2cdb644cd6105232c66034dc14b0","api":{"examples":{"defaults":"required","languages":["curl","ruby","python","javascript","php","go"],"prefill":true}},"appearance":{"default":"system","strict":false},"background":{"decoration":"gradient","color":{"light":"#FBFBF9","dark":"#0A1D1D"}},"navbar":{"primary":{"type":"button","label":"Get API keys","href":"https://admin.staging.scan.com/partner/api_access"}},"seo":{"metatags":{"canonical":"https://docs.scan.com"},"organization":{"name":"Scan.com","url":"https://scan.com","logo":"https://docs.scan.com/images/ca8ecc128f60c97d6de1a0d908bab6dbfff58b663f9828b8213265ec5d562cc9-small-scan.png"},"indexing":"navigable"},"fonts":{"heading":{"family":"Maison Neue","weight":500,"source":"fonts/MaisonNeue-Medium.woff2","format":"woff2"},"body":{"family":"Maison Neue","weight":400,"source":"fonts/MaisonNeue-Book.woff2","format":"woff2"}},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Postman collection","icon":"download","href":"/guides/api-tools#postman-collection"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scan-com","hasAudioNarration":false,"actualSubdomain":"scan-com","customDomains":["docs.scan.com"],"gitSource":{"type":"github","owner":"scandotcom","repo":"api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeb3466e84fb046db8bfb48","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":51},{"language":"default","tag":"Referrals","count":23},{"language":"default","tag":"Guides","count":20},{"language":"default","tag":"Platform","count":11},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Patient journey","count":5},{"language":"default","tag":"Referral status","count":5},{"language":"default","tag":"Operations","count":4},{"language":"default","tag":"Order Documents","count":4},{"language":"default","tag":"Patients","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"[email protected]"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"@font-face{font-family:\"Maison Neue Mono\";src:url(\"/fonts/MaisonNeueMono-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}:root{--color-pink-lightest: #fff0f4;--color-pink-light: #ffdae4;--color-pink-primary: #fea2bb;--color-pink-dark: #420322;--color-green-lightest: #e5f5f4;--color-green-lighter: #84c2c2;--color-green-light: #00575a;--color-green-primary: #003232;--color-green-dark: #001f1f;--color-cream-primary: #ecece6;--color-cream-light: #f5f5f2;--color-cream-lighter: #fbfbf9;--border-1: #dfe7e7;--border-2: #ccd6d6;--shadow-sm: 0 1px 2px 0 rgba(3, 18, 18, 0.06);--shadow-md:\n 0 4px 8px -2px rgba(3, 18, 18, 0.12), 0 2px 4px -2px rgba(3, 18, 18, 0.07);--radius-card: 24px;--radius-panel: 16px;--font-mono-brand: \"Maison Neue Mono\", ui-monospace, SFMono-Regular, Menlo,\n monospace;--gray-50: 243 246 246;--gray-100: 238 242 242;--gray-200: 223 231 231;--gray-300: 204 214 214;--gray-400: 151 170 170;--gray-500: 102 122 122;--gray-600: 70 89 89;--gray-700: 49 68 68;--gray-800: 29 43 43;--gray-900: 19 32 32;--gray-950: 3 18 18}code,pre,kbd{font-family:var(--font-mono-brand)}::selection{background:var(--color-pink-light);color:var(--color-green-dark)}.dark #page-title h1,.dark #content-area :is(h1,h2,h3,h4){color:var(--color-cream-light)}html:not(.dark) #page-title h1,html:not(.dark) #content-area :is(h1,h2,h3,h4){color:var(--color-green-primary)}[class*=\"bg-[#3064E3]\"][class]{background-color:var(--color-pink-primary);color:var(--color-pink-dark)}.method-nav-pill [class*=\"bg-[#3064E3]\"][class]{background-color:var(--color-green-primary);color:#ffffff}html:not(.dark) [class*=\"bg-blue-400/20\"]{background-color:var(--color-green-primary);color:#ffffff}.dark [class*=\"bg-blue-400/20\"]{background-color:rgb(255 153 184 / 0.16);color:var(--color-pink-primary)}html:not(.dark) [class*=\"bg-green-400/20\"]{background-color:var(--color-green-lightest);color:var(--color-green-primary)}.dark [class*=\"bg-green-400/20\"]{background-color:rgb(132 194 194 / 0.18);color:var(--color-green-lighter)}html:not(.dark) #content-area .card{background-color:#ffffff;border-color:var(--border-1);border-radius:var(--radius-card);box-shadow:var(--shadow-sm);transition:border-color 150ms cubic-bezier(0, 0, 0.2, 1),\n box-shadow 150ms cubic-bezier(0, 0, 0.2, 1)}html:not(.dark) #content-area a.card:hover{border-color:var(--color-green-lighter);box-shadow:var(--shadow-md)}html:not(.dark) #navigation-items a[class~=\"bg-primary/10\"]{background-color:var(--color-green-lightest);color:var(--color-green-primary);font-weight:500}#navigation-items .sidebar-title{font-family:var(--font-mono-brand);font-size:11px;letter-spacing:0.09em;text-transform:uppercase}html[data-current-path=\"/introduction\"] #header{display:none}.scan-hero{position:relative;overflow:hidden;background:var(--color-green-primary);border-radius:32px;padding:56px;margin-bottom:32px}.scan-hero-eyebrow{font-family:var(--font-mono-brand);font-size:13px;text-transform:uppercase;letter-spacing:0.08em;color:var(--color-pink-primary);margin-bottom:20px}#content-area .scan-hero h1.scan-hero-title{font-weight:400;font-size:clamp(34px, 4.2vw, 54px);line-height:1.04;letter-spacing:-0.02em;color:#ffffff;margin:0 0 20px;text-wrap:pretty}.scan-hero-lead{font-size:18px;line-height:1.55;color:rgb(255 255 255 / 0.75);margin:0;max-width:60ch;text-wrap:pretty}.scan-hero-cta{position:relative;z-index:1;display:inline-flex;align-items:center;margin-top:28px;padding:12px 22px;border-radius:9999px;background:var(--color-pink-primary);color:var(--color-pink-dark);font-size:15px;font-weight:500;text-decoration:none}.scan-hero-cta:hover{background:var(--color-pink-light);color:var(--color-pink-dark)}.scan-hero::after{content:\"\";position:absolute;right:-140px;top:-180px;width:520px;height:520px;border-radius:50%;pointer-events:none;background:radial-gradient(\n circle,\n transparent 29%,\n rgb(255 255 255 / 0.24) 29%,\n rgb(255 255 255 / 0.24) 30%,\n transparent 30%\n ),\n radial-gradient(\n circle,\n transparent 43%,\n rgb(255 255 255 / 0.18) 43%,\n rgb(255 255 255 / 0.18) 44%,\n transparent 44%\n ),\n radial-gradient(\n circle,\n transparent 57%,\n rgb(255 255 255 / 0.12) 57%,\n rgb(255 255 255 / 0.12) 58%,\n transparent 58%\n )}@media (max-width: 640px){.scan-hero{padding:32px 24px}.scan-hero::after{display:none}}html[data-current-path=\"/webhooks/status-changed\"] .font-mono.flex.items-center>.min-w-max{font-size:0}html[data-current-path=\"/webhooks/status-changed\"] .font-mono.flex.items-center>.min-w-max::after{content:\"Status changed\";font-size:0.875rem;line-height:1.25rem;font-weight:500}html[data-current-path=\"/webhooks/status-changed\"] .mdx-content .mb-14>.api-section:first-child{display:none}"}],"page":{"pagePath":"api-reference/referrals/creates-a-case-manager-on-a-referral","slug":"/api-reference/referrals/creates-a-case-manager-on-a-referral","pageMetadata":{"title":"Creates a case manager on a referral","description":"Adds a case manager to a referral that belongs to the authenticated group.\n`name` and at least one valid email are required. Phone numbers are stored\nas digits. `status_email` defaults to true and `co_sign_emails` defaults\nto false. The write stays on this referral.\n","deprecated":null,"version":null,"sidebarTitle":"Creates a case manager on a referral","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/case_managers","href":"/api-reference/referrals/creates-a-case-manager-on-a-referral","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Adds a case manager to a referral that belongs to the authenticated group.\\n\", _jsx(_components.code, {\n children: \"name\"\n }), \" and at least one valid email are required. Phone numbers are stored\\nas digits. \", _jsx(_components.code, {\n children: \"status_email\"\n }), \" defaults to true and \", _jsx(_components.code, {\n children: \"co_sign_emails\"\n }), \" defaults\\nto false. The write stays on this referral.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Creates a case manager on a referral","description":"Adds a case manager to a referral that belongs to the authenticated group.\n`name` and at least one valid email are required. Phone numbers are stored\nas digits. `status_email` defaults to true and `co_sign_emails` defaults\nto false. The write stays on this referral.\n","deprecated":null,"version":null,"sidebarTitle":"Creates a case manager on a referral","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/case_managers","href":"/api-reference/referrals/creates-a-case-manager-on-a-referral","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createReferralCaseManager","x-mint":{"href":"/api-reference/referrals/creates-a-case-manager-on-a-referral"},"summary":"Creates a case manager on a referral","tags":["Referrals"],"description":"Adds a case manager to a referral that belongs to the authenticated group.\n`name` and at least one valid email are required. Phone numbers are stored\nas digits. `status_email` defaults to true and `co_sign_emails` defaults\nto false. The write stays on this referral.\n","security":["eb50b870-e10d-41d2-9ae1-7879dea044b4"],"parameters":["f896cdee-44c3-4c65-8210-1fd1a97f92a8"],"requestBody":"d8ce7ba1-dfab-41c4-b322-53373f204a71","responses":{"201":"e6d30ac1-f71e-4bf2-bb3d-d0ce6a3645d0","401":"4393bc48-2b72-4f06-990a-509898a9da46","404":"edc1d47a-c786-4cbd-b149-b756dc620da1","422":"d35fb5d7-d37c-4b0a-9ed7-fa0ba799b207","429":"f8df0970-8f74-48b4-855b-12d3cd421d8d","500":"1e063034-ae32-442f-88c1-c75e76afed84"},"method":"post","type":"path","servers":["3c83fb1e-a5b3-4573-aba7-e182758a8454","8bbfc0e5-1d7d-4b96-a37e-dee5a3e09351"],"path":"/api/v2/referrals/{referral_id}/case_managers","baseUrlOptions":["https://api.staging.scan.com","https://api.scan.com"],"title":"Creates a case manager on a referral","codeSamples":[],"requestExampleLanguages":["bash","ruby","python","javascript","php","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.case_manager.name":"\u003cstring>","body.case_manager.emails.items.0":"[email protected]","body.case_manager.phone_numbers.items.0":"\u003cstring>","body.case_manager.status_email":true,"body.case_manager.co_sign_emails":false}]},"dependencies":{"parameters":{"f896cdee-44c3-4c65-8210-1fd1a97f92a8":{"name":"referral_id","in":"path","required":true,"description":"Referral ID","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Referral ID","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["case_manager"],"properties":{"case_manager":{"type":"object","required":["name","emails"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"case_manager.name","typeLabel":"string"},"emails":{"type":"array","minItems":1,"items":{"type":"string","format":"email","uniqueKey":"case_manager.emails.items.[INDEX]","typeLabel":"string\u003cemail>"},"isRequired":true,"uniqueKey":"case_manager.emails","typeLabel":"string\u003cemail>[]"},"phone_numbers":{"type":"array","items":{"type":"string","uniqueKey":"case_manager.phone_numbers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"case_manager.phone_numbers","typeLabel":"string[]"},"status_email":{"type":"boolean","default":true,"uniqueKey":"case_manager.status_email","typeLabel":"boolean"},"co_sign_emails":{"type":"boolean","default":false,"uniqueKey":"case_manager.co_sign_emails","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"case_manager","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"case_manager":{"name":"\u003cstring>","emails":["[email protected]"],"phone_numbers":["\u003cstring>"],"status_email":true,"co_sign_emails":false}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e6d30ac1-f71e-4bf2-bb3d-d0ce6a3645d0":{"description":"Case manager created","content":{"application/json":{"schema":{"type":"object","required":["case_manager"],"properties":{"case_manager":{"type":"object","description":"A case manager contact on a referral","required":["id","name","emails","phone_numbers","status_email","co_sign_emails"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"case_manager.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","example":"Ada Lovelace","isRequired":true,"uniqueKey":"case_manager.name","typeLabel":"string"},"emails":{"type":"array","minItems":1,"items":{"type":"string","format":"email","uniqueKey":"case_manager.emails.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"At least one valid email is required","isRequired":true,"uniqueKey":"case_manager.emails","typeLabel":"string\u003cemail>[]"},"phone_numbers":{"type":"array","items":{"type":"string","uniqueKey":"case_manager.phone_numbers.items.[INDEX]","typeLabel":"string"},"description":"Stored as digits only","example":["6135551234"],"isRequired":true,"uniqueKey":"case_manager.phone_numbers","typeLabel":"string[]"},"status_email":{"type":"boolean","description":"When true, Scan emails this case manager about case status. Defaults to true.","isRequired":true,"uniqueKey":"case_manager.status_email","typeLabel":"boolean"},"co_sign_emails":{"type":"boolean","description":"When true, Scan emails this case manager for co-sign. Defaults to false.","isRequired":true,"uniqueKey":"case_manager.co_sign_emails","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"case_manager","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"case_manager":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"Ada Lovelace","emails":["[email protected]"],"phone_numbers":["6135551234"],"status_email":true,"co_sign_emails":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"4393bc48-2b72-4f06-990a-509898a9da46":{"description":"Missing, expired, or wrong-environment token","headers":{"X-Request-Id":{"description":"Correlate this response with Scan support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","example":"unprocessable_entity","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"documentation_url":{"type":"string","uniqueKey":"documentation_url","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"required":["error","message","type","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"unauthorized":{"title":"unauthorized","value":{"error":"Unauthorized","message":"Unauthorized","type":"authentication_error","code":"unauthorized","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#unauthorized"}},"expired":{"title":"expired","value":{"error":"API token expired","message":"API token expired","type":"authentication_error","code":"api_token_expired","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#api_token_expired"}}},"exampleType":"examples"}},"exampleType":"examples"},"edc1d47a-c786-4cbd-b149-b756dc620da1":{"description":"Resource not found or not accessible to this account","headers":{"X-Request-Id":{"description":"Correlate this response with Scan support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","example":"unprocessable_entity","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"documentation_url":{"type":"string","uniqueKey":"documentation_url","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"required":["error","message","type","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Referral not found","message":"Referral not found","type":"not_found_error","code":"not_found","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#not_found"},"examples":{"Example":{"title":"Example","value":{"error":"Referral not found","message":"Referral not found","type":"not_found_error","code":"not_found","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#not_found"}}},"exampleType":"examples"}},"exampleType":"examples"},"d35fb5d7-d37c-4b0a-9ed7-fa0ba799b207":{"description":"Request body failed validation","headers":{"X-Request-Id":{"description":"Correlate this response with Scan support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","example":"unprocessable_entity","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"documentation_url":{"type":"string","uniqueKey":"documentation_url","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"required":["error","message","type","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Phone is invalid","message":"Phone is invalid","type":"validation_error","code":"unprocessable_entity","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#unprocessable_entity","errors":["Phone is invalid"]},"examples":{"Example":{"title":"Example","value":{"error":"Phone is invalid","message":"Phone is invalid","type":"validation_error","code":"unprocessable_entity","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#unprocessable_entity","errors":["Phone is invalid"]}}},"exampleType":"examples"}},"exampleType":"examples"},"f8df0970-8f74-48b4-855b-12d3cd421d8d":{"description":"Sandbox request allowance exhausted","headers":{"X-Request-Id":{"description":"Correlate this response with Scan support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","example":"unprocessable_entity","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"documentation_url":{"type":"string","uniqueKey":"documentation_url","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"required":["error","message","type","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Sandbox request limit reached","message":"Sandbox request limit reached","type":"rate_limit_error","code":"sandbox_request_limit_reached","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#sandbox_request_limit_reached"},"examples":{"Example":{"title":"Example","value":{"error":"Sandbox request limit reached","message":"Sandbox request limit reached","type":"rate_limit_error","code":"sandbox_request_limit_reached","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#sandbox_request_limit_reached"}}},"exampleType":"examples"}},"exampleType":"examples"},"1e063034-ae32-442f-88c1-c75e76afed84":{"description":"Unexpected internal error","headers":{"X-Request-Id":{"description":"Correlate this response with Scan support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","example":"unprocessable_entity","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"documentation_url":{"type":"string","uniqueKey":"documentation_url","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"required":["error","message","type","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Internal server error","message":"Internal server error","type":"api_error","code":"internal_error","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#internal_error"},"examples":{"Example":{"title":"Example","value":{"error":"Internal server error","message":"Internal server error","type":"api_error","code":"internal_error","request_id":"abc-123","documentation_url":"https://docs.scan.com/guides/errors#internal_error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"eb50b870-e10d-41d2-9ae1-7879dea044b4":{"BearerAuth":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer \u003capi_token>`. Reuse the same token on later requests\nuntil it expires or is revoked. Do not request a new token for each call.\nThe token does not expire after 24 hours. Sandbox tokens come from Get\nAPI keys and allow 2,000 successful requests or 7 days, or 90 days with\nan access code. Failed 4xx/5xx responses do not consume the allowance.\nProduction tokens are issued from the group's API access tab and last\nuntil the expiry set there, or until revoked when no expiry is set.\n","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"3c83fb1e-a5b3-4573-aba7-e182758a8454":{"url":"https://api.staging.scan.com","description":"Sandbox"},"8bbfc0e5-1d7d-4b96-a37e-dee5a3e09351":{"url":"https://api.scan.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"`Authorization: Bearer \u003capi_token>`. Reuse the same token on later requests\nuntil it expires or is revoked. Do not request a new token for each call.\nThe token does not expire after 24 hours. Sandbox tokens come from Get\nAPI keys and allow 2,000 successful requests or 7 days, or 90 days with\nan access code. Failed 4xx/5xx responses do not consume the allowance.\nProduction tokens are issued from the group's API access tab and last\nuntil the expiry set there, or until revoked when no expiry is set.\n","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"`Authorization: Bearer \u003capi_token>`. Reuse the same token on later requests\nuntil it expires or is revoked. Do not request a new token for each call.\nThe token does not expire after 24 hours. Sandbox tokens come from Get\nAPI keys and allow 2,000 successful requests or 7 days, or 90 days with\nan access code. Failed 4xx/5xx responses do not consume the allowance.\nProduction tokens are issued from the group's API access tab and last\nuntil the expiry set there, or until revoked when no expiry is set.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"scan-com","siteName":"Scan.com API Documentation","title":"Creates a case manager on a referral - Scan.com API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T13:34:37.395Z","originalFileLocation":"api-reference/referrals/creates-a-case-manager-on-a-referral.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=\"Adds a case manager to a referral that belongs to the authenticated group. name and at least one valid email are required. Phone numbers are stored as digits. status_email defaults to true and co_sign_emails defaults to false. The write stays on this referral.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scan.com API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_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/scan-com/Nix-sJET0QHUYqhe/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Creates a case manager on a referral - Scan.com API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a case manager to a referral that belongs to the authenticated group. name and at least one valid email are required. Phone numbers are stored as digits. status_email defaults to true and co_sign_emails defaults to false. The write stays on this referral.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scan.com API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scan-com.mintlify.site/_mintlify/api/og/v2?division=Referrals\u0026amp;title=Creates+a+case+manager+on+a+referral\u0026amp;description=Adds+a+case+manager+to+a+referral+that+belongs+to+the+authenticated+group.%0A%60name%60+and+at+least+one+valid+email+are+required.+Phone+numbers+are+stored%0Aas+digits.\u0026amp;theme=9d64d82cf0645d25331e501f\u0026amp;signature=9c67e76b4a1b12792d2b5cbaad0797d44c59b5d92bb94e368042b1c3fd27344f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Creates a case manager on a referral - Scan.com API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a case manager to a referral that belongs to the authenticated group. name and at least one valid email are required. Phone numbers are stored as digits. status_email defaults to true and co_sign_emails defaults to false. The write stays on this referral.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scan-com.mintlify.site/_mintlify/api/og/v2?division=Referrals\u0026amp;title=Creates+a+case+manager+on+a+referral\u0026amp;description=Adds+a+case+manager+to+a+referral+that+belongs+to+the+authenticated+group.%0A%60name%60+and+at+least+one+valid+email+are+required.+Phone+numbers+are+stored%0Aas+digits.\u0026amp;theme=9d64d82cf0645d25331e501f\u0026amp;signature=9c67e76b4a1b12792d2b5cbaad0797d44c59b5d92bb94e368042b1c3fd27344f\">\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/scan-com/Nix-sJET0QHUYqhe/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scan.com API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#003232\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/referrals/creates-a-case-manager-on-a-referral.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://scan.com/#organization\",\"name\":\"Scan.com\",\"url\":\"https://scan.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.scan.com/images/ca8ecc128f60c97d6de1a0d908bab6dbfff58b663f9828b8213265ec5d562cc9-small-scan.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.scan.com#website\",\"name\":\"Scan.com API Documentation\",\"url\":\"https://docs.scan.com\",\"publisher\":{\"@id\":\"https://scan.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral#webpage\",\"url\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral\",\"name\":\"Creates a case manager on a referral\",\"description\":\"Adds a case manager to a referral that belongs to the authenticated group. name and at least one valid email are required. Phone numbers are stored as digits. status_email defaults to true and co_sign_emails defaults to false. The write stays on this referral.\",\"dateModified\":\"2026-11-04T13:34:37.395Z\",\"isPartOf\":{\"@id\":\"https://docs.scan.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Referrals\",\"item\":\"https://docs.scan.com/api-reference/referrals/creates-a-referral\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Creates a case manager on a referral\",\"item\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral#apireference\",\"headline\":\"Creates a case manager on a referral\",\"name\":\"Creates a case manager on a referral\",\"description\":\"Adds a case manager to a referral that belongs to the authenticated group. name and at least one valid email are required. Phone numbers are stored as digits. status_email defaults to true and co_sign_emails defaults to false. The write stays on this referral.\",\"url\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral\",\"mainEntityOfPage\":{\"@id\":\"https://docs.scan.com/api-reference/referrals/creates-a-case-manager-on-a-referral#webpage\"},\"dateModified\":\"2026-11-04T13:34:37.395Z\",\"publisher\":{\"@id\":\"https://scan.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.scan.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Scan.com API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Scan.com API Documentation","nav":{"global":{"anchors":[{"anchor":"Postman collection","icon":"download","href":"/guides/api-tools#postman-collection"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/guides/objects"}]},{"tab":"API reference","groups":[{"group":"Referrals","pages":[{"title":"Creates a referral","deprecated":null,"version":null,"sidebarTitle":"Creates a referral","openapi":"/openapi.yaml post /api/v2/referrals","href":"/api-reference/referrals/creates-a-referral"},{"title":"Returns a list of referrals","deprecated":null,"version":null,"sidebarTitle":"Returns a list of referrals","openapi":"/openapi.yaml get /api/v2/referrals","href":"/api-reference/referrals/returns-a-list-of-referrals"},{"title":"Returns referral status counts","deprecated":null,"version":null,"sidebarTitle":"Returns referral status counts","openapi":"/openapi.yaml get /api/v2/referrals/status_counts","href":"/api-reference/referrals/returns-referral-status-counts"},{"title":"Returns a referral by ID","deprecated":null,"version":null,"sidebarTitle":"Returns a referral by id","openapi":"/openapi.yaml get /api/v2/referrals/{id}","href":"/api-reference/referrals/returns-a-referral-by-id"},{"title":"Updates a referral","deprecated":null,"version":null,"sidebarTitle":"Updates a referral","openapi":"/openapi.yaml patch /api/v2/referrals/{id}","href":"/api-reference/referrals/updates-a-referral"},{"title":"Cancels a referral","deprecated":null,"version":null,"sidebarTitle":"Cancels a referral","openapi":"/openapi.yaml delete /api/v2/referrals/{id}","href":"/api-reference/referrals/cancels-a-referral"},{"title":"Lists referral activities","deprecated":null,"version":null,"sidebarTitle":"Lists referral activities","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/activities","href":"/api-reference/referrals/lists-referral-activities"},{"title":"Lists referral notification delivery history","deprecated":null,"version":null,"sidebarTitle":"Lists referral notification delivery history","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/notifications","href":"/api-reference/referrals/lists-referral-notification-delivery-history"},{"title":"Lists referral payments","deprecated":null,"version":null,"sidebarTitle":"Lists referral payments","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/payments","href":"/api-reference/referrals/lists-referral-payments"},{"title":"Lists referral invoice line items","deprecated":null,"version":null,"sidebarTitle":"Lists referral invoices","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/invoices","href":"/api-reference/referrals/lists-referral-invoices"},{"title":"Uploads a document on a referral","deprecated":null,"version":null,"sidebarTitle":"Uploads a document on a referral","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/documents","href":"/api-reference/referrals/uploads-a-document-on-a-referral"},{"title":"Returns the invoice and PFR on a referral","deprecated":null,"version":null,"sidebarTitle":"Returns the invoice and pfr on a referral","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/documents","href":"/api-reference/referrals/returns-the-invoice-and-pfr-on-a-referral"},{"title":"Lists case managers on a referral","description":"Returns every case manager on a referral that belongs to the authenticated\ngroup, oldest first. Case managers are not included on the referral payload.\n\nA referral another group can see only because it is the billing company\nis not available here.\n","deprecated":null,"version":null,"sidebarTitle":"Lists case managers on a referral","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/case_managers","href":"/api-reference/referrals/lists-case-managers-on-a-referral"},{"title":"Creates a case manager on a referral","deprecated":null,"version":null,"sidebarTitle":"Creates a case manager on a referral","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/case_managers","href":"/api-reference/referrals/creates-a-case-manager-on-a-referral"},{"title":"Updates a case manager on a referral","description":"Replaces the submitted fields on one case manager. Omitted fields stay as\nthey are. The write stays on this referral and does not change a case\nmanager on a sibling referral.\n","deprecated":null,"version":null,"sidebarTitle":"Updates a case manager on a referral","openapi":"/openapi.yaml patch /api/v2/referrals/{referral_id}/case_managers/{id}","href":"/api-reference/referrals/updates-a-case-manager-on-a-referral"},{"title":"Deletes a case manager on a referral","deprecated":null,"version":null,"sidebarTitle":"Deletes a case manager on a referral","openapi":"/openapi.yaml delete /api/v2/referrals/{referral_id}/case_managers/{id}","href":"/api-reference/referrals/deletes-a-case-manager-on-a-referral"},{"title":"Returns medical safety questions","deprecated":null,"version":null,"sidebarTitle":"Returns medical safety questions","openapi":"/openapi.yaml get /api/v2/referrals/{referral_id}/medical_questionnaire","href":"/api-reference/referrals/returns-medical-safety-questions"},{"title":"Submits medical safety answers","deprecated":null,"version":null,"sidebarTitle":"Submits medical safety answers","openapi":"/openapi.yaml put /api/v2/referrals/{referral_id}/medical_questionnaire","href":"/api-reference/referrals/submits-medical-safety-answers"},{"title":"Submits preferred center and availability","deprecated":null,"version":null,"sidebarTitle":"Submits preferred center and availability","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/scheduling_preferences","href":"/api-reference/referrals/submits-preferred-center-and-availability"},{"title":"Requests automatic booking","deprecated":null,"version":null,"sidebarTitle":"Requests automatic booking","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/book","href":"/api-reference/referrals/requests-automatic-booking"},{"title":"Creates an order on a visit","deprecated":null,"version":null,"sidebarTitle":"Creates an order on a visit","openapi":"/openapi.yaml post /api/v2/referrals/{referral_id}/visits/{visit_id}/orders","href":"/api-reference/referrals/creates-an-order-on-a-visit"},{"title":"Updates an order on a visit","deprecated":null,"version":null,"sidebarTitle":"Updates an order on a visit","openapi":"/openapi.yaml patch /api/v2/referrals/{referral_id}/visits/{visit_id}/orders/{id}","href":"/api-reference/referrals/updates-an-order-on-a-visit"},{"title":"Deletes an order on a visit","deprecated":null,"version":null,"sidebarTitle":"Deletes an order on a visit","openapi":"/openapi.yaml delete /api/v2/referrals/{referral_id}/visits/{visit_id}/orders/{id}","href":"/api-reference/referrals/deletes-an-order-on-a-visit"}]},{"group":"Courier SSO","pages":[{"title":"Creates a Courier portal SSO URL","deprecated":null,"version":null,"sidebarTitle":"Creates a courier portal sso url","openapi":"/openapi.yaml post /api/v2/auth/sso","href":"/api-reference/courier-sso/creates-a-courier-portal-sso-url"}]},{"group":"Referral Orders","pages":[{"title":"Submits an order form referral","deprecated":null,"version":null,"sidebarTitle":"Submits an order form referral","openapi":"/openapi.yaml post /api/v2/referral_orders","href":"/api-reference/referral-orders/submits-an-order-form-referral"}]},{"group":"Patients","pages":[{"title":"Creates a patient","deprecated":null,"version":null,"sidebarTitle":"Creates a patient","openapi":"/openapi.yaml post /api/v2/patients","href":"/api-reference/patients/creates-a-patient"},{"title":"Returns a list of patients","deprecated":null,"version":null,"sidebarTitle":"Returns a list of patients","openapi":"/openapi.yaml get /api/v2/patients","href":"/api-reference/patients/returns-a-list-of-patients"},{"title":"Returns a patient by ID","deprecated":null,"version":null,"sidebarTitle":"Returns a patient by id","openapi":"/openapi.yaml get /api/v2/patients/{id}","href":"/api-reference/patients/returns-a-patient-by-id"},{"title":"Updates a patient","deprecated":null,"version":null,"sidebarTitle":"Updates a patient","openapi":"/openapi.yaml patch /api/v2/patients/{id}","href":"/api-reference/patients/updates-a-patient"}]},{"group":"Practices","pages":[{"title":"Creates a practice","deprecated":null,"version":null,"sidebarTitle":"Creates a practice","openapi":"/openapi.yaml post /api/v2/practices","href":"/api-reference/practices/creates-a-practice"},{"title":"Returns a list of practices","deprecated":null,"version":null,"sidebarTitle":"Returns a list of practices","openapi":"/openapi.yaml get /api/v2/practices","href":"/api-reference/practices/returns-a-list-of-practices"},{"title":"Returns users for a practice","deprecated":null,"version":null,"sidebarTitle":"Returns users for a practice","openapi":"/openapi.yaml get /api/v2/practices/{practice_id}/users","href":"/api-reference/practices/returns-users-for-a-practice"},{"title":"Creates a user on a practice","deprecated":null,"version":null,"sidebarTitle":"Creates a user on a practice","openapi":"/openapi.yaml post /api/v2/practices/{practice_id}/users","href":"/api-reference/practices/creates-a-user-on-a-practice"}]},{"group":"Law Firms","pages":[{"title":"Creates a law firm","deprecated":null,"version":null,"sidebarTitle":"Creates a law firm","openapi":"/openapi.yaml post /api/v2/law_firms","href":"/api-reference/law-firms/creates-a-law-firm"},{"title":"Returns a list of law firms","deprecated":null,"version":null,"sidebarTitle":"Returns a list of law firms","openapi":"/openapi.yaml get /api/v2/law_firms","href":"/api-reference/law-firms/returns-a-list-of-law-firms"}]},{"group":"Body Parts","pages":[{"title":"Returns a list of body parts","deprecated":null,"version":null,"sidebarTitle":"Returns a list of body parts","openapi":"/openapi.yaml get /api/v2/body_parts","href":"/api-reference/body-parts/returns-a-list-of-body-parts"}]},{"group":"CPT Codes","pages":[{"title":"Returns CPT code mappings","deprecated":null,"version":null,"sidebarTitle":"Returns cpt code mappings","openapi":"/openapi.yaml get /api/v2/cpt_codes","href":"/api-reference/cpt-codes/returns-cpt-code-mappings"}]},{"group":"ICD-10 Codes","pages":[{"title":"Returns a list of ICD-10 codes","deprecated":null,"version":null,"sidebarTitle":"Returns a list of icd 10 codes","openapi":"/openapi.yaml get /api/v2/icd10_codes","href":"/api-reference/icd-10-codes/returns-a-list-of-icd-10-codes"}]},{"group":"Modalities","pages":[{"title":"Returns a list of modalities","deprecated":null,"version":null,"sidebarTitle":"Returns a list of modalities","openapi":"/openapi.yaml get /api/v2/modalities","href":"/api-reference/modalities/returns-a-list-of-modalities"}]},{"group":"Locations","pages":[{"title":"Returns nearby imaging centers","deprecated":null,"version":null,"sidebarTitle":"Returns nearby imaging centers","openapi":"/openapi.yaml get /api/v2/locations","href":"/api-reference/locations/returns-nearby-imaging-centers"},{"title":"Search imaging centers","deprecated":null,"version":null,"sidebarTitle":"Search imaging centers","openapi":"/openapi.yaml get /api/v2/locations/search","href":"/api-reference/locations/search-imaging-centers"}]},{"group":"Order Documents","pages":[{"title":"Returns report and DICOM for an order","deprecated":null,"version":null,"sidebarTitle":"Returns report and dicom for an order","openapi":"/openapi.yaml get /api/v2/order_documents","href":"/api-reference/order-documents/returns-report-and-dicom-for-an-order"},{"title":"Returns the radiology report PDF for an order","deprecated":null,"version":null,"sidebarTitle":"Returns the radiology report pdf for an order","openapi":"/openapi.yaml get /api/v2/order_documents/report","href":"/api-reference/order-documents/returns-the-radiology-report-pdf-for-an-order"},{"title":"Returns DICOM imaging data for an order","deprecated":null,"version":null,"sidebarTitle":"Returns dicom imaging data for an order","openapi":"/openapi.yaml get /api/v2/order_documents/dicom","href":"/api-reference/order-documents/returns-dicom-imaging-data-for-an-order"},{"title":"Returns the invoice PDF for an order","deprecated":null,"version":null,"sidebarTitle":"Returns the invoice pdf for an order","openapi":"/openapi.yaml get /api/v2/order_documents/invoices","href":"/api-reference/order-documents/returns-the-invoice-pdf-for-an-order"}]},{"group":"Status","pages":[{"title":"Updates the status of a visit","deprecated":null,"version":null,"sidebarTitle":"Updates the status of a visit","openapi":"/openapi.yaml post /api/v2/status","href":"/api-reference/status/updates-the-status-of-a-visit"}]},{"group":"Testing","pages":[{"title":"Bootstrap sandbox fixtures","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v2/testing/fixtures","href":"/api-reference/testing/bootstrap-sandbox-fixtures"},{"title":"Advance a sandbox fixture visit to a chosen status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v2/testing/visits/{visit_id}","href":"/api-reference/testing/advance-a-sandbox-fixture-visit-to-a-chosen-status"},{"title":"Fire a signed test webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v2/testing/events","href":"/api-reference/testing/fire-a-signed-test-webhook"}]},{"group":"FHIR","pages":[{"title":"Read a FHIR R4 DiagnosticReport","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v2/fhir/diagnostic_reports/{id}","href":"/api-reference/fhir/read-a-fhir-r4-diagnosticreport"},{"title":"Read a FHIR R4 ImagingStudy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v2/fhir/imaging_studies/{id}","href":"/api-reference/fhir/read-a-fhir-r4-imagingstudy"}]}]}]},"basePath":"","title":"Creates a case manager on a referral - Scan.com API Documentation","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}