Skip to main content
PUT
/
api
/
v1
/
public
/
users
/
{uniqueId}
{
  "email": "xyz@mail.com",
  "sms": "+1234567890",
  "whatsapp": "+1234567890",
  "pushToken": null,
  "inApp": null,
  "slack": null,
  "discord": null,
  "teams": null,
  "line": null,
  "activeChannels": [
    "sms",
    "whatsapp"
  ],
  "name": "qwert",
  "uniqueId": "qwert",
  "active": true,
  "customData": null
}
{
  "email": "rj6EC02IyA3ZEd+6x@idS.Qfw0d8Esxsc8AJEuTF.cfVwSQrxjrkbmbwIIKvqhDpgnaKxXs",
  "sms": "+363186",
  "whatsapp": "+16552905891096103551438680282706",
  "pushToken": "string",
  "inApp": "string",
  "slack": "string",
  "discord": "string",
  "teams": "string",
  "line": "string",
  "activeChannels": ["SMS"],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "firstName": "string",
  "lastName": "string",
  "uniqueId": "string",
  "active": true,
  "customData": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "segments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string"
    }
  ]
}
Authorization
string
required

Query Parameters

uniqueId
string
required
The unique identifier of the user to update.
{
  "email": "xyz@mail.com",
  "sms": "+1234567890",
  "whatsapp": "+1234567890",
  "pushToken": null,
  "inApp": null,
  "slack": null,
  "discord": null,
  "teams": null,
  "line": null,
  "activeChannels": [
    "sms",
    "whatsapp"
  ],
  "name": "qwert",
  "uniqueId": "qwert",
  "active": true,
  "customData": null
}

Request Body Parameters

email
string
The email address of the user.
sms
string
The SMS number of the user.
whatsapp
string
The WhatsApp number of the user.
pushToken
string
The Push Token of the user.
inApp
string
The InApp id of the user.
slack
string
The slack id of the user
discord
string
The discord id of the user
teams
string
The teams id of the user
line
string
The line id of the user
activeChannels
array
The active channels of the user
name
string
The name of the user
uniqueId
uuid
The unique identifier of the user
active
boolean
The active status of the user
customData
object
The custom data of the user
{
  "email": "rj6EC02IyA3ZEd+6x@idS.Qfw0d8Esxsc8AJEuTF.cfVwSQrxjrkbmbwIIKvqhDpgnaKxXs",
  "sms": "+363186",
  "whatsapp": "+16552905891096103551438680282706",
  "pushToken": "string",
  "inApp": "string",
  "slack": "string",
  "discord": "string",
  "teams": "string",
  "line": "string",
  "activeChannels": ["SMS"],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "firstName": "string",
  "lastName": "string",
  "uniqueId": "string",
  "active": true,
  "customData": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "segments": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string"
    }
  ]
}

Status Codes

200 - OK: User updated successfully