Creates a Group Management template to manage Windows local and domain groups on target endpoints. This policy supports only computer configurations.
https://{serverurl}/dcapi/config-policies/v2/windows/groupManagement Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Media type of the request body, as consumed by the endpoint.
Media type of the response body, as produced by the endpoint.
Name of the configuration. Returned as templateName in the response.
Free-text description of the configuration. May be an empty string.
What the configuration is applied to. Must be computer - Group Management applies to computers only.
Reapply the configuration at every agent refresh, even when it has already been applied successfully.
Apply the configuration at endpoint startup.
Apply the configuration at the scheduled agent refresh.
Retry the configuration on the endpoint when it fails. noOfRetries sets how many attempts are made.
Honour refreshMinRetry as the minimum gap between two retries at refresh.
Honour logonStartupMinRetry as the minimum gap between two retries at startup or logon.
Number of retry attempts made after a failure. Read only when enableRetry is true.
Minimum number of minutes between two retries at refresh. Read only when enableRefreshMinRetry is true.
Minimum number of minutes between two retries at startup or logon. Read only when enableLogonStartupMinRetry is true.
One entry per local group action, applied in the order they appear. Group Management supports only computer configurations.
Determines the operation to apply to the group.
Allowed values:
add = Creates a new group.
delete = Removes the specified group.
modify = Updates the configuration of the specified group.
Example: action: "add".
Name of the group to be created, modified, or deleted.
Example: groupName: "Demo Group".
Description of the group.
Example: description: "Group for application users".
Members to be added to the group.
Use comma (,) to separate multiple values.
Example: addMember: "John".
Members to be removed from the group.
Use comma (,) to separate multiple values.
Example: removeMember: "John".
Whether an existing group with the same name should be overwritten.
Allowed values:
true = Overwrites the existing group.
false = Does not overwrite the existing group.
Type of member to be added to the group.
Allowed values:
domainUser = Adds a domain user to the group.
domainGroup = Adds a domain group to the group.
localUser = Adds a local user to the group.
Example: addMemberType: "localUser".
Type of member to be removed from the group.
Allowed values:
domainUser = Removes a domain user from the group.
domainGroup = Removes a domain group from the group.
localUser = Removes a local user from the group.
Example: removeMemberType: "localUser".
Send an email to the addresses listed in email once the deployment finishes.
Notify the endpoint user about this deployment. notificationDuration and notificationEnabledDays are read only when this is true.
Comma-separated email addresses notified about the deployment. May be an empty string when enableEmailNotify is false.
How long a deployment notification stays on screen for the endpoint user. Read only when enableNotification is true.
Number of days for which deployment notifications stay enabled. Read only when enableNotification is true.
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/groupManagement \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"groupName":"Demo Group","action":"add"}],"label":"Group Management Config","configType":"computer"}'Manage one group entry with every documented field.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Group Management Config",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"removeMember": "",
"addMember": "John",
"groupName": "Demo Group",
"addMemberType": "localUser",
"action": "add",
"description": "Group for application users",
"removeMemberType": "localUser",
"overwrite": true
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/groupManagement \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"groupName":"Remote Support Operators","action":"modify"}],"label":"Update Group Members","configType":"computer"}'Modify an existing group by adding a domain group and removing a local user.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Update Group Members",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"removeMember": "TempOperator",
"addMember": "CORP\\HelpdeskTier1",
"groupName": "Remote Support Operators",
"addMemberType": "domainGroup",
"action": "modify",
"removeMemberType": "localUser",
"overwrite": false
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/groupManagement \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"groupName":"Deprecated Local Group","action":"delete"}],"label":"Delete Temporary Group","configType":"computer"}'Delete a local group by name. action delete only requires groupName.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Delete Temporary Group",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"groupName": "Deprecated Local Group",
"action": "delete"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
Success response returned when the configuration is saved as a reusable template.
Unique identifier of the created template. Pass it to the Deploy Configuration Template API to deploy this template to targets.
Name of the created template. It is the label sent in the request.
Type of configuration the template was created for. Allowed values:
computer
user
Login name of the API user who created the template.
Error response when the request contains invalid or missing required fields.
Product error code. 50003 = CONFIG_INVALID_INPUT_DATA: configDetails is missing or empty, or the configuration could not be resolved for this endpoint. 20003 = SERVICE_NOT_AVAILABLE: the configuration is deprecated for the requested configType.
Localised error message for the error code.
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Error response returned when the server does not have enough free disk space to store the configuration files.
Product error code. 170013 = INTERNAL_SERVER_ERROR: raised by the storage pre-check before the template is saved.
Localised error message for the error code.
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
Error response returned when the template could not be saved because of an unexpected server error.
Product error code. 1003 = INTERNAL_ERROR: the template could not be persisted. 50001 = CONFIG_INTERNAL_ERROR: an internal configuration error occurred while processing the request.
Localised error message for the error code.
Success response for manageGroup
{
"templateName": "manageGroup",
"templateId": 333,
"configType": "computer",
"addedUser": "admin"
}
Error response for manageGroup
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for updateGroupMembers
{
"templateName": "updateGroupMembers",
"templateId": 347,
"configType": "computer",
"addedUser": "admin"
}
Error response for updateGroupMembers
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for deleteGroup
{
"templateName": "deleteGroup",
"templateId": 356,
"configType": "computer",
"addedUser": "admin"
}
Error response for deleteGroup
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
User is not authorized to create the configuration policy
{
"errorCode": 1001,
"errorMsg": "Access denied - You are not allowed to access the requested resource."
}
Storage pre-check rejected the request before the template was saved
{
"errorCode": 170013,
"errorMsg": "The server machine does not have sufficient disk space. Please free up space and try again."
}
Request rejected because the caller exceeded the configured rate limit
{
"errorCode": "IAM0019",
"url": "/dcapi/config-policies/v2/windows/groupManagement",
"errorMsg": "The URL /dcapi/config-policies/v2/windows/groupManagement was called too many times. Please retry after a while."
}
Unexpected server error while saving the configuration as a template
{
"errorCode": 1003,
"errorMsg": "An Internal Error occurred, try again later."
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.