Update Workspace Member

POST /v1/organizations/workspaces/{workspace_id}/members/{user_id}

cURL

cURL

curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members/user_01WCz1FkmYMm4gnmykNKUu3Q" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_user"
  }'

200

{
  "type": "workspace_member",
  "user_id": "<string>",
  "workspace_id": "<string>",
  "workspace_role": "workspace_user"
}

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Headers

x-api-key · string · required

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

anthropic-version · string · required

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Path Parameters

user_id · string · required

ID of the User.

workspace_id · string · required

ID of the Workspace.

Body

application/json

workspace_role · enum<string> · required

New workspace role for the User.

Available options: workspace_user, workspace_developer, workspace_admin, workspace_billing

Response

200

application/json

Successful Response

type · enum<string> · default: workspace_member · required

Object type.

For Workspace Members, this is always "workspace_member".

Available options: workspace_member

Allowed value: "workspace_member"

user_id · string · required

ID of the User.

Example:

"user_01WCz1FkmYMm4gnmykNKUu3Q"

workspace_id · string · required

ID of the Workspace.

Example:

"wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"

workspace_role · enum<string> · required

Role of the Workspace Member.

Available options: workspace_user, workspace_developer, workspace_admin, workspace_billing

Examples:

"workspace_user"

"workspace_developer"

"workspace_admin"

"workspace_billing"