The update group operation will update a group (specified with request parameter) with the specified request body.
Request
Request URI
| Method | Request URI |
|---|---|
| PUT | https://{company-name}.helloid.com/api/v1/groups/{groupName} |
| PUT | https://{company-name}.helloid.com/api/v1/groups/{groupGuid} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {groupName} | The name of the group you want to update. |
| {groupGuid} | The guid of the group you want to update. |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"Name": "TestApiRenamed",
"IsEnabled": false,
"IsDefault": false,
"IsQrEnabled": false,
"ManagedByUserGuid": "F0CE1E44-25E8-4B12-8151-EF3525017647"
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {Name} | Name of the group | Optional | - |
| {IsEnabled} | Is the group enabled or disabled | Optional | - |
| {IsDefault} | Is the group a default group | Optional | - |
| {IsQrEnabled} | is QR-code generation for group members enabled | Optional | - |
| {ManagedByUserGuid} | The user Guid that will be considered the manager | Optional | null |
Request body parameters
HelloID will only update fields of the group that are present in the request body.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed.If there were validation errors, the response will include a error result. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 404(NOT FOUND) | The operation was not successful. The group has not been found. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
{
"id": 12,
"name": "TestApiRenamed",
"groupGuid": "ef24276a-cf39-44d7-b8e5-1012c0db5178",
"isEnabled": false,
"isDefault": false,
"isDeleted": false,
"isQrEnabled": false,
"ManagedByUserGuid": "F0CE1E44-25E8-4B12-8151-EF3525017647",
"users": [],
"applications": []
}
Example request with cURL
Replace placeholder values surrounded by {} with the actual values.
curl -u {api-key}:{api-secret} -X PUT https://{company-name}.helloid.com/api/v1/groups/{groupName} -H "Content-Type:application/json" -d
"{
'isEnabled': false
}"