API keys

Create an API key

Changed on

The plaintext key is in this response only.

post/api-keys

Request

Request body

namestring required
permission'full_access' | 'sending_access' required
mode'live' | 'test'
domain_idstring
allow_full_accessboolean

Response

Created.

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

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      removed the success response with the status

    • warning

      the request property's maxLength was set to 100

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status