Skip to content

Update workspace member

Viewing v2— current version

PATCH
/v2/workspaces/{workspace_id}/members/{user_id}
curl --request PATCH \
--url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/members/:user_id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"role": "admin",
"status": "active"
}'

Unchanged from v1. This endpoint’s documented request and response schemas are identical in v1 and v2 — change the /v1 prefix to /v2. Schema equality is not a promise about behaviour, so keep your usual smoke tests.

workspace_id
required
Workspace Id

Id of the workspace that owns the resource.

string format: uuid

Id of the workspace that owns the resource.

user_id
required
User Id

Id of the user.

string format: uuid

Id of the user.

Media typeapplication/json
UpdateMemberBody
object
role
Any of:
Role
string
Allowed values: admin editor settings_admin art_director artist member
status
Any of:
WorkspaceMembershipStatus
string
Allowed values: active suspended

Successful Response

Media typeapplication/json
MemberOutput
object
membership_id
required
Membership Id

The workspace membership’s unique identifier.

string format: uuid
user_id
required
User Id

The member’s user id.

string format: uuid
email
required
Email

The member’s email address.

string
name
Any of:
string
role
required
Role

The member’s workspace role.

string
Allowed values: admin editor settings_admin art_director artist member
status
required
WorkspaceMembershipStatus

Membership status: active or suspended.

string
Allowed values: active suspended
Example
{
"role": "admin",
"status": "active"
}

Unauthenticated — missing or invalid Bearer token.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
Example
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Error Title",
"status": 400,
"detail": "Human-readable description."
}

Forbidden — insufficient permissions.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
Example
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Error Title",
"status": 400,
"detail": "Human-readable description."
}

Resource not found.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
Example
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Error Title",
"status": 400,
"detail": "Human-readable description."
}

Invalid input parameters.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
Example
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Error Title",
"status": 400,
"detail": "Human-readable description."
}

Rate limited — too many concurrent requests.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
Example
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Error Title",
"status": 400,
"detail": "Human-readable description."
}

Internal server error.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
Example
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Error Title",
"status": 400,
"detail": "Human-readable description."
}