Skip to main content
PATCH
/
organizations
/
{organization}
/
members
/
{id}
Update organization member role
curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/members/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "<string>"
}
'
{
  "id": "<string>",
  "user": {
    "id": "<string>",
    "display_name": "<string>",
    "name": "<string>",
    "email": "<string>",
    "avatar_url": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "two_factor_auth_configured": true,
    "default_organization": {
      "id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>"
    },
    "sso": true,
    "managed": true,
    "directory_managed": true,
    "email_verified": true
  },
  "role": "member",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organization
string
required

The name of the organization

​
id
string
required

The ID of the user

Body

application/json
​
role
string
required

The role to assign to the member (e.g., 'admin', 'member'). Note: Cannot update your own role. Roles managed by IdP cannot be updated via API.

Response

Returns the updated membership

​
id
string
required

The ID of the membership

​
user
object
required
​
role
enum<string>
required

The role of the user in the organization

Available options:
member,
admin
​
created_at
string
required

When the membership was created

​
updated_at
string
required

When the membership was last updated