get_suprsend_object_preferences
Read-onlyDestructiveIdempotent
Read an object's notification preferences by category, with optional per-channel overrides. Use before updating preferences or checking delivery permissions.
Instructions
Read an object's category-level notification preferences and (optionally) per-channel overrides.
When to use:
Before update_suprsend_category_preference_object, to read current state.
Before sending to an object, to check delivery permission.
When NOT to use:
For the object's identity or channels — use get_suprsend_object.
For users — use get_suprsend_user_preferences.
Returns: the object'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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | The category_slug of the object to get preferences from, if not provided, it will get all the preferences for the object. | |
| channel_preferences | No | set this to true to get all the channel preferences for the object. | |
| object_id | Yes | The object_id of the object to get preferences from. | |
| object_type | Yes | The object_type of the object to get preferences from. | |
| workspace | No | SuprSend workspace to get the user from. |