Skip to main content
POST
Invite someone to the organization by email, with a role

Authorizations

X-API-Key
string
header
required

API key

Body

application/json
email
string
required
Maximum string length: 320
Pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
role
enum<string>
default:viewer
Available options:
owner,
admin,
underwriter,
viewer

Response

Successful Response

id
string
required
email
string
required
state
enum<string>
required
Available options:
pending,
accepted,
expired,
revoked
role_slug
string | null
required
expires_at
string<date-time>
required
created_at
string<date-time>
required
accepted_at
string<date-time> | null
required
revoked_at
string<date-time> | null
required