update_suprsend_user_channel_preference
Block or allow specific delivery channels for a user across all categories. Use to restrict or re-enable channels like SMS or email.
Instructions
Block or allow specific delivery channels for ONE user, applied across ALL categories. Use this for "block all SMS to this user" or "allow only email" patterns.
is_restricted semantics: true blocks delivery on that channel; false re-enables it. Each entry in channel_preferences is a {channel, is_restricted} pair.
When NOT to use:
For per-category control — use update_suprsend_users_preferences.
For permanent invalidation (e.g., a bounced email) — that's set by SuprSend automatically as perma_status; don't try to override it here.
For objects — use update_suprsend_object_channel_preference.
Side effects: takes effect on the next workflow run; in-flight notifications already in the queue may still send.
Returns: updated channel-preference state on success.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel_preferences | Yes | The channel preferences to update for the users. | |
| distinct_id | Yes | The distinct_id of the user to update the channel preference for. | |
| workspace | No | SuprSend workspace to update the channel preference for. |