Skip to main content
PATCH
Update User

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

user_email
string
required

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

Partial update payload for a user.

user_name
string | null

Updated display name.

Required string length: 2 - 100
avatar_url
string | null

Updated profile image URL (e.g., custom avatar to override Gravatar).

role
enum<string> | null

Updated organization role.

Available options:
admin,
member,
viewer
status
enum<string> | null

Lifecycle status update (active, suspended, pending).

Available options:
active,
suspended,
pending
metadata
Metadata · object | null

Replaces metadata with the provided dictionary when set.

Response

Successful Response

The response is of type Response Update User V1 Organizations Users User Email Patch · object.