User Object

An object that contains information about user

id

Type
Description
stringa user id used inside channel

memberId

TypeDescription
stringmember (user) identification id used by your company

name

TypeDescription
stringa user name

avatarUrl

TypeDescription
stringuser's avatar url if exist

alert

TypeDescription
numberuser's alert count

profile

TypeDescription
objectan object contains user's key/value profile information

unsubscribeEmail

TypeDescription
booleana value of whether or not to accept marketing email

unsubscribeTexting

TypeDescription
booleana value of whether or not to accept marketing SMS

tags

TypeDescription
string[]user tags

language

TypeDescription
stringuser's language

Example:

  var user = {
    "id": "USER_ID",
    "memberId": "MEMBER_ID",
    "name": "USER_NAME",
    "avatarUrl": "AVATAR_URL",
    "alert": 0,
    "profile": {
      "name": "USER_NAME",
      "mobileNumber": "MOBILE_NUMBER",
      "CUSTOM_VALUE_1": "VALUE_1",
      "CUSTOM_VALUE_2": "VALUE_2"
    },
    "unsubscribeEmail": true,
    "unsubscribeTexting": true,
    "tags": ["TAG_1", "TAG_2"],
    "language": "LANGUAGE",
  }