OBJECTS
Edit Object Profile
API to add / remove properties and communication channel from object profile
PATCH
Authorizations
Pass as Bearer <API_KEY>
. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
Unique identifier of the object in your system
Body
application/json
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
200
application/json
200 - OK
unique identifier of the object
Example:
"engineering"
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
Example:
"departments"
number of users/child objects subscribed to the object
Example:
"departments"
all user properties in key-value pair. SuprSend reserved properties start with $
Example:
"2025-04-04T09:55:12.397Z"
Example:
"2025-04-04T09:55:12.422Z"