Mailfully logo

Revoke an API key

POSThttps://api.mailfully.com/v1/api-keys/{id}/revoke

Revoke an API key. Idempotent: an active key, or one mid-rotation-grace with a future-dated revoked_at, is stamped revoked_at = now and rejected immediately thereafter, so revoking a rotated key cuts its grace window short. A key whose revoked_at is already in the past keeps that existing timestamp. Dashboard only (owner or admin). API keys get 403 insufficient_scope. Takes no request body.

Loading code example
Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

The API key resource id (key_…).

Response

application/json

The key's revocation timestamp.

idstringrequired
revoked_atstring<date-time>required

The revocation timestamp: now when the key was active or mid-rotation-grace, cutting the grace short; the pre-existing timestamp only when the key was already revoked in the past.