v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_Device Group

Partially update a device group

Partially updates one or more properties of a device group without requiring all fields to be present in the request body. Like the full update endpoint, the action query parameter specifies the operation being performed — but here only the fields relevant to that action need to be included. Use this endpoint instead of PUT when making a single targeted change, such as renaming a group or adding a small set of devices, without needing to supply the full group object.

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 (all optional)

name — Group display name; used with rename parent — UUID of the new parent group; used with move device_ids — Array of device UUIDs; used with add / remove

Common Use Cases

Renaming a group without affecting its membership or hierarchy Adding or removing a subset of devices without resending the full group payload Moving a group to a new parent as part of a hierarchy reorganization

Best Practices

Prefer this endpoint over PUT for single-field changes — it reduces payload size and minimizes the risk of accidentally overwriting other fields Always supply the action query parameter and ensure the body fields match the intended action Use GET /enterprise/{enterprise_id}/devicegroup/{group_id}/ to verify the current group state before and after updates

patch/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.