Update a project member role

Changes the member’s project role. The project owner cannot be changed (403 PROJECT_OWNER_IMMUTABLE).

Required scope: project.members.write

PATCH /api/public/v1/projects/{projectId}/members/{memberId}

Update a project member role

cURL

curl --request PATCH \
  --url https://{platformHost}/api/public/v1/projects/{projectId}/members/{memberId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "roleId": "builtin.project.tester"
}
'

200

{
  "success": true,
  "data": {
    "memberId": "<string>",
    "userId": "<string>",
    "role": {
      "roleId": "builtin.workspace.restricted_member",
      "name": "RESTRICTED_MEMBER",
      "type": "system",
      "source": "direct"
    },
    "revision": 1,
    "email": "[e-mail]",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Use this endpoint to change a member’s project role. Send the new roleId in the request body. You can’t change the project owner. The API returns 403 PROJECT_OWNER_IMMUTABLE.

To avoid overwriting a concurrent change, send the ETag from your last read in the If-Match header. A mismatch returns 412 PRECONDITION_FAILED. Send an Idempotency-Key header so retries are safe. The request needs the project.members.write scope.

Authorizations

platformApiKeybearerPlatformKey

X-API-Key · string · header · required

Platform key, for example abl_ws_….

Headers

Idempotency-Key · string

Recommended on every write. A retry with the same key and body replays the first result instead of repeating the change. A different body returns 422 IDEMPOTENCY_KEY_REUSED; a retry while the first is still running returns 409 IDEMPOTENCY_IN_PROGRESS.

Required string length: 1 - 255

If-Match · string

The ETag from your last read. On a mismatch the request fails with 412 PRECONDITION_FAILED.

Example:

"W/\"3\""

Path Parameters

projectId · string · required

Minimum string length: 1

memberId · string · required

Minimum string length: 1

Body

application/json

roleId · string · required

Required string length: 1 - 256

Response

200

application/json

Success

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes