Skip to main content
PATCH
Update project member

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

user_id
string<uuid>
required

User ID of the project member.

Body

application/json
role
enum<string>
required

New role: admin, editor or viewer. Owner promotion uses updateProjectOwner.

Available options:
admin,
editor,
viewer

Response

The member with the new role

user_id
string<uuid>
required

User ID of the project member.

email
string
required

Email address of the member.

name
string | null
required

Display name of the member; null when the member has none.

avatar_src
string | null
required

Avatar URL of the member; null when the member has none.

role
enum<string>
required

Project role of the member: owner, admin, editor or viewer.

Available options:
owner,
admin,
editor,
viewer
capabilities
enum<string>[]
required

Project capabilities the role grants, as the permission checks resolve them.

Available options:
project.read,
project.settings.manage,
project.delete,
project.members.read,
project.members.manage,
project.invites.read,
project.invites.manage,
project.files.read,
project.files.write,
project.realtime.connect,
project.realtime.write,
project.files.admin,
project.uploads.read,
project.uploads.write,
project.uploads.admin,
project.knowledge.read,
project.knowledge.write,
project.releases.read,
project.releases.write,
project.deployments.read,
project.deployments.write,
project.deploy.execute,
project.runtime.manage,
project.channels.read,
project.channels.write,
project.sandboxes.manage,
project.domains.write,
project.environments.manage,
project.env_vars.write,
project.runs.read,
project.runs.write,
project.runs.admin,
project.agents.read,
project.agents.write,
project.evals.read,
project.evals.write,
project.evals.run,
project.conversations.read,
project.conversations.write,
project.conversations.create,
project.integrations.read,
project.integrations.connect,
project.integrations.configure,
project.api_keys.read,
project.api_keys.manage,
project.cache.read,
project.cache.write,
project.logs.read,
project.metrics.read,
project.resources.read