POST
/
v1
/
user
/
{distinct_id}
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"
  ],
  "$timezone": "America/New_York",
  "$preferred_language": "en"
}'
{
  "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"
    }
  ]
}

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

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

​
$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
application/json
201
​
distinct_id
string
Example:

"_distinct_id_"

​
properties
object

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

​
created_at
string
Example:

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

​
updated_at
string
Example:

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

​
$<channel>
object[]

Was this page helpful?