{"title":"(automation API) Update userGroupPermission","url":"https://jonas-paprotka.de/docs/dev-itpro/administration/api/dynamics_usergrouppermission_update/","by":"JOP-AL","license":"Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/api/dynamics_usergrouppermission_update, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/api/dynamics_usergrouppermission_update","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"Updates a user group permission object in Dynamics 365 Business Central.","date":"2024-05-31","meta":{"topic":"reference"},"outline":[{"level":1,"title":"(automation API) Update userGroupPermission","slug":"automation-api-update-usergrouppermission","at":0,"chars":2127},{"level":2,"title":"HTTP request","slug":"http-request","at":138,"chars":302},{"level":2,"title":"Request headers","slug":"request-headers","at":440,"chars":286},{"level":2,"title":"Request body","slug":"request-body","at":726,"chars":340},{"level":2,"title":"Response","slug":"response","at":1066,"chars":140},{"level":2,"title":"Example","slug":"example","at":1206,"chars":784},{"level":2,"title":"Related information","slug":"related-information","at":1990,"chars":137}],"text":"# (automation API) Update userGroupPermission\nUpdates the properties of a user group permission object for Dynamics 365 Business Central.\n## HTTP request\nReplace the URL prefix for Business Central depending on environment following the guideline<../../api-reference/v2.0/enabling-apis-for-dynamics-nav>.\n```\nPATCH /microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})/userGroupPermission({userGroupPermissionId})\n```\n## Request headers\nHeader|Value\nAuthorization|Bearer {token}. Required.\nContent-Type|application/json\nIf-Match|Required. When this request header is included and the eTag provided does not match the current tag on the userGroupPermission, the user group permission will not be updated.\n## Request body\nIn the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.\n## Response\nIf successful, this method returns a ```200 OK``` response code and an updated userGroupPermission object in the response body.\n## Example\nRequest\nHere is an example of the request.\n```json\nPATCH https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})/userGroupPermission({userGroupPermissionId})\nContent-type: application/json\n{\n    \"roleId\": \"D365 COMPANY HUB\"\n}\n```\nResponse\nHere is an example of the response.\n> NOTE\n> The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.\n```json\n{\n    \"id\": \"d38a92e2-9d74-eb11-bb5c-00155df3a615\",\n    \"userGroupCode\": \"D365 COMPANY HUB\",\n    \"roleId\": \"D365 COMPANY HUB\",\n    \"displayName\": \"D365 COMPANY HUB\",\n    \"appID\": \"00001111-aaaa-2222-bbbb-3333cccc4444\",\n    \"scope\": \"System\",\n    \"extensionName\": \"\"\n}\n```\n## Related information\nTips for working with the APIs<../../developer/devenv-connect-apps-tips>\n../resources/dynamics_usergrouppermission"}