Skip to main content
POST
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Body

application/json
name
string
required

Unique role name, the machine identifier shown capitalized in the dashboard.

Example:

"order_manager"

description
string | null
Example:

"Handles daily orders"

permissions
string[]

Permission keys (read_orders, write_products, ...) from the permissions endpoint. You can only grant keys you hold yourself.

Example:

Response

role created