API Keys

Revoke an API key

Requires scope: manage. Revokes a key immediately. 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.

delete/v1/api-keys/{id}

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/api-keys/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

API key id.

Response

The revoked key.

idstring required

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

revoked_atstring date-time required

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

Changes

No recorded changes to this operation across all 1 revision of this API.