USERS
EVENTS
OBJECTS
PREFERENCE
- Update User Preferences
- Get User Preferences
- Manage Tenant Preferences
- Update Object Preferences
- Get Object Preferences
LISTS
BROADCAST
USERS
Create / Update Users
APIs to upsert user profile
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"
],
"$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
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
application/json
Response
201
application/json
201
The response is of type object
.
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"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.