Skip to main content
POST
Create 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.

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.

Payload for creating an organization user.

email
string<email>
required

Unique email address within the organization.

user_name
string
required

Display name shown in dashboards and audit trails.

Required string length: 2 - 100
avatar_url
string | null

Profile picture URL (e.g., from PropelAuth picture_url property).

role
enum<string>
default:member

Default role within the organization if omitted.

Available options:
admin,
member,
viewer
status
enum<string>
default:active

Initial lifecycle status. Use 'pending' for invited users who haven't accepted yet.

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

Custom key/value metadata stored with the user record.

Response

Successful Response

The response is of type Response Create User V1 Organizations Users Post · object.