Edits customer field

Edits customer field

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required
Body Params
string | null
enum

Customer field format. This property currently only applies to fields with valueType = 'datetime'.

Allowed:
boolean | null

Enables or disables field computation. Only applicable for simple_computed and aggregated_computed fields.

string | null

Optional description for the field.

string | null
enum

Business role identifier for the field.

CONTACT FIELDS (valueType: string):

  • email: Customer email address
  • phone: Customer phone number without country prefix (e.g. 699999999)
  • phoneE164: Customer phone number in E.164 format (e.g. +34699999999)
  • name: Customer full name

DEMOGRAPHICS FIELDS:

  • birthday (valueType: datetime, format: date): Customer birth date
  • language (valueType: string): Customer preferred language (ISO 639-1 code)
  • country_code (valueType: string): Customer country (ISO 3166-1 alpha-2 code)
  • city (valueType: string): Customer city name

LOCATION FIELDS (valueType: string):

  • address: Customer physical address
  • timezone: Customer timezone (IANA timezone identifier)

IMPORTANT CONSTRAINTS:

  1. Only one field per role per application is allowed
  2. Each role requires a specific valueType (see list above)
  3. Field role can be updated or set to null to remove it
  4. If another field already holds the specified role, it will automatically lose it
Responses

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