Revoke an Invitation

View .md OpenAPI spec Open in Claude Open in ChatGPT

DELETE

/v1/organizations/{id}/invitations/{invitation}

const url = 'https://app.caprid.com/v1/organizations/4/invitations/3f9c1a2b7d4e';
const options = {
  method: 'DELETE',
  headers: {cookie: '__Host-switchboard_session=<__Host-switchboard_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://app.caprid.com/v1/organizations/4/invitations/3f9c1a2b7d4e \
  --cookie __Host-switchboard_session=<__Host-switchboard_session>

Its link stops working. Owners only, signed in with a session.

Authorizations

session

Parameters

Path Parameters

required

integer

The Organization’s id, from GET /v1/organizations.

Example

invitation

required

string

The Invitation’s id, from the list.

Example

3f9c1a2b7d4e

Responses

204

Revoked.

401

No valid credential. Missing, expired and revoked credentials all get the same response, and so does an API key whose trial has lapsed. An Agent token from before a claim gets a 401 too, once the claim has made the trial a person’s, with a message saying to get a new token.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}

Headers

WWW-Authenticate

string

Example

Bearer realm="switchboard"

403

You aren’t an Owner of this Organization, or you sent an API key.

application/json

object

error

required

string

Example

{
  "error": "only an Owner can manage this Organization's Invitations"
}

404

No such pending Invitation. One already accepted, revoked or expired is a 404 too.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}