API Reference

Cancel invite

post
https://api.doit.com/iam/v1/users//actions/cancel

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of the invited user.

Query Params
boolean
Defaults to false

If true, validates and simulates the operation without committing changes. The response shape is identical to a real execution.

Body Params
Headers
string
required
length ≤ 255

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.

Responses

Updated about 21 hours ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 21 hours ago