Skip to main content
import { createClient } from "@mailsai/sdk";

const client = createClient(); // reads MAILS_API_KEY

const result = await client.api_keys.revoke(
  "key_01JZX8K3M9Q4P7VN2YB6RTDC0E",
);
console.log(result);
{
  "id": "key_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "revoked_at": "2026-10-04T12:00:00.000Z"
}

Revoke an API key

Revokes a key immediately.
DELETE/v1/api-keys/{id}scope · manage
import { createClient } from "@mailsai/sdk";

const client = createClient(); // reads MAILS_API_KEY

const result = await client.api_keys.revoke(
  "key_01JZX8K3M9Q4P7VN2YB6RTDC0E",
);
console.log(result);
{
  "id": "key_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "revoked_at": "2026-10-04T12:00:00.000Z"
}

Path Parameters

idstringrequired

API key id.

Idempotent — revoking an already-revoked key returns its existing revoked_at. A test key cannot revoke a live key (403 live_mode_required): revoke it with a live key or in the dashboard.

Response

idstring

Id of the revoked key (key_…): the id in the path.

revoked_atstring

When the key was revoked; for a key already revoked, the original time.

Was this page helpful?