Update customer properties


Update the properties of a specified customer. Use when you want to change the properties of a single customer.



In this API call you can use any of these 2 types of authorization accesses:

Available access typesPermissions needed
Public accessCustomer properties > Set
Private accessCustomer properties > Set

Read more about:

Path parameters

projectTokenstringThe ID of your projectrequired

Body parameters

customer_idsobjectOne or more hard and/or soft IDs are required. The most common ones include: registered.At least 1 required
propertiesobjectOne or more customer properties that you wish to update are required. The most common ones include: email, first_name, ...At least 1 required
update_timestampnumberUnix timestamp in seconds. Only properties with older update time will be updated.Optional


authorizationstringUsed for authentication. Read more in the Authentication section.required


Message size

  • An update message must be less than 800 KBytes
  • The value of every customer property must be less than 16 KBytes

It is strongly prohibited to use this route for sending large volumes of data. We recommend using Batch commands for more than 1 action (e.g. customer update, adding an event) and Imports (and Import API) for large volumes of data, instead.

Error handling

Some specific errors that you might encounter with this request involve:

HTTP 200 with success = false (similar to HTTP 400)Request to update customer properties was received but it could not be processed. Retrying will not help, you need to look for a mistake in your request.
	"success": false,
  "errors": "Field project_id is required"


Asynchronous endpoint

Note that this endpoint is asynchronous, which means that success response rate means only that the request is queued to be processed later, not the item was successfully updated.

Click Try It! to start a request and see the response here!