Skip to main content
POST
Invite a user

Authorizations

Authorization
string
header
required

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

Body

application/json
acceptInviteClientUrl
string
required

URL the user is redirected to when they accept the invite.

Example:

"https://app.example.com/invite-accept"

email
string
required

Email address of the user to invite.

Example:

"user@example.com"

Response

The invite has been sent successfully.

Invite link sent to the user.