Skip to main content
POST
/
invites
Create invite
curl --request POST \
  --url https://api.vidbeo.com/v2/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example",
  "email": "[email protected]",
  "authentication": "password",
  "role": "admin"
}
'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "email": "[email protected]",
    "authentication": "password",
    "role": "admin",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string

Their full name

Required string length: 1 - 40
Example:

"Example"

​
email
string<email>

Their email address

Example:

"[email protected]"

​
authentication
enum<string>

How should we authenticate them? You should only use "sso" if you have previously configured a SAML2 identity provider

Available options:
password,
sso
Example:

"password"

​
role
enum<string>

What is their role?

Available options:
viewer,
uploader,
admin,
owner
Example:

"admin"

Response

Invite

​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]