Skip to main content
PATCH
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

Bearer token for admin authentication

Path Parameters

id
string
required

Option type ID

Body

application/json
name
string
Example:

"color"

label
string
Example:

"Color"

position
integer
filterable
boolean
kind
enum<string>
Available options:
dropdown,
color_swatch,
buttons
option_values
object[]

Inline option values. Values left out of the list on update are destroyed, so send the full set every time.

Response

option type updated

id
string
required
name
string
required
label
string
required
position
number
required
kind
enum<string>
required
Available options:
dropdown,
color_swatch,
buttons
metadata
object
required
filterable
boolean
required
created_at
string
required
updated_at
string
required
translations
object
option_values
object[]