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 inbox identifiers
List of Android Push tokens
List of iOS Push tokens
Slack channel configuration
- Slack using email
- Slack using member ID
- Slack using channel
- Slack using incoming webhook
Microsoft Teams channel configuration
- MS Teams using conversation ID
- MS Teams using user ID
- MS Teams using incoming webhook
User's timezone in IANA format
"America/New_York"
Preferred language in ISO 639-1 Alpha-2 format
"en"
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 $
"2025-04-04T09:55:12.397Z"
"2025-04-04T09:55:12.422Z"