Revoke or delete a mail API key

DELETE 
/mail/api-keys/:key_id

With permanent=false (default), revokes the key and returns revoked=true. It can no longer authorize mail API requests. With permanent=true, permanently removes a revoked key and returns deleted=true. First revoke an active key: attempting to delete it directly returns 409 mail_key_active.

Request

Responses

200

Successful response

Response Headers

Cache-Control

Do not cache this response.

401

Missing or invalid key, mismatched ID, or inactive integration

403

Access denied.

404

Resource not found in this integration.

409

Resource state, payment, price or idempotency conflict. See the mail guide for error codes.

422

Invalid request fields or unsupported parameters

500

Unexpected server error

503

Mail service or usage data temporarily unavailable.