Modify group


Add a group for a sub-user. All zones created by this sub-user will be added to the given group.


Name Data Type Status Description
auth-id Integer Required Authentication parameter
auth-password String Required Authentication parameter
id Integer Required Sub user's ID. You can see this ID with the method List sub-users
group-id Integer Required Group ID. You can see this ID with the method List groups
apply-to-zones Integer Optional

All of the zones that the sub-user has at the moment will be added to the group. Default is 0.

  • 0 - Do not add the zones
  • 1 - Add the zones

Return: Array with status and status description.


When the authentication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

If the sub user's ID is invalid, the following status will be returned:

{"status":"Failed","statusDescription":"You don't have permission to do that."}

Note: These are example errors in JSON format, and these are not the only errors that can be displayed.


POST/GET: auth-id=0&auth-password=password&id=0&group-id=123&apply-to-zones=1

POST/GET: auth-id=0&auth-password=password&id=0&group-id=123&apply-to-zones=1

Last modified: 2024-01-16
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more