get_suprsend_user_preferences
Read a user's category-level notification preferences, including optional per-channel overrides, to check opt-in status and delivery permissions.
Instructions
Read a user's category-level notification preferences and (optionally) per-channel overrides.
When to use:
Before update_suprsend_users_preferences, to read current state.
The user asks what categories a recipient is opted in/out of.
Before sending, to check delivery permission for a category or channel.
When NOT to use:
For the user's identity or channel identifiers — use get_suprsend_user.
For tenant-level defaults — use get_tenant_default_preference.
For object preferences — use get_suprsend_object_preferences.
Returns: the user's preference tree. Pass category to scope to one preference; omit for the full tree. Set channel_preferences=true to include per-channel overrides.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | The category_slug of a category to get. | |
| channel_preferences | No | Whether to include channel preferences in the response. Default is false. | |
| distinct_id | Yes | The distinct_id of the user to get the preferences for. | |
| tenant_id | No | The tenant_id of the tenant to get the preferences for. | |
| workspace | No | SuprSend workspace to get the user from. |