screen-groups

Rename a screen group

Update a screen group's name or description. A name already used by another group in your workspace is refused with a name_taken conflict error.

patch/v1/screen-groups/{id}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/screen-groups/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Screen group id.

Request body

namestring
descriptionstring nullable

Response

Success.

Example response

{
  "data": {
    "id": "sgrp_7a8b9c0d1e2f3a4b"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.