Create / Update Objects
API to upsert (create if not exists, update if exists) object by providing a unique object ID and type.
Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
Unique identifier of the object in your system
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
Body
List of email addresses.
List of phone numbers for SMS
List of phone numbers for WhatsApp
List of Android Push tokens
List of iOS Push tokens
Slack channel configuration
Microsoft Teams channel configuration
Object's timezone in IANA format
"America/New_York"
Object's locale for translating template content in SuprSend.
"en_GB"
Response
201 - Created
unique identifier of the object
"engineering"
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
"departments"
number of users/child objects subscribed to the object
"departments"
all user properties in key-value pair. SuprSend reserved properties start with $
Timestamp when the object was created.
"2025-04-04T09:55:12.397Z"
Timestamp when the object was last updated.
"2025-04-04T09:55:12.422Z"
List of active communication channels for the object.