Skip to main content
PATCH
Edit User Profile

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

Body

application/json
operations
object[]

You can use the following operations to edit user profile.

  • $set to add/update a property
  • $unset to delete property/channel
  • $append to insert values in property/channel array
  • $remove to remove values from property/channel array
  • $set_once to remove immutable properties
  • $increment to increase/decrease integer values on further update

Response

202 - application/json

202

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 all active channels.