PATCH
/
v1
/
user
/
{distinct_id}
curl --request PATCH \
  --url https://hub.suprsend.com/v1/user/{distinct_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "operations": [
    {
      "$set": {},
      "$unset": [
        "<string>"
      ],
      "$append": {},
      "$remove": {},
      "$set_once": {},
      "$increment": {}
    }
  ]
}'
{
  "distinct_id": "_distinct_id_",
  "properties": {
    "name": "Marge Simpson",
    "$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"
    }
  ]
}

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
Example:

"_distinct_id_"

​
properties
object

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

​
created_at
string
Example:

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

​
updated_at
string
Example:

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

​
$<channel>
object[]

list of all active channels.

Was this page helpful?