Skip to main content
POST
/
v1
/
apps
/
{app_id}
/
users
/
invite
Invite a user
curl --request POST \
  --url https://api.mixpeek.com/v1/apps/{app_id}/users/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email_address": "<string>",
  "role": "org:member"
}
'
{
  "invitation_id": "<string>",
  "email_address": "<string>",
  "role": "<string>",
  "status": "<string>",
  "created_at": "<string>"
}

Headers

​
Authorization
string

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

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

Path Parameters

​
app_id
string
required

App ID

Body

application/json
​
email_address
string
required

Email address to invite

​
role
string
default:org:member

Clerk org role (org:admin or org:member)

Response

Successful Response

​
invitation_id
string
required
​
email_address
string
required
​
role
string
required
​
status
string
required
​
created_at
string | null