Create / Update Users
API to upsert (create if not exists, update if exists) user profile using a distinct_id.
Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
Unique identifier of the user in your system
Body
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.
List of phone numbers for SMS
List of phone numbers for WhatsApp
List of inbox identifiers
List of Android Push tokens
List of iOS Push tokens
Slack channel configuration
- Slack using email
- Slack using member ID
- Slack using channel
- Slack using incoming webhook
Microsoft Teams channel configuration
- MS Teams using conversation ID
- MS Teams using user ID
- MS Teams using incoming webhook
User's timezone in IANA format
"America/New_York"
User's locale for translating template content in SuprSend.
"en_GB"
Add any additional property in key-value pair
"val"
Response
201
Unique identifier of the user.
"_distinct_id_"
all user properties in key-value pair. SuprSend reserved properties start with $
Timestamp when the user was created.
"2025-04-04T09:55:12.397Z"
Timestamp when the user was last updated.
"2025-04-04T09:55:12.422Z"
List of active communication channels for the user.