Docs
Team

Cancel an invite

DELETEhttps://api.norreach.app/v1/invites/{id}

Cancels a pending invite (the id from GET /invites): the invitation stops working and the account it created, never used, is removed. Someone who has already signed in can't be un-invited → 409 conflict (switch them off with PATCH /members/{id} instead). Managers cancel callers' invites; anyone else's needs an owner or admin AND the team:admin scope. dry_run=true previews it.

team:writeRole must allow: team.inviteSupports dry_runOperation id: cancel_invite
DELETE/invites/{id}
curl -X DELETE "https://api.norreach.app/v1/invites/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Cancel an invite
{
  "id": "7c6b5a49-3827-4615-8a4b-3c2d1e0f9a8b",
  "object": "invite",
  "canceled": true,
  "dry_run": false,
  "note": "Invite cancelled. Their unused account is removed."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope team:write. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

200application/json— Cancel an invite

idstring (uuid)required

An id (UUID).

object"invite"required
canceledbooleanrequired
dry_runbooleanrequired
notestringrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403member_lockedThis person's role or access can't be changed this way.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
409conflictThat conflicts with the current state.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.