API keys

Rotate an API key

Changed on

Creates a replacement with the same name, permission, mode and domain, and deletes the old key immediately. The response has a new id and the plaintext key.

post/api-keys/{id}/rotate

Request

Path parameters

idinteger required

API key numeric id.

Response

Rotated.

keystring required

The plaintext key. Returned only here — store it now.

idinteger required
namestring required
permission'full_access' | 'sending_access' required
mode'live' | 'test' required
keyPrefixstring required

Changes

    • warning

      added the new daily_limit_exceeded enum value to the //// response property for the response status

    • warning

      added the new daily_limit_exceeded enum value to the response property for the response status

    • warning

      added the new daily_limit_exceeded enum value to the response property for the response status

    • warning

      added the new daily_limit_exceeded enum value to the response property for the response status

    • warning

      added the new daily_limit_exceeded enum value to the response property for the response status

    • warning

      added the new monthly_limit_exceeded enum value to the //// response property for the response status

    • warning

      added the new monthly_limit_exceeded enum value to the response property for the response status

    • warning

      added the new monthly_limit_exceeded enum value to the response property for the response status

    • warning

      added the new monthly_limit_exceeded enum value to the response property for the response status

    • warning

      added the new monthly_limit_exceeded enum value to the response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the //// response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the response property for the response status

    • info

      endpoint added