cancel_invite
Destructive
Cancel a pending invite to revoke user access and invalidate the invite token, preventing outstanding email links from working. The invite remains visible with a Cancelled status.
Instructions
Manage users who have access to the DoiT platform. 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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| dryRun | No | ||
| Idempotency-Key | Yes | ||
| customerContext | No | Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users. |