Rename or Move Organization Groups
PUT/iot/pub/v1/organization/group
Rename groups, move them under another group, or both. Send one item, or an array of up to 1000 items. A group keeps its subgroups and sites, and a move takes them along.
Groups are identified by name, so renaming a group changes the name that scripts and integrations must use for it.
In an array, the items are applied in the order given, and each item uses the result of the items before it: a group that an earlier item renamed is named by its new name. The request is all or nothing: if any item is rejected, the request returns HTTP 400 and no group is changed.
The top-level group cannot be renamed or moved. A move that would place a group under itself or one of its subgroups, or make the hierarchy deeper than five levels (including the top-level group), returns HTTP 400. If another request changes the hierarchy at the same time and the two requests conflict, the request returns HTTP 400 and its own changes are undone. The request is not retried automatically; send the request again. In the rare case that a change cannot be undone, the request returns a message with the names of the groups that are still changed; retrieve the hierarchy to see its current state before you send the request again.
An account that has access to only some groups can change only those groups and the groups beneath them; for any other group the request returns HTTP 400.
Request
Responses
- 200
- 4XX
- 5XX
Groups Successfully Updated
Client Error Response
Server Error Response