Skip to main content
POST
/
api
/
adm
/
invitations
/
updateInvitations
Update Invitation Statuses
curl --request POST \
  --url https://localhost:44371/api/adm/invitations/updateInvitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Updates invitation status in batch for administrative management. Common operations include cancelling pending invitations for users who should no longer be invited, or manually expiring invitations. Accepted invitations cannot be modified.

​
Input

  • Body: model (UserInvitationUpdateCommandRequest, required) — Update request including:
    • invitationIds (guid[], required) — Array of invitation IDs to update.
    • newStatus (string, required) — New status to apply (Cancelled, Expired).

​
Output

Returns a UserInvitationUpdateCommandResponse indicating whether the update was successful.

​
Example Request

POST /api/admin/userInvitations/update
Content-Type: application/json
Authorization: Bearer {token}

{
  "invitationIds": ["9ef15c43-a955-6f4h-c7g3-1h6d4f0e3g9c"],
  "newStatus": "Cancelled"
}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Errors

  • 400 Bad Request — Invitation has already been accepted and cannot be changed.
  • 404 Not Found — One or more invitation IDs do not exist.

​
Notes

  • Accepted invitations cannot be modified or cancelled.
  • Use ResendInvitation endpoint to resend emails instead of status update.
  • Status changes are audited for compliance tracking.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

The update command containing invitation IDs and new status values to apply.

Base structure for command requests that modify data. Represents the command used to update the status of user invitations.

​
statuses
object[] | null

The collection of invitation statuses to update.

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard command response indicating the result of a data modification. Represents the response returned after updating user invitations.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null