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

    Reset push notification preferences

    You can reset a user's notifications preferences. The values are reset to the default as the following.

    • The values for the do_not_disturb and snooze_enabled properties are set to false.
    • The values of the parameters associated with the time frame are all set to 0.
    • The value for the timezone property is set to UTC.
    • The value for the push_sound property is set to default.

    HTTP request

    DELETE 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.


    Responses

    If successful, this action returns an empty response body.

    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
    }