Renames a user group, or adds and removes members. A new name must not be used by another user group. Users are identified by the id returned by the list users endpoint.
All user identifiers are checked first: if one is not found, nothing is changed.
Guests cannot be in user groups and are skipped.
Removing a user who is not in the group does nothing.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Claap API","description":"Claap API documentation","colors":{"primary":"#FF5A81","light":"#FF5A81","dark":"#FF5A81"},"logo":{"light":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda","dark":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda"},"favicon":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/favicon.ico?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=5364cc1bba934c12994999c57de9f134","navbar":{"links":[{"href":"https://help.claap.io","label":"Claap Help Center"},{"href":"mailto:support@claap.io","label":"Support"},{"href":"https://www.claap.io/contact","label":"Book a demo"}]},"footer":{"socials":{"website":"https://claap.io","linkedin":"https://www.linkedin.com/company/claap-io","slack":"https://join.slack.com/t/firstclaapers/shared_invite/zt-qtel9fc0-sSyLA9M2higrtd4nwF6Hcw","x":"https://twitter.com/claap_io","youtube":"https://www.youtube.com/@claap_io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"claap","hasAudioNarration":false,"actualSubdomain":"claap","customDomains":["docs.claap.io"],"gitSource":{"type":"github","owner":"claap-app","repo":"api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6adb0e66ee97d2ce49edde83","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API reference","count":96},{"language":"default","tag":"Recording","count":22},{"language":"default","tag":"Deal","count":21},{"language":"default","tag":"Company","count":14},{"language":"default","tag":"Contact","count":11},{"language":"default","tag":"Getting started","count":8},{"language":"default","tag":"Admin automation","count":5},{"language":"default","tag":"Folder","count":4},{"language":"default","tag":"Invite","count":4},{"language":"default","tag":"User group","count":4}]},"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/patch_user_group","slug":"/api-reference/endpoint/patch_user_group","pageMetadata":{"title":"Update user group","openapi":"PATCH /v1/user-groups/{userGroupId}","description":"Rename a user group, or add and remove members. At least one of \"name\", \"addUserIds\" or \"removeUserIds\" must be provided.","href":"/api-reference/endpoint/patch_user_group"},"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: \"Rename a user group, or add and remove members. At least one of “name”, “addUserIds” or “removeUserIds” must be provided.\"\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`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Renames a user group, or adds and removes members. A new name must not be used by another user group. Users are identified by the `,_jsx(_components.code,{children:`id`}),` returned by the `,_jsx(_components.a,{href:`/api-reference/endpoint/list_users`,children:`list users`}),` endpoint.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`All user identifiers are checked first: if one is not found, nothing is changed.`}),`\n`,_jsx(_components.li,{children:`Guests cannot be in user groups and are skipped.`}),`\n`,_jsx(_components.li,{children:`Removing a user who is not in the group does nothing.`}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update user group","openapi":"PATCH /v1/user-groups/{userGroupId}","description":"Rename a user group, or add and remove members. At least one of \"name\", \"addUserIds\" or \"removeUserIds\" must be provided.","href":"/api-reference/endpoint/patch_user_group"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"200":"b7dba1ff-79e9-42b0-8ca5-a1ea681e361b","400":"ce9146b5-f04b-4de7-9150-c267d2d41991","404":"1fd4dccc-1c29-45a2-83fd-dec0bdbe843a"},"operationId":"patchV1UserGroupsByUserGroupId","parameters":["a7e14ff6-2f0c-46b2-ae3b-bfe40ca38916"],"description":"Rename a user group, or add and remove members. At least one of \"name\", \"addUserIds\" or \"removeUserIds\" must be provided.","requestBody":"89832ba8-1ea4-4733-9285-4c77a66fa873","method":"patch","type":"path","servers":["8ee810c4-540f-441a-9f25-6055c9139c4c"],"security":["9666b11d-87f1-4fa8-8ecb-a775921bac48"],"path":"/v1/user-groups/{userGroupId}","baseUrlOptions":["https://api.claap.io/"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a7e14ff6-2f0c-46b2-ae3b-bfe40ca38916":{"in":"path","name":"userGroupId","schema":{"type":"string","description":"User group identifier","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"New user group name. It must not be used by another user group of the workspace.","uniqueKey":"name","typeLabel":"string"},"addUserIds":{"type":"array","items":{"type":"string","uniqueKey":"addUserIds.items.[INDEX]","typeLabel":"string"},"maxItems":50,"description":"Identifiers of the users to add to the group. Guests cannot be in groups and are skipped.","uniqueKey":"addUserIds","typeLabel":"string[]"},"removeUserIds":{"type":"array","items":{"type":"string","uniqueKey":"removeUserIds.items.[INDEX]","typeLabel":"string"},"maxItems":50,"description":"Identifiers of the users to remove from the group.","uniqueKey":"removeUserIds","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","addUserIds":["\u003cstring>"],"removeUserIds":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b7dba1ff-79e9-42b0-8ca5-a1ea681e361b":{"description":"User group was successfully updated","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"userGroup":{"type":"object","properties":{"userGroupId":{"type":"string","description":"User group identifier.","isRequired":true,"uniqueKey":"result.userGroup.userGroupId","typeLabel":"string"},"name":{"type":"string","description":"User group name.","isRequired":true,"uniqueKey":"result.userGroup.name","typeLabel":"string"},"memberUserIds":{"type":"array","items":{"type":"string","uniqueKey":"result.userGroup.memberUserIds.items.[INDEX]","typeLabel":"string"},"description":"Identifiers of the workspace users in the group.","isRequired":true,"uniqueKey":"result.userGroup.memberUserIds","typeLabel":"string[]"}},"required":["userGroupId","name","memberUserIds"],"isRequired":true,"uniqueKey":"result.userGroup","typeLabel":"object"}},"required":["userGroup"],"isRequired":true,"uniqueKey":"result","typeLabel":"object"}},"required":["result"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"result":{"userGroup":{"userGroupId":"\u003cstring>","name":"\u003cstring>","memberUserIds":["\u003cstring>"]}}}}},"exampleType":"generated"}},"exampleType":"generated"},"ce9146b5-f04b-4de7-9150-c267d2d41991":{"description":"The request is not valid. For instance nothing to update is provided, the name is longer than 100 characters or already used by another user group, more than 50 user identifiers are provided in \"addUserIds\" or \"removeUserIds\", or a user was not found. In that case the user group is left unchanged.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1fd4dccc-1c29-45a2-83fd-dec0bdbe843a":{"description":"User group was not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9666b11d-87f1-4fa8-8ecb-a775921bac48":{"ApiKey":{"type":"apiKey","in":"header","name":"X-Claap-Key","scopes":[],"schemeName":"ApiKey"}}},"servers":{"8ee810c4-540f-441a-9f25-6055c9139c4c":{"url":"https://api.claap.io/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Claap-Key","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-Claap-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-Claap-Key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"claap","siteName":"Claap API","title":"Update user group - Claap API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-24T07:11:54.619Z","originalFileLocation":"api-reference/endpoint/patch_user_group.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=\"Rename a user group, or add and remove members. At least one of \u0026quot;name\u0026quot;, \u0026quot;addUserIds\u0026quot; or \u0026quot;removeUserIds\u0026quot; must be provided.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Claap API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update user group - Claap API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Rename a user group, or add and remove members. At least one of \u0026quot;name\u0026quot;, \u0026quot;addUserIds\u0026quot; or \u0026quot;removeUserIds\u0026quot; must be provided.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Claap API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.claap.io/api-reference/endpoint/patch_user_group\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://claap.mintlify.site/_mintlify/api/og/v2?division=User+group\u0026amp;title=Update+user+group\u0026amp;description=Rename+a+user+group%2C+or+add+and+remove+members.+At+least+one+of+%22name%22%2C+%22addUserIds%22+or+%22removeUserIds%22+must+be+provided.\u0026amp;theme=6c082972569f3677fca0ebe9\u0026amp;signature=e95ed9f71c0e8cbb68f7e108b5ec5fd03adcc57eac42c68811867cd832dffb31\">\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 group - Claap API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Rename a user group, or add and remove members. At least one of \u0026quot;name\u0026quot;, \u0026quot;addUserIds\u0026quot; or \u0026quot;removeUserIds\u0026quot; must be provided.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://claap.mintlify.site/_mintlify/api/og/v2?division=User+group\u0026amp;title=Update+user+group\u0026amp;description=Rename+a+user+group%2C+or+add+and+remove+members.+At+least+one+of+%22name%22%2C+%22addUserIds%22+or+%22removeUserIds%22+must+be+provided.\u0026amp;theme=6c082972569f3677fca0ebe9\u0026amp;signature=e95ed9f71c0e8cbb68f7e108b5ec5fd03adcc57eac42c68811867cd832dffb31\">\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/claap/gczWElg9AVgfGA_0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Claap API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5A81\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.claap.io/api-reference/endpoint/patch_user_group\">\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/patch_user_group.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.claap.io/#organization\",\"name\":\"Claap API\",\"url\":\"https://docs.claap.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.claap.io#website\",\"name\":\"Claap API\",\"url\":\"https://docs.claap.io\",\"publisher\":{\"@id\":\"https://docs.claap.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group#webpage\",\"url\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group\",\"name\":\"Update user group\",\"description\":\"Rename a user group, or add and remove members. At least one of \\\"name\\\", \\\"addUserIds\\\" or \\\"removeUserIds\\\" must be provided.\",\"dateModified\":\"2026-09-24T07:11:54.619Z\",\"isPartOf\":{\"@id\":\"https://docs.claap.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"User group\",\"item\":\"https://docs.claap.io/api-reference/endpoint/list_user_groups\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update user group\",\"item\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group#apireference\",\"headline\":\"Update user group\",\"name\":\"Update user group\",\"description\":\"Rename a user group, or add and remove members. At least one of \\\"name\\\", \\\"addUserIds\\\" or \\\"removeUserIds\\\" must be provided.\",\"url\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group\",\"mainEntityOfPage\":{\"@id\":\"https://docs.claap.io/api-reference/endpoint/patch_user_group#webpage\"},\"dateModified\":\"2026-09-24T07:11:54.619Z\",\"publisher\":{\"@id\":\"https://docs.claap.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.claap.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Claap API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Claap API","nav":{"global":null,"tabs":[{"tab":"API reference","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Responses \u0026 Errors","href":"/api-reference/errors"},{"title":"Quotas and Limits","href":"/api-reference/rate_limiting"},{"title":"Recordings Visibility","href":"/api-reference/recordings"},{"title":"Views","href":"/api-reference/views"},{"title":"AI fields","href":"/api-reference/ai_fields"},{"title":"Admin automations","href":"/api-reference/automations"}]},{"group":"Recording","pages":[{"title":"List recordings","openapi":"GET /v1/recordings","href":"/api-reference/endpoint/list_recordings"},{"title":"Get recording details","openapi":"GET /v1/recordings/{recordingId}","href":"/api-reference/endpoint/get_recording"},{"title":"Get recording transcript","openapi":"GET /v1/recordings/{recordingId}/transcript","href":"/api-reference/endpoint/get_recording_transcript"},{"title":"Create recording","openapi":"POST /v1/recordings","href":"/api-reference/endpoint/post_recording"},{"title":"Delete recording","openapi":"DELETE /v1/recordings/{recordingId}","href":"/api-reference/endpoint/delete_recording"},{"title":"List recording views","openapi":"GET /v1/recordings/views","href":"/api-reference/endpoint/list_recording_views"},{"title":"Get recording view details","openapi":"GET /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/get_recording_view"},{"title":"Create recording view","openapi":"POST /v1/recordings/views","href":"/api-reference/endpoint/post_recording_view"},{"title":"Update recording view","openapi":"PATCH /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/patch_recording_view"},{"title":"Delete recording view","openapi":"DELETE /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/delete_recording_view"},{"title":"List pinned recording views","openapi":"GET /v1/recordings/views/pinned","href":"/api-reference/endpoint/list_pinned_recording_views"},{"title":"Update pinned recording views","openapi":"PUT /v1/recordings/views/pinned","href":"/api-reference/endpoint/put_pinned_recording_views"},{"title":"List recording AI fields","openapi":"GET /v1/recordings/fields","href":"/api-reference/endpoint/list_recording_ai_fields"},{"title":"Get recording AI field","openapi":"GET /v1/recordings/fields/{fieldId}","href":"/api-reference/endpoint/get_recording_ai_field"},{"title":"Create recording AI field","openapi":"POST /v1/recordings/fields","href":"/api-reference/endpoint/post_recording_ai_field"},{"title":"Update recording AI field","openapi":"PUT /v1/recordings/fields/{fieldId}","href":"/api-reference/endpoint/put_recording_ai_field"},{"title":"Archive recording AI field","openapi":"POST /v1/recordings/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_recording_ai_field"},{"title":"Generate recording AI field","openapi":"POST /v1/recordings/fields/{fieldId}/generations","href":"/api-reference/endpoint/generate_recording_ai_field"},{"title":"Get recording AI field generation","openapi":"GET /v1/recordings/fields/generations/{generationId}","href":"/api-reference/endpoint/get_recording_ai_field_generation"},{"title":"Cancel recording AI field generation","openapi":"POST /v1/recordings/fields/generations/{generationId}/cancel","href":"/api-reference/endpoint/cancel_recording_ai_field_generation"}]},{"group":"Deal","pages":[{"title":"List deals","openapi":"GET /v1/deals","href":"/api-reference/endpoint/list_deals"},{"title":"Get deal details","openapi":"GET /v1/deals/{dealId}","href":"/api-reference/endpoint/get_deal"},{"title":"Update deal","openapi":"PATCH /v1/deals/{dealId}","href":"/api-reference/endpoint/patch_deal"},{"title":"List deal stages","openapi":"GET /v1/deals/stages","href":"/api-reference/endpoint/list_deal_stages"},{"title":"List deal types","openapi":"GET /v1/deals/types","href":"/api-reference/endpoint/list_deal_types"},{"title":"List deal owners","openapi":"GET /v1/deals/owners","href":"/api-reference/endpoint/list_deal_owners"},{"title":"List deal views","openapi":"GET /v1/deals/views","href":"/api-reference/endpoint/list_deal_views"},{"title":"Get deal view details","openapi":"GET /v1/deals/views/{viewId}","href":"/api-reference/endpoint/get_deal_view"},{"title":"Create deal view","openapi":"POST /v1/deals/views","href":"/api-reference/endpoint/post_deal_view"},{"title":"Update deal view","openapi":"PATCH /v1/deals/views/{viewId}","href":"/api-reference/endpoint/patch_deal_view"},{"title":"Delete deal view","openapi":"DELETE /v1/deals/views/{viewId}","href":"/api-reference/endpoint/delete_deal_view"},{"title":"List pinned deal views","openapi":"GET /v1/deals/views/pinned","href":"/api-reference/endpoint/list_pinned_deal_views"},{"title":"Update pinned deal views","openapi":"PUT /v1/deals/views/pinned","href":"/api-reference/endpoint/put_pinned_deal_views"},{"title":"List deal AI fields","openapi":"GET /v1/deals/fields","href":"/api-reference/endpoint/list_deal_ai_fields"},{"title":"Get deal AI field","openapi":"GET /v1/deals/fields/{fieldId}","href":"/api-reference/endpoint/get_deal_ai_field"},{"title":"Create deal AI field","openapi":"POST /v1/deals/fields","href":"/api-reference/endpoint/post_deal_ai_field"},{"title":"Update deal AI field","openapi":"PUT /v1/deals/fields/{fieldId}","href":"/api-reference/endpoint/put_deal_ai_field"},{"title":"Archive deal AI field","openapi":"POST /v1/deals/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_deal_ai_field"},{"title":"Generate deal AI field","openapi":"POST /v1/deals/fields/{fieldId}/generations","href":"/api-reference/endpoint/generate_deal_ai_field"},{"title":"Get deal AI field generation","openapi":"GET /v1/deals/fields/generations/{generationId}","href":"/api-reference/endpoint/get_deal_ai_field_generation"},{"title":"Cancel deal AI field generation","openapi":"POST /v1/deals/fields/generations/{generationId}/cancel","href":"/api-reference/endpoint/cancel_deal_ai_field_generation"}]},{"group":"Company","pages":[{"title":"List companies","openapi":"GET /v1/companies","href":"/api-reference/endpoint/list_companies"},{"title":"Get company details","openapi":"GET /v1/companies/{companyId}","href":"/api-reference/endpoint/get_company"},{"title":"List company views","openapi":"GET /v1/companies/views","href":"/api-reference/endpoint/list_company_views"},{"title":"Get company view details","openapi":"GET /v1/companies/views/{viewId}","href":"/api-reference/endpoint/get_company_view"},{"title":"Create company view","openapi":"POST /v1/companies/views","href":"/api-reference/endpoint/post_company_view"},{"title":"Update company view","openapi":"PATCH /v1/companies/views/{viewId}","href":"/api-reference/endpoint/patch_company_view"},{"title":"Delete company view","openapi":"DELETE /v1/companies/views/{viewId}","href":"/api-reference/endpoint/delete_company_view"},{"title":"List pinned company views","openapi":"GET /v1/companies/views/pinned","href":"/api-reference/endpoint/list_pinned_company_views"},{"title":"Update pinned company views","openapi":"PUT /v1/companies/views/pinned","href":"/api-reference/endpoint/put_pinned_company_views"},{"title":"List company AI fields","openapi":"GET /v1/companies/fields","href":"/api-reference/endpoint/list_company_ai_fields"},{"title":"Get company AI field","openapi":"GET /v1/companies/fields/{fieldId}","href":"/api-reference/endpoint/get_company_ai_field"},{"title":"Create company AI field","openapi":"POST /v1/companies/fields","href":"/api-reference/endpoint/post_company_ai_field"},{"title":"Update company AI field","openapi":"PUT /v1/companies/fields/{fieldId}","href":"/api-reference/endpoint/put_company_ai_field"},{"title":"Archive company AI field","openapi":"POST /v1/companies/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_company_ai_field"}]},{"group":"Contact","pages":[{"title":"List contacts","openapi":"GET /v1/contacts","href":"/api-reference/endpoint/list_contacts"},{"title":"Get contact details","openapi":"GET /v1/contacts/{contactId}","href":"/api-reference/endpoint/get_contact"},{"title":"Create contact","openapi":"POST /v1/contacts","href":"/api-reference/endpoint/post_contact"},{"title":"Update contact","openapi":"PATCH /v1/contacts/{contactId}","href":"/api-reference/endpoint/patch_contact"},{"title":"List contact views","openapi":"GET /v1/contacts/views","href":"/api-reference/endpoint/list_contact_views"},{"title":"Get contact view details","openapi":"GET /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/get_contact_view"},{"title":"Create contact view","openapi":"POST /v1/contacts/views","href":"/api-reference/endpoint/post_contact_view"},{"title":"Update contact view","openapi":"PATCH /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/patch_contact_view"},{"title":"Delete contact view","openapi":"DELETE /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/delete_contact_view"},{"title":"List pinned contact views","openapi":"GET /v1/contacts/views/pinned","href":"/api-reference/endpoint/list_pinned_contact_views"},{"title":"Update pinned contact views","openapi":"PUT /v1/contacts/views/pinned","href":"/api-reference/endpoint/put_pinned_contact_views"}]},{"group":"Folder","pages":[{"title":"Get folder details","openapi":"GET /v1/folders/{folderId}","href":"/api-reference/endpoint/get_folder"},{"title":"Create folder","openapi":"POST /v1/folders","href":"/api-reference/endpoint/post_folder"},{"title":"Update folder","openapi":"PATCH /v1/folders/{folderId}","href":"/api-reference/endpoint/patch_folder"},{"title":"Delete folder","openapi":"DELETE /v1/folders/{folderId}","href":"/api-reference/endpoint/delete_folder"}]},{"group":"Admin automation","pages":[{"title":"List admin automations","openapi":"GET /v1/admin-automations","href":"/api-reference/endpoint/list_admin_automations"},{"title":"Get admin automation","openapi":"GET /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/get_admin_automation"},{"title":"Create admin automation","openapi":"POST /v1/admin-automations","href":"/api-reference/endpoint/post_admin_automation"},{"title":"Update admin automation","openapi":"PUT /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/put_admin_automation"},{"title":"Delete admin automation","openapi":"DELETE /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/delete_admin_automation"}]},{"group":"Workspace","pages":[{"title":"Get workspace information","openapi":"GET /v1/workspaces/mine","href":"/api-reference/endpoint/get_workspace"}]},{"group":"User","pages":[{"title":"List users","openapi":"GET /v1/users","href":"/api-reference/endpoint/list_users"},{"title":"Get user details","openapi":"GET /v1/users/{userId}","href":"/api-reference/endpoint/get_user"},{"title":"Update user","openapi":"PATCH /v1/users/{userId}","href":"/api-reference/endpoint/patch_user"}]},{"group":"Invite","pages":[{"title":"List invites","openapi":"GET /v1/invites","href":"/api-reference/endpoint/list_invites"},{"title":"Invite users","openapi":"POST /v1/invites","href":"/api-reference/endpoint/post_invite"},{"title":"Resend invite","openapi":"POST /v1/invites/{email}/resend","href":"/api-reference/endpoint/resend_invite"},{"title":"Cancel invite","openapi":"DELETE /v1/invites/{email}","href":"/api-reference/endpoint/delete_invite"}]},{"group":"User group","pages":[{"title":"List user groups","openapi":"GET /v1/user-groups","href":"/api-reference/endpoint/list_user_groups"},{"title":"Create user group","openapi":"POST /v1/user-groups","description":"Create an empty user group.","href":"/api-reference/endpoint/post_user_group"},{"title":"Update user group","openapi":"PATCH /v1/user-groups/{userGroupId}","href":"/api-reference/endpoint/patch_user_group"},{"title":"Delete user group","openapi":"DELETE /v1/user-groups/{userGroupId}","description":"Permanently delete a user group. This action cannot be undone.","href":"/api-reference/endpoint/delete_user_group"}]},{"group":"Webhook","pages":[{"title":"Trigger webhook","openapi":"POST /v1/webhooks/{webhookId}/trigger","href":"/api-reference/endpoint/trigger_webhook"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/setup"}]},{"tab":"Webhook reference","pages":[{"title":"Webhook reference","href":"/api-reference/webhooks"}]}]},"basePath":"","title":"Update user group - Claap API","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-Dr40SSJq.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}