<- Customers API

Customers API

Bulk update customers

POST

 /v2/customers/bulk-update

Updates multiple customer profiles.

This endpoint takes a map of individual update requests and returns a map of responses.

You cannot use this endpoint to change cards on file. To make changes, use the Cards API or Gift Cards API.

Permissions:CUSTOMERS_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

customers

Required

A map of 1 to 100 individual update requests, represented by customer ID: { customer data } key-value pairs.

Each key is the ID of the customer profile to update. To update a customer profile that was created by merging existing profiles, provide the ID of the newly created profile.

Each value contains the updated customer data. Only new or changed fields are required. To add or update a field, specify the new value. To remove a field, specify null.

Link to section

Response fields

Link to section

responses

A map of responses that correspond to individual update requests, represented by key-value pairs.

Each key is the customer ID that was specified for an update request and each value is the corresponding response. If the request succeeds, the value is the updated customer profile. If the request fails, the value contains any errors that occurred during the request.

Link to section

errors

Any top-level errors that prevented the bulk operation from running.