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

    Choose a push notification content template

    You can choose a template for notifications to decide how the notifications will show to users. Push notification content templates are pre-formatted forms that can be customized to display your own push notification messages on a user's device. Sendbird provides two types: default and alternative. Go to Settings > Application > Notifications > Push notification content templates on Sendbird Dashboard to customize templates.

    Note: Push notifications are only available for group channels.


    HTTP request

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

    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.

    Properties
    RequiredTypeDescription

    name

    string

    Specifies the name of a template used for notifications. Acceptable values are default and alternative. (Default: default)

    {
        "name": "alternative"
    }
    

    Responses

    If successful, this action returns the name of a chosen notifications content template in the 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
    }