Skip to main content
POST
Create an attribute

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
attribute_type
enum<string>
required

Fixed once created.

Available options:
String,
Integer,
Number,
Boolean,
List,
Object,
DateTime
slug
string

The attribute's key, unique in the store: lowercase letters, digits and hyphens. Made from name when not sent, and fixed once created. initial-utm-source, utm-source, slugs starting with ce- and the slugs of the store's KYC document types are reserved.

active
boolean
default:true
is_visible
boolean
default:true

Shown to shoppers in the storefront.

is_filterable
boolean
default:true
is_readonly
boolean
default:false

Shoppers can't change the value in the storefront; admins still can. Can be set on custom attributes only: linked and system attributes are always read-only.

Response

OK

message
string
success
boolean
content
object