Revoke Invitation

Revoke an invitation; the emailed link stops working.

DELETEhttps://api.foxreach.io/api/v1/workspace/invites/{invite_id}

Requires an API key with the write scope.

N e The call writes an audit.workspace_invite.revoked entry.

Path Parameters#

invite_idstringpathrequired

The invitation identifier.

Returns { "data": { "id", "revoked": true } }.

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	The key lacks the `admin` or `write` scope, or its creator lacks the required role
`404`	Invitation not found, or already accepted

120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X DELETE "https://api.foxreach.io/api/v1/workspace/invites/wsi_abc123" \
  -H "X-API-Key: otr_your_key"

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.workspace.revoke_invite("wsi_abc123")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.workspace.revokeInvite("wsi_abc123");

Response

JSON

{ "data": { "id": "wsi_abc123", "revoked": true } }

Was this page helpful?

View as MarkdownLast updated November 4, 2026