Skip to content
Metakip Docs

Update A Workspace Member Role

PATCH
/shares/workspace/members/{memberId}
curl --request PATCH \
  --url https://app.metakip.com/api/v1/shares/workspace/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "role": "viewer" }'

Changes a member’s workspace role. Only the workspace owner can update roles.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
memberId
required
string format: uuid

The UUID of the member.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
role
required
string
Allowed values: viewer commenter editor admin

Responses

Section titled “Responses”

200

Section titled “200”

Workspace role updated.

Media typeapplication/json
object
ok
required
boolean
message
required
string
Example
{
  "ok": true
}

403

Section titled “403”

The API token is missing a required scope: pages:write.

Media typeapplication/json

Structured error returned when the request cannot be completed.

object
error
required

Error details for programmatic handling.

object
code
required

Stable error code.

string
message
required

Human-readable explanation.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}