Skip to main content
POST
/
v1
/
user
/
{distinct_id}
cURL
curl -X POST "https://hub.suprsend.com/v1/user/user123/" \
  --header 'Authorization: Bearer __YOUR_API_KEY__' \
  --header 'Content-Type: application/json' \
  --data '{
    "$email": ["[email protected]"],
    "$sms": ["+1234567890"],
    "$slack": [{
      "email_id": "[email protected]",
      "access_token": "xoxb-..."
    }],
    "$ms_teams": [{
      "user_id": "teams_user_id_12345",
      "tenant_id": "tenant_12345",
      "service_url": "https://smba.trafficmanager.net/amer"
    }]
  }'
{
  "distinct_id": "_distinct_id_",
  "properties": {
    "$locale": "en_GB",
    "$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": "[email protected]",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$inbox": [
    {
      "value": "4nlPk4t4kurG5kChOELB8Q1LcDI9DHzHQ70st2E2C24",
      "id_provider": "suprsend",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$sms": [
    {
      "value": "+1234567890",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$slack": [
    {
      "value": {
        "email_id": "[email protected]",
        "access_token": "xoxb-..."
      },
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$ms_teams": [
    {
      "value": {
        "user_id": "teams_user_id_12345",
        "tenant_id": "tenant_12345",
        "service_url": "https://smba.trafficmanager.net/amer"
      },
      "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

​
$androidpush
string[]

List of Android Push tokens

​
$iospush
string[]

List of iOS Push tokens

​
$slack
(Slack using email · object | Slack using member ID · object | Slack using channel · object | Slack using incoming webhook · object)[]

Slack channel configuration

  • Slack using email
  • Slack using member ID
  • Slack using channel
  • Slack using incoming webhook
​
$ms_teams
(MS Teams using conversation ID · object | MS Teams using user ID · object | MS Teams using incoming webhook · object)[]

Microsoft Teams channel configuration

  • MS Teams using conversation ID
  • MS Teams using user ID
  • MS Teams using incoming webhook
​
$timezone
string

User's timezone in IANA format

Example:

"America/New_York"

​
$locale
string

User's locale for translating template content in SuprSend.

Example:

"en_GB"

​
{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[]