This endpoint requires organization admin privileges. Only users with the org:admin role can update user metadata.
Organization-Scoped Metadata: Metadata set through this endpoint is specific to the user’s membership in your organization. If the same user belongs to multiple organizations, each organization maintains separate metadata.
Update custom metadata for a user within your organization. Perfect for managing user roles, departments, teams, or any custom properties needed for filtering and organization.
Metadata Replacement: This endpoint completely replaces the user’s metadata in your organization. To preserve existing fields, fetch current metadata first and merge your changes before updating.
Metadata is scoped to the organization - each org maintains separate metadata for shared users
Removing a user from the organization deletes their metadata for that org
Re-adding a user creates fresh metadata (previous metadata is not restored)
Metadata can contain any JSON-serializable data (strings, numbers, booleans, objects, arrays)
Cannot update metadata for users in other organizations
Metadata is visible in API responses to all org members
Use this endpoint with Get Organization Users to build powerful user management workflows and custom dashboards.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aster Agents","colors":{"primary":"#0A3D2C","light":"#00DB65","dark":"#0A3D2C"},"logo":{"light":"https://mintcdn.com/asteragents/0Z3Pq736HygxwpDP/logo/light.svg?fit=max\u0026auto=format\u0026n=0Z3Pq736HygxwpDP\u0026q=85\u0026s=43ff25abf648e8e3684687fb287df4a7","dark":"https://mintcdn.com/asteragents/0Z3Pq736HygxwpDP/logo/dark.svg?fit=max\u0026auto=format\u0026n=0Z3Pq736HygxwpDP\u0026q=85\u0026s=3c8b99698119572eb40d6bffd7f3107c"},"favicon":"https://mintcdn.com/asteragents/0Z3Pq736HygxwpDP/favicon.png?fit=max\u0026auto=format\u0026n=0Z3Pq736HygxwpDP\u0026q=85\u0026s=719525076d6a63947582e582f81aea9c","api":{"openapi":["openapi.yaml"],"mdx":{"auth":{"method":"bearer"},"server":"https://www.asteragents.com/api"}},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"mailto:patrick@asteragents.com","label":"Support"}],"primary":{"type":"button","label":"Control Hub","href":"https://www.asteragents.com/control-hub"}},"footer":{"socials":{"x":"https://x.com/aster__ave"}},"fonts":{"heading":{"family":"Cormorant Garamond","weight":500},"body":{"family":"Geist"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Aster Agents Dashboard","icon":"gauge","href":"https://www.asteragents.com/dashboard"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"asteragents","hasAudioNarration":false,"actualSubdomain":"asteragents","customDomains":["docs.asteragents.com"],"gitSource":{"type":"github","owner":"asterlabs-ai","repo":"asteragents","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeaa9e3aa33bd93eb132be0","collectionId":"dd83f0ed-8523-404e-b97c-06455ca24442","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeaa9e3aa33bd93eb132be0"},"entitlements":{},"buildId":"6aeaa9e3aa33bd93eb132be0","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Documentation","count":117},{"language":"default","tag":"Integrations","count":60},{"language":"default","tag":"API Reference","count":48},{"language":"default","tag":"Built-in Tools","count":28},{"language":"default","tag":"Operations \u0026 Commerce","count":13},{"language":"default","tag":"Organization Settings","count":11},{"language":"default","tag":"Web \u0026 Research","count":9},{"language":"default","tag":"Build Agents","count":8},{"language":"default","tag":"Investing \u0026 Research","count":8},{"language":"default","tag":"CRM \u0026 Sales","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"vite-origin","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":"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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/endpoint/update-user-metadata","slug":"/api-reference/endpoint/update-user-metadata","pageMetadata":{"title":"Update User Metadata","description":"Update organization-scoped metadata for a specific user","api":"POST /admin/updateUserMetadata","playground":{"mode":"show","request":{"paramFields":{"expanded":"topLevel"},"example":{"languages":["curl","python","javascript"]}}},"href":"/api-reference/endpoint/update-user-metadata"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update organization-scoped metadata for a specific user\"\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={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,Info,Note,ParamField,ResponseField,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`This endpoint requires organization admin privileges. Only users with the `,_jsx(_components.code,{children:`org:admin`}),` role can update user metadata.`]})}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Organization-Scoped Metadata`}),`: Metadata set through this endpoint is specific to the user’s membership in your organization. If the same user belongs to multiple organizations, each organization maintains separate metadata.`]})}),`\n`,_jsx(_components.p,{children:`Update custom metadata for a user within your organization. Perfect for managing user roles, departments, teams, or any custom properties needed for filtering and organization.`}),`\n`,_jsx(Heading,{level:`3`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[`Bearer token for authentication. Must be from a user with `,_jsx(_components.code,{children:`org:admin`}),` role.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`userId`,type:`string`,required:true,id:`param-user-id`,children:_jsx(_components.p,{children:`Clerk user ID of the user whose metadata should be updated`})}),`\n`,_jsxs(ParamField,{body:`metadata`,type:`object`,required:true,id:`param-metadata`,children:[_jsx(_components.p,{children:`Key-value pairs of metadata to set for the user. This completely replaces existing metadata.`}),_jsx(Expandable,{title:`Common Metadata Fields`,children:_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`role`}),`: User’s role or job title (e.g., “manager”, “developer”)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`department`}),`: Department name (e.g., “engineering”, “marketing”)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`team`}),`: Team assignment (e.g., “backend”, “frontend”)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`level`}),`: Seniority level (e.g., “senior”, “junior”)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`vnum`}),`: Vendor or employee number`]}),`\n`,_jsx(_components.li,{children:`Custom fields: Any key-value pairs relevant to your organization`}),`\n`]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether the metadata update was successful`})}),`\n`,_jsxs(ResponseField,{name:`user`,type:`object`,id:`param-user`,children:[_jsx(_components.p,{children:`Updated user information`}),_jsxs(Expandable,{title:`User Object`,children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`Clerk user ID`})}),_jsx(ResponseField,{name:`email`,type:`string`,id:`param-email`,children:_jsx(_components.p,{children:`User’s email address`})}),_jsx(ResponseField,{name:`firstName`,type:`string`,nullable:true,id:`param-first-name`,children:_jsx(_components.p,{children:`User’s first name`})}),_jsx(ResponseField,{name:`lastName`,type:`string`,nullable:true,id:`param-last-name`,children:_jsx(_components.p,{children:`User’s last name`})}),_jsx(ResponseField,{name:`publicMetadata`,type:`object`,id:`param-public-metadata`,children:_jsx(_components.p,{children:`The updated organization-scoped metadata`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`examples`,children:`Examples`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Basic Update`,numberOfLines:`12`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`curl -X POST https://www.asteragents.com/api/admin/updateUserMetadata \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` -H \"Authorization: Bearer YOUR_TOKEN\" \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` -H \"Content-Type: application/json\" \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` -d '{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"userId\": \"user_2ABC123DEF\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"metadata\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"role\": \"senior-developer\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"department\": \"engineering\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"team\": \"backend\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }'`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(CodeBlock,{filename:``,numberOfLines:`20`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`20`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`url `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://www.asteragents.com/api/admin/updateUserMetadata\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer YOUR_TOKEN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user_2ABC123DEF\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"role\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"manager\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"department\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"engineering\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"level\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"senior\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"vnum\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"EMP-12345\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(url, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`result `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Updated metadata for `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`result[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'user'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`][`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'email'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:``,numberOfLines:`18`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`18`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'https://www.asteragents.com/api/admin/updateUserMetadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'POST'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Bearer YOUR_TOKEN'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'application/json'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` userId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'user_2ABC123DEF'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` metadata:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` role:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'developer'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` department:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'engineering'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` team:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'frontend'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` result`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Updated user:'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`result`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`user`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`email`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Success Response`,numberOfLines:`14`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user_2ABC123DEF\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"john.doe@company.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"firstName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"John\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lastName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Doe\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"publicMetadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"role\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"senior-developer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"department\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"engineering\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"team\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"backend\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsx(ResponseField,{name:`400`,type:`object`,id:`param-400`,children:_jsx(_components.p,{children:`Bad Request - Invalid request data or validation errors`})}),`\n`,_jsx(ResponseField,{name:`401`,type:`object`,id:`param-401`,children:_jsx(_components.p,{children:`Unauthorized - Invalid or missing authentication`})}),`\n`,_jsx(ResponseField,{name:`403`,type:`object`,id:`param-403`,children:_jsx(_components.p,{children:`Forbidden - User is not an admin in the organization, or target user is not a member of the organization`})}),`\n`,_jsx(ResponseField,{name:`405`,type:`object`,id:`param-405`,children:_jsx(_components.p,{children:`Method Not Allowed - Only POST requests are accepted`})}),`\n`,_jsx(ResponseField,{name:`500`,type:`object`,id:`param-500`,children:_jsx(_components.p,{children:`Internal Server Error - Unexpected error occurred`})}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsx(Heading,{level:`3`,id:`department-management`,children:`Department Management`}),`\n`,_jsx(_components.p,{children:`Assign users to departments for organizational filtering:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'/api/admin/updateUserMetadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'POST'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` userId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'user_123'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` metadata:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` department:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'marketing'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` role:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'content-writer'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` team:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'social-media'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`role-based-access-control`,children:`Role-Based Access Control`}),`\n`,_jsx(_components.p,{children:`Set roles that can be used for filtering in the dashboard:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Promote user to manager`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`requests.post(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'/api/admin/updateUserMetadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'userId'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'user_456'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'metadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'role'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'manager'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'department'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'engineering'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'level'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'senior'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'manages_team'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'backend'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`custom-properties`,children:`Custom Properties`}),`\n`,_jsx(_components.p,{children:`Store any custom data relevant to your organization:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`14`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Track contractor information`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'/api/admin/updateUserMetadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'POST'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` userId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'user_789'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` metadata:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` employment_type:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'contractor'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` contract_end_date:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '2024-12-31'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` hourly_rate:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'tier-3'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` vnum:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'CON-9876'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`workflow`,children:`Workflow`}),`\n`,_jsx(Heading,{level:`3`,id:`step-1-get-user-id`,children:`Step 1: Get User ID`}),`\n`,_jsxs(_components.p,{children:[`First, retrieve the user ID from the `,_jsx(_components.a,{href:`/api-reference/endpoint/get-users-in-org`,children:`Get Organization Users`}),` endpoint:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` usersResponse`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'/api/admin/getUsersInOrg'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Bearer '`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` +`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` token`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` users`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` usersResponse`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Find the user you want to update`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` targetUser`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` users`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`find`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`u`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` =>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` u`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`email`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ===`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'john@company.com'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`step-2-update-metadata`,children:`Step 2: Update Metadata`}),`\n`,_jsx(_components.p,{children:`Then update their metadata:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`14`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`14`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'/api/admin/updateUserMetadata'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'POST'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Bearer '`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` +`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` token`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'application/json'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` userId:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` targetUser`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`id`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` metadata:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` role:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'senior-developer'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` department:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'engineering'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`features`,children:`Features`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Organization Isolation`}),`: Complete metadata separation between organizations.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Per-Organization Metadata`}),`: Same user in different orgs has independent metadata`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Complete Replacement`}),`: Metadata object completely replaces existing metadata (not merged)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Real-time Updates`}),`: Changes are immediately reflected in dashboard filters and user listings`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Flexible Schema`}),`: Store any JSON-serializable data structure`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Dashboard Integration`}),`: Use metadata for filtering conversations and statistics`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`important-notes`,children:`Important Notes`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Metadata Replacement`}),`: This endpoint completely replaces the user’s metadata in your organization. To preserve existing fields, fetch current metadata first and merge your changes before updating.`]})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Metadata is scoped to the organization - each org maintains separate metadata for shared users`}),`\n`,_jsx(_components.li,{children:`Removing a user from the organization deletes their metadata for that org`}),`\n`,_jsx(_components.li,{children:`Re-adding a user creates fresh metadata (previous metadata is not restored)`}),`\n`,_jsx(_components.li,{children:`Metadata can contain any JSON-serializable data (strings, numbers, booleans, objects, arrays)`}),`\n`,_jsxs(_components.li,{children:[`Changes are reflected immediately in `,_jsx(_components.a,{href:`/api-reference/endpoint/dashboard-interactions`,children:`dashboard filters`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`security-notes`,children:`Security Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Only organization admins can update user metadata`}),`\n`,_jsx(_components.li,{children:`Target user must be a member of your organization`}),`\n`,_jsx(_components.li,{children:`Cannot update metadata for users in other organizations`}),`\n`,_jsx(_components.li,{children:`Metadata is visible in API responses to all org members`}),`\n`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Use this endpoint with `,_jsx(_components.a,{href:`/api-reference/endpoint/get-users-in-org`,children:`Get Organization Users`}),` to build powerful user management workflows and custom dashboards.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update User Metadata","description":"Update organization-scoped metadata for a specific user","api":"POST /admin/updateUserMetadata","playground":{"mode":"show","request":{"paramFields":{"expanded":"topLevel"},"example":{"languages":["curl","python","javascript"]}}},"href":"/api-reference/endpoint/update-user-metadata"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Examples","slug":"examples","depth":3,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":3,"children":[]},{"title":"Use Cases","slug":"use-cases","depth":2,"children":[{"title":"Department Management","slug":"department-management","depth":3,"children":[]},{"title":"Role-Based Access Control","slug":"role-based-access-control","depth":3,"children":[]},{"title":"Custom Properties","slug":"custom-properties","depth":3,"children":[]}]},{"title":"Workflow","slug":"workflow","depth":2,"children":[{"title":"Step 1: Get User ID","slug":"step-1-get-user-id","depth":3,"children":[]},{"title":"Step 2: Update Metadata","slug":"step-2-update-metadata","depth":3,"children":[]}]},{"title":"Features","slug":"features","depth":2,"children":[]},{"title":"Important Notes","slug":"important-notes","depth":2,"children":[]},{"title":"Security Notes","slug":"security-notes","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Update User Metadata","path":"/admin/updateUserMetadata","servers":[{"url":"https://www.asteragents.com/api"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{"Authorization":{"schema":[{"type":"string","description":"Bearer token for authentication. Must be from a user with `org:admin` role.","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"userId":[{"type":"string","description":"Clerk user ID of the user whose metadata should be updated","required":true}],"metadata":[{"type":"object","properties":{},"description":"Key-value pairs of metadata to set for the user. This completely replaces existing metadata.","required":true}]}}],"examples":{"example":{"value":{"userId":"\u003cstring>","metadata":{}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"400":[{"type":"object","properties":{},"description":"Bad Request - Invalid request data or validation errors"}],"401":[{"type":"object","properties":{},"description":"Unauthorized - Invalid or missing authentication"}],"403":[{"type":"object","properties":{},"description":"Forbidden - User is not an admin in the organization, or target user is not a member of the organization"}],"405":[{"type":"object","properties":{},"description":"Method Not Allowed - Only POST requests are accepted"}],"500":[{"type":"object","properties":{},"description":"Internal Server Error - Unexpected error occurred"}],"success":[{"type":"boolean","description":"Whether the metadata update was successful"}],"user":[{"type":"object","properties":{"id":[{"type":"string","description":"Clerk user ID"}],"email":[{"type":"string","description":"User’s email address"}],"firstName":[{"type":"string","description":"User’s first name"}],"lastName":[{"type":"string","description":"User’s last name"}],"publicMetadata":[{"type":"object","properties":{},"description":"The updated organization-scoped metadata"}]},"description":"Updated user information"}]}}],"examples":{"example":{"value":{"400":{},"401":{},"403":{},"405":{},"500":{},"success":true,"user":{"id":"\u003cstring>","email":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","publicMetadata":{}}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"asteragents","siteName":"Aster Agents","title":"Update User Metadata - Aster Agents","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T02:19:44.163Z","originalFileLocation":"api-reference/endpoint/update-user-metadata.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 organization-scoped metadata for a specific user\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aster Agents\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_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/asteragents/W3pIsOnA8TOqHKUx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update User Metadata - Aster Agents\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update organization-scoped metadata for a specific user\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aster Agents\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.asteragents.com/api-reference/endpoint/update-user-metadata\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://asteragents.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Update+User+Metadata\u0026amp;description=Update+organization-scoped+metadata+for+a+specific+user\u0026amp;theme=4c6772eb85b444c37d4e9cf2\u0026amp;signature=744973fb724633503e6baf72b9b6cee69f2f449de1c88166089dc5a94841c403\">\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 User Metadata - Aster Agents\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update organization-scoped metadata for a specific user\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://asteragents.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Update+User+Metadata\u0026amp;description=Update+organization-scoped+metadata+for+a+specific+user\u0026amp;theme=4c6772eb85b444c37d4e9cf2\u0026amp;signature=744973fb724633503e6baf72b9b6cee69f2f449de1c88166089dc5a94841c403\">\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/asteragents/W3pIsOnA8TOqHKUx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aster Agents\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A3D2C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.asteragents.com/api-reference/endpoint/update-user-metadata\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/update-user-metadata.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aster Agents\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aster Agents","nav":{"global":{"anchors":[{"anchor":"Aster Agents Dashboard","icon":"gauge","href":"https://www.asteragents.com/dashboard"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Welcome to Aster Agents","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Control Hub Overview","href":"/reference/control-hub-overview"}]},{"group":"Build Agents","pages":[{"title":"Build an Agent","href":"/features/build-an-agent"},{"title":"Choosing a Model","href":"/features/choosing-a-model"},{"title":"Agent Prompt Guide","href":"/promptguide"},{"title":"Agent Skills","href":"/features/skills"},{"title":"Knowledge Bases","href":"/features/knowledge-bases"},{"title":"Data Stores","href":"/features/data-stores"},{"title":"Extraction Schemas","href":"/features/extraction-schemas"},{"title":"Multi-Agent Workflows","href":"/features/multi-agent-workflows"}]},{"group":"Run \u0026 Share","pages":[{"title":"Scheduled Tasks","href":"/features/scheduled-tasks"},{"title":"Email Your Agent","href":"/features/email-your-agent"},{"title":"Apps","href":"/features/apps"},{"title":"Collapsible Log Blocks","href":"/features/log-blocks"},{"title":"Aster MCP Server","href":"/features/mcp-server"},{"title":"Exporting Your Agents","href":"/features/exporting-your-agents"}]},{"group":"Built-in Tools","pages":[{"group":"Files \u0026 Knowledge","pages":[{"title":"Read File Tool","href":"/tools/read_file"},{"title":"Search Knowledge Base","href":"/tools/search_knowledge_base"},{"title":"Write to Knowledge Base","href":"/tools/write_to_knowledge_base"},{"title":"Skills","href":"/tools/skills"}]},{"group":"Data Stores","pages":[{"title":"Query Data Store","href":"/tools/query_data_store"},{"title":"Write Data Store","href":"/tools/write_data_store"},{"title":"Manage Data Store","href":"/tools/manage_data_store"}]},{"group":"Code \u0026 APIs","pages":[{"title":"Run Code Tool","href":"/tools/execute_python"},{"title":"Call API Tool","href":"/tools/call_api"}]},{"group":"Web \u0026 Research","pages":[{"title":"Search Google Tool","href":"/tools/search_google"},{"title":"Ask Web Tool","href":"/tools/ask_web"},{"title":"Scrape URL Tool","href":"/tools/scrape_url"},{"title":"Browser Use Tool","href":"/tools/browser_use"},{"title":"Search Google Maps Tool","href":"/tools/search_google_maps"},{"title":"Get Business Reviews Tool","href":"/tools/get_business_reviews"},{"title":"Search Reddit Tool","href":"/tools/search_reddit"},{"title":"Read Subreddit Tool","href":"/tools/read_subreddit"},{"title":"Search TikTok Tool","href":"/tools/search_tiktok"}]},{"group":"Agents \u0026 Automation","pages":[{"title":"Call Agent Tool","href":"/tools/call_agent"},{"title":"Ask User Question Tool","href":"/tools/ask_user_question"},{"title":"Get Conversations Tool","href":"/tools/get_conversations"},{"title":"Manage Agents Tool","href":"/tools/manage_agents"},{"title":"Manage Apps Tool","href":"/tools/manage_apps"},{"title":"Manage Scheduled Tasks Tool","href":"/tools/manage_scheduled_tasks"}]},{"group":"Email \u0026 Audio","pages":[{"title":"Send Email Tool","href":"/tools/send_email"},{"title":"Verify Emails Tool","href":"/tools/verify_emails"},{"title":"ElevenLabs Text to Speech","href":"/tools/elevenlabs_text_to_speech"},{"title":"ElevenLabs Speech to Text","href":"/tools/elevenlabs_speech_to_text"}]}]},{"group":"Integrations","pages":[{"title":"LLM Providers","href":"/integrations/providers"},{"title":"MCP Servers","href":"/integrations/mcp-servers"},{"group":"CRM \u0026 Sales","pages":[{"title":"DealCloud","href":"/integrations/dealcloud"},{"title":"HubSpot","href":"/integrations/hubspot"},{"title":"Instantly (Cold Email)","href":"/integrations/instantly"},{"title":"Maximizer CRM","href":"/integrations/maximizer"},{"title":"Salesforce","href":"/integrations/salesforce"},{"group":"Salesloft","root":{"title":"Salesloft","href":"/integrations/salesloft"},"pages":[{"title":"Salesloft Query","href":"/tools/salesloft_query"},{"title":"Salesloft Manage","href":"/tools/salesloft_manage"},{"title":"Call Salesloft API","href":"/tools/salesloft_api_call"}]}]},{"group":"Prospecting \u0026 Enrichment","pages":[{"group":"Apollo.io","root":{"title":"Apollo.io","href":"/integrations/apollo"},"pages":[{"title":"Apollo Prospect Tool","href":"/tools/apollo_prospect"},{"title":"Apollo Enrich Tool","href":"/tools/apollo_enrich"}]},{"group":"Lusha","root":{"title":"Lusha","href":"/integrations/lusha"},"pages":[{"title":"Lusha Prospect Tool","href":"/tools/lusha_prospect"},{"title":"Lusha Enrich Tool","href":"/tools/lusha_enrich"}]},{"group":"People Data Labs","root":{"title":"People Data Labs","href":"/integrations/peopledatalabs"},"pages":[{"title":"People Data Labs Enrich Tool","href":"/tools/pdl_enrich"}]},{"title":"Shovels","href":"/integrations/shovels"}]},{"group":"Databases \u0026 Warehouses","pages":[{"group":"Airtable","root":{"title":"Airtable","href":"/integrations/airtable"},"pages":[{"title":"Get Airtable Schema Tool","href":"/tools/airtable_get_schema"},{"title":"Search Airtable Tool","href":"/tools/airtable_search"},{"title":"Manage Airtable Records Tool","href":"/tools/airtable_manage_records"}]},{"group":"Pinecone","root":{"title":"Pinecone","href":"/integrations/pinecone"},"pages":[{"title":"Query Pinecone Tool","href":"/tools/query_pinecone"}]},{"group":"Postgres","root":{"title":"Postgres","href":"/integrations/postgres"},"pages":[{"title":"Postgres SQL Tool","href":"/tools/postgres_sql"}]},{"group":"Snowflake","root":{"title":"Snowflake","href":"/integrations/snowflake"},"pages":[{"title":"Snowflake SQL Tool","href":"/tools/snowflake_sql"}]},{"title":"SQL Server","href":"/integrations/sql-server"}]},{"group":"Files \u0026 Documents","pages":[{"title":"Box","href":"/integrations/box"},{"title":"Dropbox","href":"/integrations/dropbox"},{"title":"Egnyte","href":"/integrations/egnyte"},{"group":"Google Drive \u0026 Sheets","root":{"title":"Google Drive and Sheets","href":"/integrations/google-drive"},"pages":[{"title":"Google Sheets Tools","href":"/tools/google_sheets"}]},{"title":"Microsoft OneDrive","href":"/integrations/microsoft-onedrive"},{"title":"Microsoft SharePoint","href":"/integrations/microsoft-sharepoint"}]},{"group":"Email \u0026 Voice","pages":[{"title":"Gmail","href":"/integrations/gmail"},{"title":"Microsoft Outlook","href":"/integrations/microsoft-outlook"},{"title":"Resend","href":"/integrations/resend"},{"title":"Retell AI (Voice \u0026 Chat Agents)","href":"/integrations/retell"}]},{"group":"Finance, Accounting \u0026 HR","pages":[{"title":"Expensify","href":"/integrations/expensify"},{"title":"NetSuite","href":"/integrations/netsuite"},{"title":"Paycom","href":"/integrations/paycom"},{"title":"QuickBooks Online","href":"/integrations/quickbooks"},{"title":"QuickBooks Time","href":"/integrations/quickbooks-time"},{"title":"Sage Intacct","href":"/integrations/sage-intacct"}]},{"group":"Operations \u0026 Commerce","pages":[{"title":"Asana","href":"/integrations/asana"},{"title":"Aspire (Landscape FSM)","href":"/integrations/aspire"},{"title":"Axus Travel App","href":"/integrations/axus"},{"title":"Samsara","href":"/integrations/samsara"},{"group":"Odoo","root":{"title":"Odoo","href":"/integrations/odoo"},"pages":[{"title":"Odoo Get Schema","href":"/tools/odoo_get_schema"},{"title":"Odoo Query","href":"/tools/odoo_query"},{"title":"Odoo Get Records","href":"/tools/odoo_get_records"},{"title":"Odoo Manage Records","href":"/tools/odoo_manage_records"}]},{"group":"ShipHero","root":{"title":"ShipHero","href":"/integrations/shiphero"},"pages":[{"title":"ShipHero Get Schema","href":"/tools/shiphero_get_schema"},{"title":"ShipHero Query","href":"/tools/shiphero_query"},{"title":"ShipHero Generate Snapshot","href":"/tools/shiphero_generate_snapshot"}]},{"group":"Shopify","root":{"title":"Shopify","href":"/integrations/shopify"},"pages":[{"title":"Shopify Get Schema","href":"/tools/shopify_get_schema"},{"title":"Shopify Query","href":"/tools/shopify_query"}]}]},{"group":"Investing \u0026 Research","pages":[{"title":"AlphaSense","href":"/integrations/alphasense"},{"title":"Cobalt (Portfolio Monitoring)","href":"/integrations/cobalt"},{"title":"Google Ads","href":"/integrations/google-ads"},{"title":"Meta Ads","href":"/integrations/meta-ads"},{"title":"Google Analytics 4","href":"/integrations/google-analytics"},{"title":"Google Search Console","href":"/integrations/google-search-console"},{"title":"LegiScan","href":"/integrations/legiscan"},{"title":"Lumonic","href":"/integrations/lumonic"}]}]},{"group":"Organization Settings","pages":[{"title":"Roles \u0026 Permissions","href":"/settings/roles-permissions"},{"title":"Aster","href":"/settings/aster"},{"title":"Public App Links","href":"/settings/public-app-links"},{"title":"Secrets","href":"/settings/secrets"},{"title":"Browser logins","href":"/settings/browser-logins"},{"title":"Spend Caps","href":"/settings/spend-caps"},{"title":"Linked Organizations","href":"/settings/linked-organizations"},{"title":"Custom Domain","href":"/settings/custom-domain"},{"title":"Sidebar","href":"/settings/sidebar"},{"title":"Feedback Message","href":"/settings/feedback-message"},{"title":"Security \u0026 Compliance","href":"/security"}]},{"group":"Resources","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Aster Agents API","href":"/api-reference/introduction"},{"title":"Build with Claude Code","href":"/api-reference/build-on-aster"}]},{"group":"Admin API","pages":[{"title":"List organization users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /admin/users","href":"/api-reference/users/list-organization-users"},{"title":"Remove users from organization","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /admin/users","href":"/api-reference/users/remove-users-from-organization"},{"title":"List organization invitations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /admin/invitations","href":"/api-reference/invitations/list-organization-invitations"},{"title":"Create bulk invitations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /admin/invitations","href":"/api-reference/invitations/create-bulk-invitations"},{"title":"Revoke invitations","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /admin/invitations","href":"/api-reference/invitations/revoke-invitations"},{"title":"Update user metadata","deprecated":null,"version":null,"openapi":"/openapi.yaml post /admin/updateUserMetadata","href":"/api-reference/users/update-user-metadata"}]},{"group":"Files API","pages":[{"title":"Get presigned upload URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /upload/presigned","href":"/api-reference/files/get-presigned-upload-url"}]},{"group":"Agents API","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create or update an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents","href":"/api-reference/agents/create-or-update-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents","href":"/api-reference/agents/delete-an-agent"},{"title":"Sync agent tool schemas","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/sync-tools","href":"/api-reference/agents/sync-agent-tool-schemas"},{"title":"List an agent's config version history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/versions","href":"/api-reference/agents/list-an-agents-config-version-history"},{"title":"Roll back to a version, or save a labeled checkpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/versions","href":"/api-reference/agents/roll-back-to-a-version-or-save-a-labeled-checkpoint"}]},{"group":"Tools API","pages":[{"title":"List available tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tools","href":"/api-reference/tools/list-available-tools"}]},{"group":"Agent Tags API","pages":[{"title":"List agent tags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agent-tags","href":"/api-reference/agent-tags/list-agent-tags"},{"title":"Create an agent tag","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agent-tags","href":"/api-reference/agent-tags/create-an-agent-tag"}]},{"group":"Knowledge Bases API","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.yaml get /kb/manage","href":"/api-reference/knowledge-base-management/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /kb/manage","href":"/api-reference/knowledge-base-management/create-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml put /kb/manage","href":"/api-reference/knowledge-base-management/update-a-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /kb/manage","href":"/api-reference/knowledge-base-management/delete-a-knowledge-base"},{"title":"Associate file with knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml post /kb/files","href":"/api-reference/knowledge-bases/associate-file-with-knowledge-base"},{"title":"List files in a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml get /kb/files","href":"/api-reference/knowledge-bases/list-files-in-a-knowledge-base"},{"title":"Delete a file from a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /kb/files","href":"/api-reference/knowledge-bases/delete-a-file-from-a-knowledge-base"}]},{"group":"Skills API","pages":[{"title":"List skills or get a single skill","deprecated":null,"version":null,"openapi":"/openapi.yaml get /skills/manage","href":"/api-reference/skills/list-skills-or-get-a-single-skill"},{"title":"Create a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /skills/manage","href":"/api-reference/skills/create-a-skill"},{"title":"Update a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml put /skills/manage","href":"/api-reference/skills/update-a-skill"},{"title":"Delete a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /skills/manage","href":"/api-reference/skills/delete-a-skill"},{"title":"List files for a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml get /skills/files","href":"/api-reference/skill-files/list-files-for-a-skill"},{"title":"Upload a bundled file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /skills/files","href":"/api-reference/skill-files/upload-a-bundled-file"},{"title":"Delete a bundled file","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /skills/files","href":"/api-reference/skill-files/delete-a-bundled-file"}]},{"group":"Conversations API","pages":[{"title":"Invoke an agent (start or continue a conversation)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat","href":"/api-reference/conversations/invoke-an-agent-start-or-continue-a-conversation"},{"title":"Get a conversation with messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /getConversation","href":"/api-reference/conversations/get-a-conversation-with-messages"}]},{"group":"Scheduled Tasks API","pages":[{"title":"List scheduled tasks (or get one)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scheduled-tasks/manage","href":"/api-reference/scheduled-tasks/list-scheduled-tasks-or-get-one"},{"title":"Create a scheduled task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /scheduled-tasks/manage","href":"/api-reference/scheduled-tasks/create-a-scheduled-task"},{"title":"Update a scheduled task","deprecated":null,"version":null,"openapi":"/openapi.yaml put /scheduled-tasks/manage","href":"/api-reference/scheduled-tasks/update-a-scheduled-task"},{"title":"Delete a scheduled task","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /scheduled-tasks/manage","href":"/api-reference/scheduled-tasks/delete-a-scheduled-task"},{"title":"Enable or disable a scheduled task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /scheduled-tasks/toggle","href":"/api-reference/scheduled-tasks/enable-or-disable-a-scheduled-task"},{"title":"List task execution history (or stats)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /scheduled-tasks/executions","href":"/api-reference/scheduled-tasks/list-task-execution-history-or-stats"}]},{"group":"Organization Settings API","pages":[{"title":"Get organization settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orgSettings","href":"/api-reference/organization-settings/get-organization-settings"},{"title":"Update organization settings","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orgSettings","href":"/api-reference/organization-settings/update-organization-settings"}]},{"group":"Other Endpoints","pages":[{"title":"Chat with an AI Agent","api":"POST /chat","playground":{"mode":"show","request":{"paramFields":{"expanded":"topLevel"},"example":{"languages":["curl","python","javascript","php"]}}},"href":"/api-reference/endpoint/chat"},{"title":"Get Dashboard Stats","api":"GET /dashboard/getStats","href":"/api-reference/endpoint/dashboard-stats"},{"title":"Get Dashboard Interactions","api":"GET /dashboard/getInteractions","href":"/api-reference/endpoint/dashboard-interactions"}]},{"group":"Legacy Endpoints (Deprecated)","pages":[{"title":"Bulk User Invitation","api":"POST /admin/bulkInvite","playground":{"mode":"show","request":{"paramFields":{"expanded":"topLevel"},"example":{"languages":["curl","python","javascript"]}}},"href":"/api-reference/endpoint/bulk-invite"},{"title":"Bulk User Removal","api":"POST /admin/bulkRemove","deprecated":true,"playground":{"mode":"show","request":{"paramFields":{"expanded":"topLevel"},"example":{"languages":["curl","python","javascript"]}}},"href":"/api-reference/endpoint/bulk-remove"},{"title":"Get Organization Users","api":"GET /admin/getUsersInOrg","deprecated":true,"href":"/api-reference/endpoint/get-users-in-org"}]}]}]},"basePath":"","title":"Update User Metadata - Aster Agents","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js"]}