post

/customers/attributes

Creates a Customer Attribute. Multiple customer attributes can be created in one call.

Required Fields

  • name
  • type

Limits

  • Limit of 3 concurrent requests.

Notes

Once the data type is set, it cannot be changed. The attribute will need to be deleted then created again with the new data type. This will also delete it from the customer.

Customer attributes are created separately from the customer. After the name and type are created, then the attributes can be added to the customer.

A store cannot have more than 50 customer attributes.

Authorization

apiKey - X-Auth-Token

Request Parameters

2 Headers

Request Body

Schema
array[object]
$schema: http://json-schema.org/draft-04/schema#
name
string

Attribute name.

2 validations + required
type
string

Attribute type should match one of: string, number, date.

2 validations + required

Responses

1 Example
Schema
object

Response payload for the BigCommerce API.

$schema: http://json-schema.org/draft-04/schema#
data
array[object]
meta
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
store_hash
X-Auth-Token