Skip to main content
PUT
/
api
/
projects
/
{projectId}
/
groups
/
{groupId}
Update group
curl --request PUT \
  --url https://api.example.com/api/projects/{projectId}/groups/{groupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "permissions": [],
  "filePermissions": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "permissions": [],
  "description": "<string>",
  "filePermissions": [
    {
      "actions": [],
      "id": "<string>",
      "patterns": "<string>"
    }
  ],
  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
groupId
string<uuid>
required

ID of the group to update

​
projectId
string<uuid>
required

ID of the project the group belongs to

Body

application/json
​
name
string
required

New name for the group

​
description
string

New description for the group

​
permissions
enum<string>[]

Updated list of permissions for the group

Available options:
owner,
documents,
releases,
releases:manage,
releases:deploy,
releases:delete,
integrations:manage,
documents:full,
documents:view-content,
documents:edit-content,
documents:edit-view,
branches,
branches:create,
branches:merge,
branches:delete,
project:manage,
environments,
environments:manage,
environments:delete
​
filePermissions
object[] | null

Updated file-level permissions for the group

Response

200 - application/json

The updated group

The updated group

​
id
string<uuid>
required

Unique identifier of the group

​
name
string
required

Name of the group

​
projectId
string<uuid>
required

ID of the project this group belongs to

​
permissions
enum<string>[] | null
required

List of permissions granted to this group

Available options:
owner,
documents,
releases,
releases:manage,
releases:deploy,
releases:delete,
integrations:manage,
documents:full,
documents:view-content,
documents:edit-content,
documents:edit-view,
branches,
branches:create,
branches:merge,
branches:delete,
project:manage,
environments,
environments:manage,
environments:delete
​
description
string

Description of the group

​
filePermissions
object[] | null

File-level permissions for this group

​
roleId
string<uuid>

ID of the access profile managing this group

​
role
object

Access profile that manages this group