patch/roles/{id}Write operation

Update a workspace role

Use this operation to update a workspace role. Only documented mutable fields are accepted; omitted fields retain their current values unless the request schema states replacement semantics. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change.

Required scopes

roles:write

Request example

curl --request PATCH \
  --url 'https://api.de.teamgrid.app/v1/roles/ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "string",
    "name": "string",
    "permissions": [
      "string"
    ]
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/roles/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "description": "string",
  "name": "string",
  "permissions": [
    "string"
  ]
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/roles/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "description": "string",
  "name": "string",
  "permissions": [
    "string"
  ]
}),
})

const result: ApiResponse = await response.json()

teamgrid roles update \
  ID \
  --data @payload.json \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "default": false,
      "description": "string",
      "memberCount": 0,
      "name": "string",
      "permissions": [
        "string"
      ],
      "revision": "example",
      "system": false
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · requiredIf-Matchheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Path parameters

idrequired

string

Stable identifier of the resource in the authenticated workspace.

Headers

If-Matchrequired

string

Exactly one latest strong administration ETag.

Request body

application/json

description

string

Human-readable description of the resource.

name

string

Human-readable name of the resource.

permissions

array<string>

The permissions associated with this role.

Responses

200The request to update a workspace role succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

Role

Public API representation of role.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

404The tenant-scoped resource does not exist.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

412The resource changed since the supplied revision.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

428A strong If-Match revision is required.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDupdateRoleOpenAPI JSON ↗

Documentation feedbackWas this page useful?