core-utils
    Preparing search index...

    Interface UpsertUserPreferencesRequest

    Request parameters for upserting user notification preferences.

    When one of the fields is null, the preferences is cleared and Knock will fall back to default preferences. The fields are optional, so that we can support partial updates.

    interface UpsertUserPreferencesRequest {
        categories?: Record<string, boolean | PreferenceOverrides> | null;
        channels?: Record<string, boolean> | null;
        channelTypes?: ChannelTypePreferences | null;
        commercialSubscribed?: boolean | null;
        userId: string;
        workflows?: Record<string, boolean | PreferenceOverrides> | null;
    }
    Index

    Properties

    categories? channels? channelTypes? commercialSubscribed? userId workflows?

    Properties

    categories?: Record<string, boolean | PreferenceOverrides> | null

    Category-specific overrides keyed by category names.

    channels?: Record<string, boolean> | null

    Channel-specific overrides.

    channelTypes?: ChannelTypePreferences | null

    Channel type-specific preferences.

    commercialSubscribed?: boolean | null

    Whether the user opted-out from broadcast notification.

    userId: string

    The user's unique identifier.

    workflows?: Record<string, boolean | PreferenceOverrides> | null

    Workflow-specific overrides keyed by workflow IDs.

    Settings

    Member Visibility

    On This Page

    Properties