BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesSelf-HostedAgents & TunnelsYAMLBuddy GitFAQAPI

Edit

  • PATCH
  • /workspaces
  • /:workspace
  • /permissions
  • /:permission_set_id

Edits a custom permission set. Restricted to admins only.

Request

REQUIRED SCOPES
WORKSPACE
URL PARAMETERS
workspacerequiredstring
The workspace name.
permission_set_idrequiredinteger
The numerical ID of the desired permission set.
POST PARAMETERS
descriptionstring
The description of the permission set.
namerequiredstring
The name of the permission set.
pipeline_access_levelrequiredstring
Can be one of DENIED, READ_ONLY, RUN_ONLY, or READ_WRITE.
repository_access_levelrequiredstring
Can be one of READ_ONLY, READ_WRITE, or MANAGE.
sandbox_access_levelrequiredstring
Can be one of DENIED, READ_ONLY, or READ_WRITE.
project_team_access_levelstring
Can be READ_ONLYor MANAGE.

Last modified on Jan 19, 2026

Previous pagePermission sets in a workspaceNext pageDelete

Request example

curl -X PATCH "https://api.buddy.works/workspaces/:workspace/permissions/:permission_set_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Artists can only view source",
  "pipeline_access_level": "DENIED"
}'

Response

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/permissions/3",
  "html_url": "https://app.buddy.works/buddy/permissions/edit/3",
  "id": 3,
  "name": "Artist",
  "description": "Artists can only view source",
  "type": "CUSTOM",
  "repository_access_level": "READ_ONLY",
  "pipeline_access_level": "DENIED",
  "sandbox_access_level": "DENIED",
  "project_team_access_level": "READ_ONLY"
}