POST
/
api
/
v1
/
public
/
users
{
  "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": "rIVE_m0FaG3ikBfoQpMnrC.atkBoXynQ@OEBwlohW31Ktf-dfMGMxj3TgkbDwj1KH0IXnuEJV3w.604JEK8fobAVQQQbjpVl-KadR1TyB.fvVlFnjntPRpuEJcdrquhrLrwZoEbwGlfMBqjOYZOGSpqVNVkLNsyxMKtSOCSfVzRNqhwrpnPNWlYxYBKoWjwSjaUaIqkVZ",
  "sms": "+781817969885703301818880118342548237352630121682016136565576203879663434550944895978511058235126",
  "whatsapp": "+42882193721286909407218345676453787791306251278730681683781916327067494554276609690230711025009088109",
  "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
Bearer token for API authentication. Format: Bearer {{apiToken}}
{
  "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 Parameter

{
  "email": "rIVE_m0FaG3ikBfoQpMnrC.atkBoXynQ@OEBwlohW31Ktf-dfMGMxj3TgkbDwj1KH0IXnuEJV3w.604JEK8fobAVQQQbjpVl-KadR1TyB.fvVlFnjntPRpuEJcdrquhrLrwZoEbwGlfMBqjOYZOGSpqVNVkLNsyxMKtSOCSfVzRNqhwrpnPNWlYxYBKoWjwSjaUaIqkVZ",
  "sms": "+781817969885703301818880118342548237352630121682016136565576203879663434550944895978511058235126",
  "whatsapp": "+42882193721286909407218345676453787791306251278730681683781916327067494554276609690230711025009088109",
  "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"
    }
  ]
}

​
Response Fields

​
id
string
Unique identifier for the user (UUID v4)
​
firstName
string
User’s first name
​
lastName
string
User’s last name
​
segments
array
Array of user segments/groups
​
id
string
Segment ID
​
name
string
Segment name
​
description
string
Segment description

​
Status Codes

  • 200 - OK
  • 400 - BAD REQUEST
  • 401 - UNAUTHORISED
  • 404 - NOT FOUND