Skip to main content

User Invitations

Invite users to join a tenant via email. Manage pending invitations including resending and cancelling.

Send Invitation​

Send an invitation email to a user to join the tenant.

Endpoint: POST /uflow/admin/invite

Headers​

HeaderTypeRequiredDescription
AuthorizationstringYesAdmin Bearer JWT token

Request Body​

{
"email": "string",
"role": "string",
"name": "string"
}

Parameters​

ParameterTypeRequiredDescription
emailstringYesEmail address of the user to invite
rolestringNoRole to assign on acceptance
namestringNoDisplay name for the invitation

Response​

Success (200):

{
"message": "Invitation sent successfully",
"invitation_id": "string",
"email": "string"
}

Error Responses:

  • 400 - Bad Request - invalid email
  • 401 - Unauthorized
  • 409 - User already exists or invitation already pending

List Pending Invitations​

Get all pending invitations for the tenant.

Endpoint: GET /uflow/admin/invite/pending

Headers​

HeaderTypeRequiredDescription
AuthorizationstringYesAdmin Bearer JWT token

Response​

Success (200):

[
{
"invitation_id": "string",
"email": "string",
"role": "string",
"status": "pending",
"created_at": "string",
"expires_at": "string"
}
]

Resend Invitation​

Resend an invitation email to a user.

Endpoint: POST /uflow/admin/invite/resend

Headers​

HeaderTypeRequiredDescription
AuthorizationstringYesAdmin Bearer JWT token

Request Body​

{
"email": "string"
}

Parameters​

ParameterTypeRequiredDescription
emailstringYesEmail of the pending invitation

Response​

Success (200):

{
"message": "Invitation resent successfully"
}

Error Responses:

  • 400 - Bad Request
  • 404 - No pending invitation found for email

Cancel Invitation​

Cancel a pending invitation.

Endpoint: POST /uflow/admin/invite/cancel

Headers​

HeaderTypeRequiredDescription
AuthorizationstringYesAdmin Bearer JWT token

Request Body​

{
"email": "string"
}

Parameters​

ParameterTypeRequiredDescription
emailstringYesEmail of the invitation to cancel

Response​

Success (200):

{
"message": "Invitation cancelled successfully"
}

Error Responses:

  • 400 - Bad Request
  • 404 - No pending invitation found