Sign in

a686fddb4e0c

OpenAPI 3.1.12026-08-10130601.0 MB

Create / Update Users

API to upsert (create if not exists, update if exists) user profile using a distinct_id.

post/v1/user/{distinct_id}/

Path parameters

distinct_idstring required

Unique identifier of the user in your system

Request body

$emailstring[]

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.

$smsstring[]

List of phone numbers for SMS

$whatsappstring[]

List of phone numbers for WhatsApp

$inboxstring[]

List of inbox identifiers

$androidpushstring[]

List of Android Push tokens

$iospushstring[]

List of iOS Push tokens

$timezonestring

User's timezone in IANA format

$localestring

User's locale for translating template content in SuprSend.

Example request

{
  "$slack": [
    {
      "email": "user@example.com",
      "access_token": "xoxb-XXXXXXXX"
    }
  ],
  "$ms_teams": [
    {
      "tenant_id": "c1981ab2-9aaf-xxxx-xxxx",
      "service_url": "https://smba.trafficmanager.net/amer",
      "conversation_id": "19:c1524d7c-a06f-456f-8abe-xxxx"
    }
  ],
  "$timezone": "America/New_York",
  "$locale": "en_GB"
}

Response

201

distinct_idstring

Unique identifier of the user.

propertiesobject

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

created_atstring date-time

Timestamp when the user was created.

updated_atstring date-time

Timestamp when the user was last updated.

Example response

{
  "distinct_id": "_distinct_id_",
  "created_at": "2025-04-04T09:55:12.397Z",
  "updated_at": "2025-04-04T09:55:12.422Z",
  "$<channel>": [
    {
      "status": "active"
    }
  ]
}