Assigns or updates values to customer fields

Assigns or updates values to customer fields. The fields must already exist. If the customer does not exist, create it.

If a formatting error occurs in any of the fields an error code 400 will be returned and in that case no modification will be made. Unless ignoreErrors is set to true

When using a field of type datetime, set the date according to ISO 8601 standard. E.g: 2021-10-22T10:46:23.897Z
Deleting a customer field value: setting a customer field value to "" (empty string) or null removes the corresponding customer field record entirely. Subsequent existence filters (isnull) will match these customers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
required

customer application id

boolean
Defaults to false

Flag that indicates if the fields are updated even if there are clients with errors.

Body Params

Body object for customer fields updates

customers
array of objects
required
length between 1 and 50

List of fields per customer as key-value pairs. Values can be a string, number or boolean

customers*

Customer Object with data fields to update

string
required

External code of customer

data
object
required

Fields per customer as key-value pairs. Keys are field names declared in the application configuration (custom fields or default system fields).

Default system fields (field_role mapped):

  • email (string): Customer email address

  • phone (string): Customer phone number without country prefix (e.g. "603174460")

  • phoneE164 (string): Customer phone in E.164 format — includes country prefix (e.g. "+34603174460").
    Recommended when the full international number is available, as it allows channel services to
    derive both the national number and the country code automatically.

  • country_code (string): Country calling code digits only (e.g. "34")

  • name (string): Customer full name

  • birthday (datetime): Customer birth date (ISO 8601)

  • language (string): Customer preferred language (ISO 639-1)

Boolean fields: values for boolean fields are normalized before being stored, so the following representations are accepted and converted to a real boolean: true/false (boolean), "true"/"false" (string, case-insensitive) and 1/0 (as number or string). The boolean value false is a real value and does not delete the field — only "" or null delete it.

date-time
date-time
boolean

If customer is enabled

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json