Introduction - Sendbird Platform API Documentation

Introduction Ask Anything

Business messaging

Send a batch notification Genereate a pre-signed URL List target files

List users for Calls Retrieve a list of a user's calls Retrieve a user's call summary Retrieve a list of a user's push tokens Add a registration or device token Remove a user's push token Remove a certain type of push tokens

Retrieve a list of direct calls Retrieve a direct call Update custom items of a direct call Delete custom items of a direct call

Create a room Retrieve a list of rooms Retrieve a room Retrieve a list of participants within the room

Choose which events to subscribe to Retrieve a list of subscribed events

View an announcement Get detailed open rate of an announcement Get detailed open status of an announcement Get detailed open rate of an announcement group

List muted users in channels with a custom channel type Mute users in channels with a custom channel type Unmute users in channels with a custom channel type List banned users in channels with a custom channel type Ban users in channels with a custom channel type Unban users in channels with a custom channel type Message moderation Add a FCM push configuration Add an HMS push configuration Add an APNs push configuration List push notification content templates View default channel invitation preference Update default channel invitation preference Retrieve an IP whitelist Add an IP to a whitelist Delete allowed IPs from a whitelist View a secondary API token Revoke a secondary API token List secondary API tokens Generate a secondary API token List push configurations View a push configuration Remove a push configuration Update a FCM push configuration Update an HMS push configuration Update an APNs push configuration Delete an APNs certificate View a push notification content template Update a push notification content template

Create a bot List bots View a bot Update a bot Delete a bot Join channels Leave channels - When leaving all channels Send a bot's message Leave channels - When leaving a channel by its channel URL

List data exports by message, channel, or user Register and schedule a data export View a data export

Create a channel List channels View a channel Update a channel Delete a channel List members Check if member Invite as members Accept an invitation Decline an invitation Join a channel Leave a channel Hide or archive a channel Unhide or unarchive a channel Reset chat history List operators Register operators Cancel the registration of operators

Schedule an announcement List announcements Update an announcement Get statistics - daily Get statistics - weekly Get statistics - monthly List announcement groups List messages Send a message View a message Update a message Delete a message View total number of messages in a channel View number of each member's unread messages Mark all messages as delivered Mark all messages as read Enable reactions List reactions of a message Add a reaction to a message Remove a reaction from a message Add extra data to a message Update extra data in a message Remove extra data from a message Translate a message into other languages Use default emojis List all emojis and emoji categories Add emoji categories List emojis Add emojis Get an emoji category Update an emoji category URL Delete an emoji category Get an emoji Update an emoji URL Delete an emoji Migrate messages

List banned channels Ban from channels with custom channel types List muted channels Mute in channels with custom channel types List blocked users Block a user Unblock a user Mute a user List muted users Freeze a channel List banned users Ban a user View a ban Update a ban Unban a user View a mute Unmute a user Freeze a channel List banned users Ban a user View a ban Update a ban Unban a user List muted users Mute a user View a mute Unmute a user

Create a channel List channels View a channel Update a channel Delete a channel List participants List operators Register operators Cancel the registration of operators

Register a GDPR request List GDPR requests View a GDPR request Cancel the registration of a GDPR request

List reports List reports on a message Report a message List reports on a user Report a user List reports on a channel Report a channel View a moderated message

View number of concurrent connections View number of peak connections View number of monthly active users View number of daily active users Retrieve Advanced analytics metrics

Create a user List users View channel invitation preference Update channel invitation preference View a user Update a user Delete a user List my group channels Leave my group channels View number of unread messages View number of unread items View number of channels with unread messages View number of channels by join status View count preference of a channel Update count preference of a channel Mark all messages as read Register as an operator to channels with custom channel types List registration or device tokens Add a registration or device token Remove a registration or device token - When unregistering a specific token Remove a registration or device token - When unregistering all device tokens View who owns a registration or device token Remove a registration or device token from an owner View push preferences Update push preferences Reset push preferences View push preferences for a channel Update push preferences for a channel Choose a push notification content template

Choose which events to subscribe to Retrieve a list of subscribed events

View a user metadata - When retrieving all items of a user metadata Create a user metadata Update a user metadata - When updating existing items of a user metadata by their keys or adding new items to the metadata Delete a user metadata - When deleting all items of a user metadata View a user metadata - When retrieving a specific item of a user metadata by its key Update a user metadata - When updating a specific item of a user metadata by its key Delete a user metadata - When deleting a specific item of a user metadata by its key View a channel metadata - When retrieving all items of a channel metadata Create a channel metadata Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata Delete a channel metadata - When deleting all items of a channel metadata View a channel metadata - When retrieving a specific item of a channel metadata by its key Update a channel metadata - When updating a specific item of a channel metadata by its key Delete a channel metadata - When deleting a specific item of a channel metadata by its key View a channel metacounter - When retrieving all items of a channel metacounter Create a channel metacounter Update a channel metacounter - When updating existing items of a channel metacounter by their keys or adding new items to the metacounter Delete a channel metacounter - When deleting all items of a channel metacounter View a channel metacounter - When retrieving a specific item of a channel metacounter by its key Update a channel metacounter - When updating a specific item of a channel metacounter by its key Delete a channel metacounter - When deleting a specific item of a channel metacounter by its key

Update a project

List agents View an agent Update the connection status of an agent Cancel assignments Retrieve a list of an agent's connection logs Get number of an agent’s assigned tickets Get number of an agent’s closed tickets

List bots View a bot Update a bot Send a bot's message Get a bot's webhook logs

Create a customer List customers View a customer Update custom fields of a customer

Create a ticket Transfer tickets to a group List tickets View a ticket Update a ticket Update custom fields of a ticket Close a ticket Cancel assignment of a ticket

List groups View a group Add a member Remove a member

