Skip to main content
POST
Generate API Key

Authorizations

Authorization
string
header
required

Provide the Bearer API Key generated for your brand.

Headers

X-Super-Admin-Email
string
required

Email of an active platform super-administrator.

Body

application/json
name
string

Friendly identifier label for the key.

Example:

"POS-System-Integration"

scopes
enum<string>[]
Available options:
read,
write,
admin
Example:

Response

API key generated successfully. Plain key secret is returned in the response.

success
boolean
Example:

true

data
object
Last modified on July 12, 2026