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

    Add emojis

    Adds an array of new emojis to the application.


    HTTP request

    POST https://api-{application_id}.sendbird.com/v3/emojis
    

    Request body

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

    Required
    Property nameTypeDescription

    emoji_category_id

    int

    Specifies the unique ID of the emoji category that a list of new emojis belongs to.

    emojis[]

    array of objects

    Specifies an array of new emojis to register.

    (emoji).key

    string

    Specifies the string key of each new emoji.

    (emoji).url

    string

    Specifies the image URL of each new emoji.

    {
        "emoji_category_id": 1,
        "emojis": [
            {
                "key": "blowing_a_kiss",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f618.png"
            },
            {
                "key": "wink",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f609.png"
            },
            {
                "key": "tears_of_joy",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f602.png"
            }
        ]
    }
    

    Response

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

    {
        "emojis": [
            {
                "id": 103964,
                "key": "blowing_a_kiss",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f618.png"
            },
            {
                "id": 103965,
                "key": "wink",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f609.png"
            },
            {
                "id": 103966,
                "key": "tears_of_joy",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f602.png"
            }
        ]
    }
    

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