Skip to main content
POST
Invite user
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

/auth/invite Description: Creates or updates an invitation for a workspace member. The endpoint guarantees that a TenantInvite record exists so workspace admins can audit, resend, or cancel the invite through /user/invites. When an invite is cancelled later, the associated activation link is invalidated automatically. Method:
POST
Security:
  • Basic Authentication required
Query Parameters Request Payload:
Invitations are only available to workspace owners or admins. A tenant user can only have one active invitation at a time.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

userId
string

The tenant user record to associate with the invite

Body

application/json
email
string<email>
required

The email address of the user to be invited

sendEmail
boolean
default:true

Whether to email the invitation (defaults to true)

message
string

Custom message that will be included in the invite email

Example:

"Welcome to the workspace!"

redirectUrl
string

URL override for the activation link in the invite email

Example:

"https://app.royalti.io/email/activate"

Response

Success - Existing User Invite

message
string