Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Single Category

API to fetch user preferences for a given category.

get/v1/user/{distinct_id}/preference/category/{category_slug}/

Path parameters

distinct_idstring required

distinct_id of the user whose preferences should be fetched

category_slugstring required

notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page

Query parameters

tenant_idstring

to fetch user preferences for a particular tenant

show_opt_out_channelsboolean

set this flag to true if you want to fetch channel list for opt-out categories.

localestring

Locale code (e.g., es, fr, de, ja, es-AR) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file. If a translation is missing for the requested locale, the system automatically falls back in this order: locale-region (e.g., es-AR) → locale (e.g., es) → en (English - always available).

Response

200

namestring

name of the notification category

categorystring

category slug identifier

descriptionstring

description of the notification category

original_preferencestring nullable

default preference of the category

preferencestring

updated user preference of the category

is_editableboolean

false when category default preference is set to can't unsubscribe

Example response

{
  "name": "Newsletter",
  "category": "newsletter",
  "description": "Send me updates on new product updates",
  "preference": "opt_in",
  "channels": [
    {
      "channel": "email",
      "preference": "opt_in"
    }
  ]
}