Skip to main content

Chat / Platform API

Overview
Prepare to use API
- User
- Overview
- - Listing users
  - List users
  - Get a user
- - Creating users
  - Create a user
- - Managing users
  - Update a user
  - Delete a user
- - Managing session tokens
  - Issue a session token
  - Revoke all session tokens
- - Managing joined group channels
  - List group channels by user
  - Leave group channels
- - Getting group channel count
  - Get number of channels by join status
- - Marking messages as read
  - Mark all of a user's messages as read
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Channel
- Overview
- - Listing channels in an application
  - List open channels
  - Get an open channel
  - List group channels
  - Get a group channel
- - Creating a channel
  - Create an open channel
  - Create a group channel
- - Inviting a user
  - Invite as members
  - Accept an invitation
  - Decline an invitation
- - Managing metacounter
  - Get metacounter
  - Create metacounter
  - Update metacounter
  - Delete metacounter
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Message
- Overview
- - Delivery receipts
  - Overview
  - Mark all messages as delivered
- - Message search
  - Overview
  - Search messages
- - Message threading
  - Overview
  - List threaded replies of a parent message
  - Get a reply
  - Get thread information
  - Reply to a message
  - Delete a reply
- - Migration
  - Overview
  - Migrate messages
- - Read receipts
  - Overview
  - Get number of unread messages per member
  - Mark all messages as read
- - Translations
  - Overview
  - Translate a message into other languages
  - Translation engine
- - Typing indicators
  - Overview
  - Start typing indicators
  - Stop typing indicators
- Application
- Overview
- - Setting up an application
  - Get global application settings
  - Update global application settings
- - Managing API tokens
  - List secondary API tokens
  - Get a secondary API token
  - Generate a secondary API token
  - Revoke a secondary API token
- - Managing IP whitelist
  - Get an IP whitelist
  - Add an IP to a whitelist
  - Delete IPs from a whitelist
- - Managing auto event messages
  - List auto event messages
  - Configure auto event message settings
- - Understanding rate limits
  - Rate limits
- Organization
- Overview
- - Managing application
  - List applications
  - Get an application
  - Create an application
  - Delete an application
  - Copy application settings
- - Managing features
  - List features
  - Update a feature
- - Managing members
  - List members
  - Get a member
  - Update a member
  - Deactivate a member
- - Managing roles
  - List predefined roles
  - List custom roles
- Statistics
- Overview
- - Advanced analytics
  - Get advanced analytics metrics
- - Concurrent connections
  - Get number of concurrent connections
- - DAUs & MAUs
  - Get number of daily active users
  - Get number of monthly active users
- - Peak connections
  - Get number of peak connections
- Data export
- Overview
- - Listing data exports
  - List data exports by message, channel, or user
  - Get a data export
- - Scheduling data exports
  - Register and schedule a data export
- Bot
- Overview
- - Listing bots
  - List bots
  - Get a bot
- - Creating a bot
  - Create a bot
- - Sending a bot message
  - Send a bot message
- - Managing a bot
  - Update a bot
  - Join channels
  - Leave channels
  - Delete a bot
- Report
- Overview
- - Creating a report
  - Report a user
  - Report a channel
  - Report a message
- Webhook
- Overview
- - Managing subscribed events
  - Get a list of subscribed events
  - Choose events to subscribe
- Privacy
- Overview
- - Listing GDPR requests
  - List GDPR requests
  - Get a GDPR request
- - Creating a GDPR request
  - Register a GDPR request
- - Managing GDPR requests
  - Cancel the registration of a GDPR request
Deprecated
Error codes

Chat Platform API v3

Chat Platform API

Chat

Platform API

Version 3

Home

/

Chat

/

Platform API

/

Message

Add metadata

Adds key-values items to store additional information for a message.

HTTP request

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

Parameters

The following table lists the parameters that this action supports.

Required

Parameter name	Type	Description
channel_type	string	Specifies the type of the channel. Acceptable values are open_channels and group_channels.
channel_url	string	Specifies the URL of the target channel.
message_id	long	Specifies the unique ID of the message to add key-values items for additional information.

Request body

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

Required

Property name	Type	Description
sorted_metaarray	array of objects	Specifies an array of one or more `JSON` objects consisting of key-values items to store additional message information. Items are saved and returned in the order they've been specified.
~~metaarray~~	array of objects	*(Deprecated)* Specifies an array of one or more `JSON` objects consisting of key-values items to store additional message information.

Request body example

{
    "sorted_metaarray": [
        {
            "key": "beverages",
            "value": ["water", "milk", "coffee"]
        }
    ]
}

Response

If successful, this action returns all registered items including the key and values of added items in the response body.

Request body example

{
    "sorted_metaarray": [
        {
            "key": "places",
            "value": ["office", "cafe", "restaurant"]
        },
        {
            "key": "beverages",
            "value": ["water", "milk", "coffee"] // Newly added key-values item
        }
    ]
}

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

Try API requests