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
notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page
Query Parameters
to fetch user preferences for a particular tenant
Body
choose one of the options: opt_in
if the user has allowed notification in this category and opt_out
if user wants to discontinue notification in this category
Add array of channels if user wants to unsubscribe from particular channels in this category. Add channels as email
, sms
, whatsapp,
androidpush,
inbox,
iospush,
slack,
webpush`
Response
202
preference category name
"Status Update Alert"
unique preference category slug. You can get this by clicking on preference category name on Developers -> Preference categories page.
"status-update-alert"
"Send me updates when account status changes"
default preference of the category
opt_in
, opt_out
"opt_in"
final user preference of the category
opt_in
, opt_out
"opt_in"
false for categories where default preference is set to can't unsubscribe
false