Skip to main content
POST
Resend user invitation email

Body

application/json

Request model for resending user invitation.

Used to trigger a new invitation email when the original invitation has expired, was not received, or the user needs another copy.

email
string<email>
required

Email address of the user to re-invite. Must match an existing user account in pending or active status. A new invitation email will be sent to this address with a fresh authentication link and setup instructions.

Examples:

"user@example.com"

"john.doe@company.com"

Response

Invitation email successfully queued for delivery

Response model for resend invite operation.

Confirms that the invitation email was successfully queued or sent. Actual email delivery depends on external email service.

email
string
required

Email address that received the invitation. Echoes back the requested email for confirmation. Useful for logging and audit purposes.

Examples:

"user@example.com"

"john.doe@company.com"

message
string
required

Human-readable message describing the result. Provides confirmation or additional context about the operation. Example: 'Invitation has been resent successfully'

Examples:

"Invitation has been resent successfully"

"Invitation email queued for delivery"

success
boolean
required

Indicates whether the invitation was successfully processed. True if invitation was queued/sent, False if operation failed. Note: This indicates the API succeeded, not that email was delivered.

Example:

true