Revoke an API key

DELETE

/api-keys/{id}

const url = 'https://mail.teamander.com/v1/api-keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

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://mail.teamander.com/v1/api-keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --header 'Authorization: Bearer <token>'

Soft-revoke: the key is marked inactive (active = false).

Authorizations

bearerAuth

Parameters

Path Parameters

required

Resource identifier

string

Example

a1b2c3d4-e5f6-7890-abcd-ef1234567890

Responses

200

Revoked

application/json

object

required

string

status

required

string

Allowed values: revoked

Example

{
  "id": "42",
  "status": "revoked"
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}