Introduction Ask Anything

Business messaging

Send a batch notification Genereate a pre-signed URL List target files

List users for Calls Retrieve a list of a user's calls Retrieve a user's call summary Retrieve a list of a user's push tokens Add a registration or device token Remove a user's push token Remove a certain type of push tokens

Retrieve a list of direct calls Retrieve a direct call Update custom items of a direct call Delete custom items of a direct call

Create a room Retrieve a list of rooms Retrieve a room Retrieve a list of participants within the room

Choose which events to subscribe to Retrieve a list of subscribed events

View an announcement Get detailed open rate of an announcement Get detailed open status of an announcement Get detailed open rate of an announcement group

List muted users in channels with a custom channel type Mute users in channels with a custom channel type Unmute users in channels with a custom channel type List banned users in channels with a custom channel type Ban users in channels with a custom channel type Unban users in channels with a custom channel type Message moderation Add a FCM push configuration Add an HMS push configuration Add an APNs push configuration List push notification content templates View default channel invitation preference Update default channel invitation preference Retrieve an IP whitelist Add an IP to a whitelist Delete allowed IPs from a whitelist View a secondary API token Revoke a secondary API token List secondary API tokens Generate a secondary API token List push configurations View a push configuration Remove a push configuration Update a FCM push configuration Update an HMS push configuration Update an APNs push configuration Delete an APNs certificate View a push notification content template Update a push notification content template

Create a bot List bots View a bot Update a bot Delete a bot Join channels Leave channels - When leaving all channels Send a bot's message Leave channels - When leaving a channel by its channel URL

List data exports by message, channel, or user Register and schedule a data export View a data export

Create a channel List channels View a channel Update a channel Delete a channel List members Check if member Invite as members Accept an invitation Decline an invitation Join a channel Leave a channel Hide or archive a channel Unhide or unarchive a channel Reset chat history List operators Register operators Cancel the registration of operators

Schedule an announcement List announcements Update an announcement Get statistics - daily Get statistics - weekly Get statistics - monthly List announcement groups List messages Send a message View a message Update a message Delete a message View total number of messages in a channel View number of each member's unread messages Mark all messages as delivered Mark all messages as read Enable reactions List reactions of a message Add a reaction to a message Remove a reaction from a message Add extra data to a message Update extra data in a message Remove extra data from a message Translate a message into other languages Use default emojis List all emojis and emoji categories Add emoji categories List emojis Add emojis Get an emoji category Update an emoji category URL Delete an emoji category Get an emoji Update an emoji URL Delete an emoji Migrate messages

List banned channels Ban from channels with custom channel types List muted channels Mute in channels with custom channel types List blocked users Block a user Unblock a user Mute a user List muted users Freeze a channel List banned users Ban a user View a ban Update a ban Unban a user View a mute Unmute a user Freeze a channel List banned users Ban a user View a ban Update a ban Unban a user List muted users Mute a user View a mute Unmute a user

Create a channel List channels View a channel Update a channel Delete a channel List participants List operators Register operators Cancel the registration of operators

Register a GDPR request List GDPR requests View a GDPR request Cancel the registration of a GDPR request

List reports List reports on a message Report a message List reports on a user Report a user List reports on a channel Report a channel View a moderated message

View number of concurrent connections View number of peak connections View number of monthly active users View number of daily active users Retrieve Advanced analytics metrics

Create a user List users View channel invitation preference Update channel invitation preference View a user Update a user Delete a user List my group channels Leave my group channels View number of unread messages View number of unread items View number of channels with unread messages View number of channels by join status View count preference of a channel Update count preference of a channel Mark all messages as read Register as an operator to channels with custom channel types List registration or device tokens Add a registration or device token Remove a registration or device token - When unregistering a specific token Remove a registration or device token - When unregistering all device tokens View who owns a registration or device token Remove a registration or device token from an owner View push preferences Update push preferences Reset push preferences View push preferences for a channel Update push preferences for a channel Choose a push notification content template

Choose which events to subscribe to Retrieve a list of subscribed events

View a user metadata - When retrieving all items of a user metadata Create a user metadata Update a user metadata - When updating existing items of a user metadata by their keys or adding new items to the metadata Delete a user metadata - When deleting all items of a user metadata View a user metadata - When retrieving a specific item of a user metadata by its key Update a user metadata - When updating a specific item of a user metadata by its key Delete a user metadata - When deleting a specific item of a user metadata by its key View a channel metadata - When retrieving all items of a channel metadata Create a channel metadata Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata Delete a channel metadata - When deleting all items of a channel metadata View a channel metadata - When retrieving a specific item of a channel metadata by its key Update a channel metadata - When updating a specific item of a channel metadata by its key Delete a channel metadata - When deleting a specific item of a channel metadata by its key View a channel metacounter - When retrieving all items of a channel metacounter Create a channel metacounter Update a channel metacounter - When updating existing items of a channel metacounter by their keys or adding new items to the metacounter Delete a channel metacounter - When deleting all items of a channel metacounter View a channel metacounter - When retrieving a specific item of a channel metacounter by its key Update a channel metacounter - When updating a specific item of a channel metacounter by its key Delete a channel metacounter - When deleting a specific item of a channel metacounter by its key

Update a project

List agents View an agent Update the connection status of an agent Cancel assignments Retrieve a list of an agent's connection logs Get number of an agent’s assigned tickets Get number of an agent’s closed tickets

List bots View a bot Update a bot Send a bot's message Get a bot's webhook logs

Create a customer List customers View a customer Update custom fields of a customer

Create a ticket Transfer tickets to a group List tickets View a ticket Update a ticket Update custom fields of a ticket Close a ticket Cancel assignment of a ticket

List groups View a group Add a member Remove a member

https://sendbird.com/docs

Business messaging