put

/customers

Updates Customers. Subresource updates are not supported. Multiple customers can be updated in one call.

Required Fields

  • id – ID of the Customer This must be included in the request body

Read Only Fields

  • id
  • registration_ip_address
  • date_created
  • date_modified

Notes

Attributes Values can not be updated using Update a Customer. Use the Update a Customer Attribute Values endpoint.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Headers

Request Body

1 Example
Schema
array[object]
email
string

The email of the customer. Must be unique.

2 validations
first_name
string

The first name of the customer.

2 validations
last_name
string

The last name of the customer.

2 validations
company
string

The company of the customer.

2 validations
phone
string

The phone number of the customer.

2 validations
registration_ip_address
string

The IP address from which this customer was registered.

2 validations
notes
string

The customer notes.

tax_exempt_category
string

The tax exempt category code for the customer.

2 validations
customer_group_id
integer

Id of the group which this customer belongs to.

1 validation
id
integer

The unique numeric ID of the customer.

1 validation + required
authentication
object
accepts_product_review_abandoned_cart_emails
boolean

It determines if the customer is signed up to receive either product review or abandoned cart emails or recieve both emails.

store_credit_amounts
array[object]

Store credit.

1 validation

Responses

Customer Collection Response

Send a Test Request

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