Edit Device Group

Restriction: This API endpoint is not supported in the Free Trial cloud.

Edits an existing device group.

Important: To be able to run this API endpoint, you need to be an Admin user or part of Perfecto Support.

URL

Copy
http://<your-cloud>.app.perfectomobile.com/api/v1/device-groups/{deviceGroupName}

Method

PUT

Header parameters

Name

Description

Perfecto-Authorization

Security Token

Data parameters (body)

Parameter Type Description

name

string

The new name of the device group. Cannot exceed 128 characters.

description

string

A description for the device group being added. Cannot exceed 512 characters.

deviceIdsToAdd

array of strings

The device IDs to add to the device group.

deviceIdsToRemove

array of strings

The device IDs to remove from the device group.

usersToAdd

array of strings

The names of the users to add to the device group.

usersToRemove

array of strings The names of users to remove from the device group.

* Mandatory parameter

Success response

Code: 200 OK

Error response

Status and a generic error message

Example

Copy
JSON request
{
    "name":"newNameToGroup", 
    "description":"deprecatd group", 
    "deviceIdsToAdd":["JSK989DSJHK"], 
    "deviceIdsToRemove":["KJD89S8DJK8"], 
    "usersToAdd":["andyG", "effiO"], 
    "usersToRemove":["talP"]
}