/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Choose a push notification content template

    Copy link

    Users can choose a template to determine how push notifications appear to them. 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 > Chat > Push notifications > Push notification content templates on Sendbird Dashboard to customize the templates.

    If the push_message_template property is specified when sending a message, the content template customized for the message takes precedence over the user's choice.

    Note: Push notifications are only available for group channels.


    HTTP request

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

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Required
    NameTypeDescription

    user_id

    string

    Specifies the unique ID of a user.


    Request body

    Copy link

    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

    Copy link

    If successful, this action returns the name of a chosen notifications content template in the response body.

    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
    }