Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    User

    Update push notification preferences

    You can update a user's notifications preferences. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background.


    HTTP request

    PUT https://api-{application_id}.sendbird.com/v3/users/{user_id}/push_preference
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    NameTypeDescription

    user_id

    string

    Specifies the unique ID of a user.


    Request body

    The following table lists the properties of an HTTP request that this action supports.

    Optional
    Property nameTypeDescription

    push_trigger_option

    string

    The type of notification trigger applies to group channels when a user is disconnected from Sendbird server. Valid values are the following:
    - all (default): Indicates that a user receives notifications for all new messages.
    - mention_only: Indicates that a user only receives notifications for mentioned messages.
    - off: Indicates that a user doesn't receive any notifications.

    do_not_disturb

    boolean

    Indicates whether to repeatedly pause notifications for a set period of time on a daily basis. (Default: false)

    start_hour

    int

    The start hour for pausing notifications when do_not_disturb is set to true.

    start_min

    int

    The start minute for pausing notifications when do_not_disturb is set to true.

    end_hour

    int

    The end hour for pausing notifications when do_not_disturb is set to true.

    end_min

    int

    The end minute for pausing notifications when do_not_disturb is set to true.

    snooze_enabled

    boolean

    Indicates whether to snooze notifications for a set period of time. (Default: false)

    snooze_start_ts

    long

    The timestamp when snoozing notifications starts in Unix milliseconds.

    snooze_end_ts

    long

    The timestamp when snoozing notifications ends in Unix milliseconds.

    push_blocked_bot_ids

    array of strings

    Specifies an array of one or more unique IDs of bots whose notifications a user paused. This property is effective only when block_push_from_bots is set to true.

    block_push_from_bots

    boolean

    Determines whether to block notifications from all bots within the application. If the unique IDs of bots are specified in push_blocked_bot_ids, the notifications from the bots specified in the property are paused. (Default: false)

    timezone

    string

    The timezone applied when setting preferences for notifications. Valid values include UTC, Asia/Seoul, Europe/London, etc. (Default: UTC

    push_sound

    string

    The name of a sound file played when a notification is delivered to a client app.

    {
        "do_not_disturb": true,
        "start_hour": 17,
        "start_min": 30,
        "end_hour": 22,
        "end_min": 00,
        "snooze_enabled": true,
        "snooze_start_ts": 1523523600000,
        "snooze_end_ts": 1523525400000,
        "timezone": "Asia/Seoul",
        "push_sound": "bell_ring.swf"
    }
    

    Responses

    If successful, this action returns the notifications preferences of a user in the response body.

    {
        "push_trigger_option": "all",   
        "do_not_disturb": true,
        "start_hour": 17,
        "start_min": 30,
        "end_hour": 22,
        "end_min": 00,
        "snooze_enabled": true,
        "snooze_start_ts": 1523523600000,
        "snooze_end_ts": 1523525400000,
        "timezone": "Asia/Seoul",
        "push_sound": "bell_ring.swf"
    }
    

    List of response properties

    Property nameTypeDescription

    push_trigger_option

    string

    The type of notifications trigger applies to group channels when the user is disconnected from Sendbird server. Valid values are the following:
    - all: Indicates that the user receives notifications for all new messages.
    - mention_only: Indicates that the user only receives notifications for mentioned messages.
    - off: Indicates that the user doesn't receive any notifications. (Default: all)

    do_not_disturb

    boolean

    Indicates whether to repeatedly pause notifications for a set period of time on a daily basis. (Default: false)

    start_hour

    int

    The start hour for pausing notifications when do_not_disturb is set to true.

    start_min

    int

    The start minute for pausing notifications when do_not_disturb is set to true.

    end_hour

    int

    The end hour for pausing notifications when do_not_disturb is set to true.

    end_min

    int

    The end minute for pausing notifications when do_not_disturb is set to true.

    snooze_enabled

    boolean

    Indicates whether to snooze notifications for a set period of time. (Default: false)

    snooze_start_ts

    long

    The timestamp when snoozing notifications starts, in Unix milliseconds.

    snooze_end_ts

    long

    The timestamp when snoozing notifications ends, in Unix milliseconds.

    timezone

    string

    The timezone applied when setting preferences for notifications. Valid values include UTC, Asia/Seoul, Europe/London, etc. (Default: UTC)

    push_sound

    string

    The name of the sound file played when a notification is delivered to a client app.

    Error

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "\"User\" not found.",
        "code": 400201,
        "error": true
    }