Skip to main content
POST
/
v1
/
users
/
invite
Invite User
curl --request POST \
  --url https://api.oviond.com/v1/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "fullname": "John Doe",
  "role": "admin",
  "clients": [],
  "avatar_url": "<string>"
}
'
{
  "success": true,
  "data": {
    "email": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
email
string<email>
required
fullname
string
required
Minimum string length: 1
Example:

"John Doe"

role
enum<string>
required
Available options:
admin,
clients,
readonly
Example:

"admin"

clients
string[]
Example:
[]
avatar_url
string

Optional starting avatar URL; defaults to a placeholder the user can replace.

Response

User invited

success
enum<boolean>
required
Available options:
true
data
object
required