Information required to update a user.

Hierarchy

  • UpdateUserInfo

Properties

language?: string

Specifies the user's language.

  • Supports message translation in 32 languages and UI language in ko, ja, and en.
  • UI text adapts to ko or ja; defaults to en otherwise.
profile?: null | Profile

Specifies the user's profile.

  • Passing null will initialize the whole profile.
  • For specific fields inside the profile object, passing null will initialize that field.
  • Field names must be in camelCase.
  • The mobileNumber field must follow the E.164 format.
  • Empty objects are not allowed.
profileOnce?: Profile

Specifies the user's profile.

  • Only fields with no existing values in the profile will be added from the profileOnce object.
tags?: null | string[]

Specifies the User's tags.

  • Up to 10 tags are allowed.
  • Passing null will initialize the tags.
  • Empty arrays are not allowed.
unsubscribeEmail?: boolean

Determines whether to opt out of receiving marketing emails.

  • Setting this to true will terminate the subscription.
unsubscribeTexting?: boolean

Determines whether to opt out of receiving marketing text messages.

  • Setting this to true will terminate the subscription.

Generated using TypeDoc