Skip to navigation

Update customer

Update a customer.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

store_idstringRequired
The store id.
customer_idstringRequired
The id for the customer of a store.

Request

This endpoint expects an object.
idstringOptional1-50 characters
A unique identifier for the customer. Limited to 50 characters.
addressobjectOptional
The customer's address.
companystringOptional
The customer's company.
first_namestringOptional
The customer's first name.
last_namestringOptional
The customer's last name.
opt_in_statusbooleanOptional

The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.

total_spentdouble or stringOptional

Response

This endpoint returns an object.
addressobjectOptional
The customer's address.
companystringOptional
The customer's company.
created_atdatetimeOptionalRead-only
The date and time the customer was created in ISO 8601 format.
email_addressstringOptionalRead-only
The customer's email address.
first_namestringOptional
The customer's first name.
idstringOptionalRead-only
A unique identifier for the customer.
last_namestringOptional
The customer's last name.
opt_in_statusbooleanOptional

The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.

orders_countintegerOptionalRead-only
The customer's total order count.
sms_phone_numberstringOptional
A US phone number for SMS contact.
total_spentdouble or stringOptional
updated_atdatetimeOptionalRead-only
The date and time the customer was last updated in ISO 8601 format.