update_suprsend_tenant_default_preference
Sets the default category preference inherited by new users created in a tenant. Existing users are not affected.
Instructions
Set the default category preference inherited by NEW users created in this tenant. Existing users are not affected; their preferences are independent.
preference values:
opt_in — new users are opted into this category.
opt_out — new users are opted out.
cant_unsubscribe — new users are opted in AND locked from toggling.
mandatory_channels — channels users cannot disable for this category. blocked_channels — channels that cannot be enabled. visible_to_subscriber — whether end-users see this category in their preference UI.
When NOT to use:
For per-user overrides — use update_suprsend_users_preferences.
For per-object overrides — use update_suprsend_category_preference_object.
Side effects: changes apply only to users created AFTER this call. To retroactively update existing users, call update_suprsend_users_preferences per user.
Returns: the updated tenant default preference on success.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | Yes | category_slug of an category to update. | |
| tenant_id | Yes | The tenant_id of the tenant to update. | |
| workspace | No | SuprSend workspace to update the tenant from. | |
| preference | Yes | The preference to update for the tenant. | |
| blocked_channels | Yes | The channels to block for the category. | |
| mandatory_channels | Yes | The channels to make mandatory for the category. | |
| visible_to_subscriber | Yes | Whether the category is visible to subscribers. |