Skip to main content

Chat / Platform API

Current version: v3

Overview
Prepare to use API
- User
- Overview
- - Listing users
  - List users
  - View 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
  - Leave group channels
- - Retrieving group channel count
  - View number of channels by join status
- - Marking messages as read
  - Mark all of a user's messages as read
- - Managing metadata
  - View metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Channel
- Overview
- - Listing channels in an application
  - List open channels
  - View an open channel
  - List group channels
  - View 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
  - View metacounter
  - Create metacounter
  - Update metacounter
  - Delete metacounter
- - Managing metadata
  - View metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Message
- Overview
- - Message threading
  - Overview
  - List threaded replies of a parent message
  - View a reply
  - View thread information
  - Reply to a message
  - Delete a reply
- - Message search
  - Overview
  - Search a message
- - Migration
  - Overview
  - Migrate messages
- - Delivery receipts
  - Overview
  - Mark all messages as delivered
- - Read receipts
  - Overview
  - View number of unread messages per member
  - Mark all messages as read
- - Translations
  - Overview
  - Translate a message into other languages
  - Translation engine
- Application
- Overview
- - Setting up an application
  - View global application settings
  - Update global application settings
- - Managing API tokens
  - List secondary API tokens
  - View a secondary API token
  - Generate a secondary API token
  - Revoke a secondary API token
- - Managing IP whitelist
  - Retrieve 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
  - View an application
  - Create an application
  - Delete an application
  - Copy application settings
- - Managing features
  - List features
  - Update a feature
- - Managing members
  - List members
  - View a member
  - Update a member
  - Deactivate a member
- - Managing roles
  - List predefined roles
  - List custom roles
- Statistics
- Overview
- - Advanced analytics
  - Retrieve advanced analytics metrics
- - Concurrent connections
  - View number of concurrent connections
- - DAUs & MAUs
  - View number of daily active users
  - View number of monthly active users
- - Peak connections
  - View number of peak connections
- Data export
- Overview
- - Listing data exports
  - List data exports by message, channel, or user
  - View a data export
- - Scheduling data exports
  - Register and schedule a data export
- Bot
- Overview
- - Listing bots
  - List bots
  - View 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
  - Retrieve a list of subscribed events
  - Choose events to subscribe
- Privacy
- Overview
- - Listing GDPR requests
  - List GDPR requests
  - View 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

Home

/

Chat

/

Platform API

Delete metadata

Deletes a specific item or all items of the metadata of a user.

HTTP request

// When deleting all items of the user metadata
DELETE https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata

// When deleting a specific item by its key of the user metadata
DELETE https://api-{application_id}.sendbird.com/v3/users/{user_id}/metadata/{key}

Parameters

The following table lists the parameters that this action supports.

Parameters

Required	Type	Description
user_id	string	Specifies the unique ID of a user.

Optional	Type	Description
key	string	Specifies the key of a metadata item. If not specified, all items of the metadata are deleted. If specified, only the item that has the specified value is deleted. Urlencoding a key is recommended.

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.