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

    Mark all messages as read

    Marks all messages in a group channel as read for a specific user. This action is only applicable for users in a group channel.


    HTTP request

    PUT https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/messages/mark_as_read
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_url

    string

    Specifies the URL of the target channel.


    Request body

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

    Properties
    RequiredTypeDescription

    user_id

    string

    Specifies the ID of the target user.

    OptionalTypeDescription

    timestamp

    long

    Specifies the timestamp to be the reference point of marking as read. If specified, the messages received before the specified time are marked as read.

    {
        "user_id": "Justin"
    }
    

    Response

    If successful, this action returns an empty response body.

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