Get push notification preferences

You can retrieve a user's push notification 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.

Note: Push notifications are only available for group channels.

HTTP request

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

Parameters

The following table lists the parameters that this action supports.

Required

Name	Type	Description
user_id	string	Specifies the unique ID of a user.

Responses

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

Status: 200 OK

{
    "push_trigger_option": "all",   # default
    "do_not_disturb": false,        # default
    "start_hour": 0,
    "start_min": 0,
    "end_hour": 0,
    "end_min": 0,
    "snooze_enabled": false,        # default
    "snooze_start_ts": 0,
    "snooze_end_ts": 0,
    "timezone": "UTC",              # default
    "push_sound": "default",
    "dnd_schedules": []
}

List of response properties

Property name	Type	Description
push_trigger_option	string	The type of notification trigger that applies to group channels when the user is disconnected from the Sendbird server. Valid values are the following: - `all` (default): 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.
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.
dnd_schedules	array of objects	An array of day-of-week DND schedule objects. Each object contains a day and its time windows. If empty, the legacy DND setting applies instead.
dnd_schedules[].day_of_week	string	The day of the week. Valid values are `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, and `sunday`.
dnd_schedules[].time_windows	array of objects	An array of time window objects for the given day. Cross-midnight windows are split into separate day entries.
dnd_schedules[].time_windows[].start_hour	int	The start hour of the DND window in 24-hour format.
dnd_schedules[].time_windows[].start_min	int	The start minute of the DND window.
dnd_schedules[].time_windows[].end_hour	int	The end hour of the DND window in 24-hour format.
dnd_schedules[].time_windows[].end_min	int	The end minute of the DND window.

Note: If only legacy DND is configured, the server converts it to dnd_schedules format in the response.

Error

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

Status: 400 Bad Request

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

On this page

HTTP request Parameters Responses

Error