Skip to main content
POST
/
v1
/
organizations
/
users
Create User
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "user_name": "<string>",
  "avatar_url": "<string>",
  "role": "member",
  "status": "active",
  "metadata": {}
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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

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.