Skip to main content
POST
cURL

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

$ms_teams
(MS Teams using conversation ID · object | MS Teams using user ID · object | MS Teams using incoming webhook · object)[]

Microsoft Teams channel configuration

$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

Unique identifier of the user.

Example:

"_distinct_id_"

properties
object

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

created_at
string<date-time>

Timestamp when the user was created.

Example:

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

updated_at
string<date-time>

Timestamp when the user was last updated.

Example:

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

$<channel>
object[]

List of active communication channels for the user.