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

    Update an HMS push configuration

    Updates a specific HMS (Huawei Mobile Services) push configuration for client apps. You can also update the configurations on the Sendbird Dashboard under Settings > Chat > Notifications.


    HTTP request

    PUT https://api-{application_id}.sendbird.com/v3/applications/push/hms/{provider_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    provider_id

    string

    Specifies the provider ID of the push configuration.


    Request body

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

    Optional
    Property nameTypeDescription

    huawei_app_id

    string

    Specifies the unique ID of the application for HMS to update.

    huawei_app_secret

    string

    Specifies the secret key of the application to update.

    push_sound

    string

    Specifies the name of a sound file to be played when a push notification is delivered to client apps. The file should be located in the /res/raw folder.


    Response

    If successful, this action returns the information about the updated HMS push configuration in the response body.

    {
        "push_configurations": "e58833c983kkb3918d0799e6247b24f89fd408944e2"
    }
    
    Property nameTypeDescription

    push_configurations

    string

    A unique provider ID of the updated push configuration.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.