POST
/
v1
/
user
/
{distinct_id}
/
Create / Update Users
curl --request POST \
  --url https://hub.suprsend.com/v1/user/{distinct_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "$email": [
    "jsmith@example.com"
  ],
  "$sms": [
    "+1234567890"
  ],
  "$whatsapp": [
    "+1234567890"
  ],
  "$inbox": [
    "4nlPk4XXLcDxxxHQ70xx2Cx24"
  ],
  "$webpush": [
    "webpush_token_abc123"
  ],
  "$androidpush": [
    "android_push_token_xyz987"
  ],
  "$iospush": [
    "ios_push_token_lmn456"
  ],
  "$slack": [
    "U01ABCDE2F3"
  ],
  "$ms_teams": [
    "teams_user_id_12345"
  ],
  "$timezone": "America/New_York",
  "$preferred_language": "en",
  "custom_key": "custom_value"
}'
{
  "distinct_id": "_distinct_id_",
  "properties": {
    "$preferred_language": "en",
    "$timezone": "America/New_York"
  },
  "created_at": "2025-04-04T21:37:36.712496+00:00",
  "updated_at": "2025-04-04T21:37:36.743167+00:00",
  "$email": [
    {
      "value": "john@example.com",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$inbox": [
    {
      "value": "4nlPk4t4kurG5kChOELB8Q1LcDI9DHzHQ70st2E2C24",
      "id_provider": "suprsend",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$sms": [
    {
      "value": "+1234567890",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$whatsapp": [
    {
      "value": "+1234567890",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$webpush": [
    {
      "value": "webpush_token_here",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$androidpush": [
    {
      "value": "android_push_token",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$slack": [
    {
      "value": "U01ABCDE2F3",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$ms_teams": [
    {
      "value": "teams_user_id",
      "status": "active",
      "perma_status": "active"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

​
distinct_id
string
required

Unique identifier of the user in your system

Body

application/json
​
$email
string<email>[]

List of email addresses. You can add other channels in the same format by replacing $email with the respective channel keys. Supported keys- $email, $sms, $whatsapp, $inbox, $webpush, $androidpush, $iospush, $slack, $ms_teams.

​
$sms
string[]

List of phone numbers for SMS

​
$whatsapp
string[]

List of phone numbers for WhatsApp

​
$inbox
string[]

List of inbox identifiers

​
$webpush
string[]

List of web push tokens

​
$androidpush
string[]

List of Android Push tokens

​
$iospush
string[]

List of iOS Push tokens

​
$slack
string[]

List of Slack user IDs

​
$ms_teams
string[]

List of Microsoft Teams user IDs

​
$timezone
string

User's timezone in IANA format

Example:

"America/New_York"

​
$preferred_language
string

Preferred language in ISO 639-1 Alpha-2 format

Example:

"en"

​
{key}
string

Add any additional property in key-value pair

Example:

"val"

Response

201

​
distinct_id
string
Example:

"_distinct_id_"

​
properties
object

all user properties in key-value pair. SuprSend reserved properties start with $

​
created_at
string<date-time>
Example:

"2025-04-04T09:55:12.397Z"

​
updated_at
string<date-time>
Example:

"2025-04-04T09:55:12.422Z"

​
$<channel>
object[]