/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    Add emoji categories

    Copy link

    This action adds new emoji categories to your Sendbird application.

    HTTP request

    Copy link
    POST  https://api-{application_id}.sendbird.com/v3/emoji_categories

    Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with https://api-{application_id}.svc.delight.ai/v3 instead of https://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.

    Request body

    Copy link

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

    Required
    Property nameTypeDescription

    emoji_categories[]

    array of objects

    Specifies an array of emoji categories to register to your application.

    (emoji_category).name

    string

    Specifies the name of the emoji category.

    (emoji_category).url

    string

    Specifies the URL of the emoji category's image. Setting a representative image of an emoji category can help users understand what emojis may be included in the category.

    {
    "emoji_categories": [
        {
            "name": "nature",
            "url": "http://emojicategory.com/nature_category_icon.png"
        },
        {
            "name": "animal",
            "url": "http://emojicategory.com/animal_category_icon.png"
        }
    ]
}

    Responses

    Copy link

    If successful, this action returns an array of the newly added emoji category resources in the response body.

    {
    "emoji_categories": [
        {
            "id": 587,
            "name": "nature",
            "url": "http://emojicategory.com/nature_category"
        },
        {
            "id": 588,
            "name": "animal",
            "url": "http://emojicategory.com/animal_category"
        }
    ]
}

    Error

    Copy link

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
    "message": "\"\" must have valid URL form",
    "code": 400114,
    "error": true
}
    On this page
    HTTP requestRequest bodyResponses
    Error