Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Edit User Profile

API to edit (add/remove) properties and communication-channels for a user.

patch/v1/user/{distinct_id}/

Path parameters

distinct_idstring required

unique identifier of the user

Request body

Response

202

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.397856+00:00",
  "updated_at": "2025-04-04T09:55:12.422388+00:00",
  "$<channel>": [
    {
      "status": "active"
    }
  ]
}