Skip to main content
PATCH
/
v1
/
organizations
/
users
/
{user_email}
Update User
curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations/users/{user_email} \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_name": "<string>",
  "avatar_url": "<string>",
  "role": "admin",
  "status": "active",
  "metadata": {}
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Path Parameters

​
user_email
string
required

Body

application/json

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

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.