StatusGator Octri Preview
PATCH/boards/{board_id}/monitor_groups/{id}

Update a monitor group

Updates an existing monitor group's name or display position on a board. Supply the fields you want to change in monitor_group; lower position values place the group earlier in the display order.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
board_idstringrequired
The identifier of the board containing the monitor group.
idstringrequired
The identifier of the monitor group to update.

Partial monitor group update payload containing a monitor_group object.

monitor_groupobjectrequired
The monitor group fields to update.

3 status codes
200Returns the updated monitor group, including its identifier, name, position, and creation and update timestamps.
dataobjectoptional
successbooleanoptional
401Returned when the request is unauthorized.
errorsarray<string>optional
successbooleanoptional
404Returned when the monitor group is not found.
errorsarray<string>optional
successbooleanoptional

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the monitor group identified by the board_id path parameter and id path parameter is not found. The request body must include the monitor_group object; include name or position with the values you want to update.