Skip to main content
PATCH
Update a group

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

groupId
string
required

The identifier of the group to update.

Required string length: 40

Body

application/json
name
string

The new name of the group.

Required string length: 1 - 255
Example:

"Investors"

visibility
enum<string>

The visibility of a group.

  • public: The group is visible to all users in the workspace.
  • private: The group is visible only to explicitly added group members.
Available options:
public,
private

Response

The updated group result.

data
object
required

A group in the workspace.

Example:
deprecations
string[]
Example: