Generate API Key

Generates a new API key for the active brand. Displays the generated plain key exactly once.
Requires special admin authorization: API key must possess write and admin scopes, and the X-Super-Admin-Email header
must identify an active superadmin user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Friendly identifier label for the key.

scopes
array of strings
Defaults to read,write
scopes
Allowed:
Headers
string
required

Email of an active platform super-administrator.

Responses

400

Missing superadmin email header.

403

Insufficient privileges.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json