The create groups operation will create a number of new groups in batch with the specified request body.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/groups/batch |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
[{
"Name": "Batchgroup1",
"IsEnabled": true,
"IsDefault": false,
"IsQrEnabled": false,
"UserNames": ["Loweng"],
"UserGUIDs": ["7DF48871-E9DA-4FB2-9251-00035AD8483B"],
"ApplicationNames": ["LinkedIn"],
"ApplicationGUIDs": ["A7915C9C-3B20-4E5D-8432-01DA35D4BC04"],
"ManagedByUserGuid": "F0CE1E44-25E8-4B12-8151-EF3525017647"
},
{ "Name": "Batchgroup2",
"IsEnabled": true,
"IsDefault": false,
"IsQrEnabled": false,
"UserNames": ["P.Vos"],
"UserGUIDs": ["B47680F0-4117-45FE-9F03-000CF783E2C1"],
"ApplicationNames": ["Xing"],
"ApplicationGUIDs": ["D6F824FC-7400-4E6D-AC98-7E4E55EC637C"]
}]
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {Name} | Name of the group | Required | - |
| {isEnabled} | Is the new group enabled or disabled. | Optional | false |
| {IsDefault} | Is the new group a default group | Optional | false |
| {IsQrEnabled} | Is QR-code generation for group members enabled | Optional | false |
| {ManagedByUserGuid} | The user Guid that will be considered the manager | Optional | null |
| {UserNames} | A List of usernames that will be linked to the group. | Optional | - |
| {UserGUIDs} | A List of user Guids that will be linked to the group. | Optional | - |
| {ApplicationNames} | A list of application names that will be linked to the group. | Optional | - |
| {ApplicationGUIDs} | A list of application Guids that will be linked to the group. | Optional | - |
Generated fields
The ID and GUID fields will be auto-generated by HelloID
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. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
{
"succeededGroups": [
{
"name": "TestgroupBatch1",
"groupGuid": "80638b8a-6c4b-4d56-9c6c-83b25ce0a8d0",
"managedByUserGuid": "7f250b8d-537a-4e76-b803-43f63c83ee47",
"isEnabled": true,
"isDefault": false,
"isQrEnabled": false,
}
],
"failedGroups": [
"Group TestApi was not created, A group with this name already exists."
]
}
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X POST https://{company-name}.helloid.com/api/v1/groups/ -H "Content-Type:application/json" -d
"[{
"Name": "Batchgroup1",
"IsEnabled": true,
"IsDefault": false,
"IsQrEnabled": false,
"UserNames": ["Loweng"],
"UserGUIDs": ["7DF48871-E9DA-4FB2-9251-00035AD8483B"],
"ManagedByUserGuid": "F0CE1E44-25E8-4B12-8151-EF3525017647",
"ApplicationNames": ["LinkedIn"],
"ApplicationGUIDs": ["A7915C9C-3B20-4E5D-8432-01DA35D4BC04"]
},
{ "Name": "Batchgroup2",
"IsEnabled": true,
"IsDefault": false,
"IsQrEnabled": false,
"UserNames": ["P.Vos"],
"UserGUIDs": ["B47680F0-4117-45FE-9F03-000CF783E2C1"],
"ApplicationNames": ["Xing"],
"ApplicationGUIDs": ["D6F824FC-7400-4E6D-AC98-7E4E55EC637C"]
}]"