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

    Report a message

    Reports a message considered suspicious, harassing, inappropriate, or spam.


    HTTP request

    POST https://api-{application_id}.sendbird.com/v3/report/{channel_type}/{channel_url}/messages/{message_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    channel_type

    string

    Specifies the type of channel. Acceptable values are open_channels and group_channels.

    channel_url

    string

    Specifies the URL of a channel.

    message_id

    string

    Specifies the unique ID of the message.


    Request body

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

    Properties
    RequiredTypeDescription

    report_category

    string

    Specifies the category which indicates the reason for reporting. Acceptable values are suspicious, harassing, inappropriate, spam, and custom. If this property is set to custom, the custom_report_category_name must be specified.

    offending_user_id

    string

    Specifies the unique ID of a user who has sent an offensive message.

    OptionalTypeDescription

    reporting_user_id

    string

    Specifies the unique ID of the user who reports a message.

    report_description

    string

    Specifies additional information to include in the report.

    custom_report_category_name

    string

    Specifies the name of the custom report category. Maximum length is 50 characters.

    {
        "report_category": "suspicious",
        "offending_user_id": "Julie",
        "reporting_user_id": "Simon"
    }
    

    Response

    If successful, this action returns a report resource on the message in the response body.

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