v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_Device Group

Update device group

Fully updates a device group's properties using the action query parameter to specify the operation being performed. This endpoint controls group membership, naming, and hierarchy — use it to add or remove devices, rename a group, or move it to a different parent in the group tree.

action query parameter values

add — Add the devices specified in device_ids to the group remove — Remove the devices specified in device_ids from the group rename — Rename the group using the name field move — Move the group under a new parent using the parent field

Request body fields (DeviceGroupUpdate)

name (required by schema, contextual by action) — Group display name; used with rename parent — UUID of the new parent group; used with move device_ids — Array of device UUIDs to add or remove; used with add / remove

Common Use Cases

Adding newly provisioned devices into their target group Reorganizing a group hierarchy by moving subgroups to a new parent Renaming a group to reflect a changed location, team, or deployment role Removing retired or reassigned devices from a group

Best Practices

Always supply the correct action value — omitting it or mismatching it with the body fields will produce unexpected behavior For bulk membership changes, prefer passing all affected device_ids in a single call rather than iterating per device Use GET /enterprise/{enterprise_id}/devicegroup/{group_id}/ to verify current group state before and after updates For partial updates (e.g., updating only one field without requiring all required fields), prefer PATCH /enterprise/{enterprise_id}/devicegroup/{group_id}/ instead

put/enterprise/{enterprise_id}/devicegroup/{group_id}/

Path parameters

group_idstring uuid required

A UUID string identifying this enterprise device group.

enterprise_idstring required

A UUID string identifying enterprise.

Query parameters

actionstring

add / remove / rename / move

Response

successful operation

idstring uuid

Group id

namestring required

Group name

created_onstring date-time

Date and time of when the group was created

enterprisestring url

Enterprise url

parentstring url

Parent group url

device_countinteger

Count of devices in the group

pathstring

Path of the group

children_countinteger

Count of child groups

thumbnailstring uuid

thumbnail associated with the group

blueprintstring uuid

Blueprint associated with the group.