Update userGroup

Article
12/13/2023

Note

User groups are replaced with security groups and will be deprecated in version 25. For more information, see security group APIs and Control Access to Business Central Using Security Groups.

Updates the properties of an user group object for Dynamics 365 Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

PATCH /microsoft/automation/v2.0/companies({companyId})/userGroups({userGroupId})

Request headers

Header	Value
Authorization	Bearer {token}. Required.
Content-Type	application/json
If-Match	Required. When this request header is included and the eTag provided does not match the current tag on the userGroup, the user group will not be updated.

Request body

In 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.

Response

If successful, this method returns a 200 OK response code and an updated userGroup object in the response body.

Example

Request

Here is an example of the request.

PATCH https:///microsoft/automation/{apiVersion}/companies({companyId})/userGroups({userGroupId})
Content-type: application/json
{
    "displayName" : "YourUserGroupName"
}

Response Here is an example of the response.

HTTP/1.1 200 OK
Content-type: application/json
{
    "id": "d38a92e2-9d74-eb11-bb5c-00155df3a615",
    "code": "D365 ACCOUNTANTS",
    "displayName": "YourUserGroupName",
    "defaultProfileID": "ACCOUNTANT PORTAL",
    "assignToAllNewUsers": false
}

Share via