v1
latestOpenAPI 3.0.12026-07-26152262362.2 KBCancel invite
Marks the invite as Cancelled and invalidates the invite token so any outstanding email links stop working. The invite document is retained (soft cancel) — the user row remains visible in GET /iam/v1/users with inviteStatus: Cancelled. Use DELETE /iam/v1/users/{id} to fully remove the record.
Returns 404 if no invite exists for the given ID, and 409 if the invite is already cancelled.
Requires usersManager permission.
Path parameters
The unique ID of the invited user.
Query parameters
If true, validates and simulates the operation without committing changes. The response shape is identical to a real execution.
Headers
Client-generated idempotency key (UUID v4 or ULID recommended, max 255 characters). Re-submitting the same key with the same request returns the cached response without re-executing side effects. The server retains the key for at least 24 hours.
Request body
Response
OK - Invite cancelled.