PUT /groups/:group_id/visibility — opal-api

latestOpenAPI 3.1.02026-08-16160205478.8 KB

35a0d1b09a5d

groups

Sets the visibility of this group.

put/groups/{group_id}/visibility

Path parameters

group_idstring uuid required

The ID of the group.

Request body

visibility'GLOBAL' | 'LIMITED' required

The visibility level of the entity.

visibility_group_idsstring[]

Example request

{
  "visibility": "LIMITED",
  "visibility_group_ids": [
    "7870617d-e72a-47f5-a84c-693817ab4567",
    "1520617d-e72a-47f5-a84c-693817ab48ad2"
  ]
}

Response

The visibility info of this group.

visibility'GLOBAL' | 'LIMITED' required

The visibility level of the entity.

visibility_group_idsstring[]

Example response

{
  "visibility": "LIMITED",
  "visibility_group_ids": [
    "7870617d-e72a-47f5-a84c-693817ab4567",
    "1520617d-e72a-47f5-a84c-693817ab48ad2"
  ]
}