Skip to main content
POST
Invite a member

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
Maximum string length: 254
name
string
required
Required string length: 1 - 255
role
enum<string>
required

Role granted on acceptance. One of ADMIN, USER, VIEWER.

Available options:
ADMIN,
USER,
VIEWER

Response

Successful response

id
string
required
email
string
required
name
string | null
required
role
enum<string>
required
Available options:
ADMIN,
USER,
VIEWER
state
enum<string>
required
Available options:
PENDING,
ACCEPTED
invited_by_id
string | null
required
created_at
string
required