Skip to content

EndpointGroupsSetEnablementOperation

HTTP API schema

← HTTP API reference

Enables or disables a group. A disabled group is hidden from group lists by default and cannot be targeted by messages such as clean-room. Rediscovery never re-enables it, so disabling (not deleting) is how a user hides a discovered group, such as a robot's room, for good.

EndpointGroupsSetEnablementOperation fields

requestIdBatchOperationRequestIdRequired

requestId: Reference BatchOperationRequestId

operationstringRequired

Operation discriminator.

Allowed values: SET_ENABLEMENT.

groupIdstringRequired

The endpoint group to modify.

minLength: 1

etagstringRequired

The group etag the client last read. When an earlier operation in the same request changes this group, send the etag that operation reports instead: every operation that changes the group advances its etag by one.

minLength: 1

enablementEnablementRequired

enablement: Reference Enablement

View source specification ↗