Sendbird

Deletes a specific APNs certificate. via DELETE /v3/applications/push/apns/cert/{provider_id}

Removes a specific push configuration from an application. The type of a push configuration is either `fcm`, `huawei`, or `apns`. via DELETE /v3/applications/push/{push_type}/{provider_id}

Unban specified users in channels with a custom channel type at once. via DELETE /v3/applications/settings_by_channel_custom_type/{custom_type}/ban

Unmute specified users in channels with a custom channel type at once. via DELETE /v3/applications/settings_by_channel_custom_type/{custom_type}/mute

Deletes allowed IPs from the whitelist by specifying their IP addresses or ranges. You can configure the IP whitelist under Settings > Security > Allowed IPs in the Sendbird Dashboard. via DELETE /v3/applications/settings/ip_whitelist

Deletes a bot from an application. via DELETE /v3/bots/{bot_userid}

Makes a bot leave one or more group channels. via DELETE /v3/bots/{bot_userid}/channels

Makes a bot leave one or more group channels. via DELETE /v3/bots/{bot_userid}/channels/{channel_url}

Deletes a message from a channel. via DELETE /v3/{channel_type}/{channel_url}/messages/{message_id}

Unpin a message from its channel. via DELETE /v3/{channel_type}/{channel_url}/messages/{message_id}/pin

Removes a specific reaction from a message. Note: Currently, this action is only available in group channels. via DELETE /v3/{channel_type}/{channel_url}/messages/{message_id}/reactions

Removes specific items from a message by their keys. via DELETE /v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray

Deletes a channel metacounter's item that is stored in a channel. via DELETE /v3/{channel_type}/{channel_url}/metacounter

Deletes a channel metacounter's item that is stored in a channel. via DELETE /v3/{channel_type}/{channel_url}/metacounter/{key}

Deletes a channel metadata's one or all items that are stored in a channel. via DELETE /v3/{channel_type}/{channel_url}/metadata

Deletes a channel metadata's one or all items that are stored in a channel. via DELETE /v3/{channel_type}/{channel_url}/metadata/{key}

Deletes an emoji category with the specified ID. via DELETE /v3/emoji_categories/{emoji_category_id}

Deletes an emoji from the application. via DELETE /v3/emojis/{emoji_key}

Deletes a group channel. via DELETE /v3/group_channels/{channel_url}

Unbans a user from a group channel. via DELETE /v3/group_channels/{channel_url}/ban/{banned_user_id}

Makes a hidden or archived channel reappear in the channel list of either a specific user or entire channel members. via DELETE /v3/group_channels/{channel_url}/hide

Unmutes a user within a group channel. via DELETE /v3/group_channels/{channel_url}/mute/{muted_user_id}

Cancels the registration of operators from a group channel but leave them as members. via DELETE /v3/group_channels/{channel_url}/operators

This action cancels a message that a user has scheduled to send at a later time. via DELETE /v3/group_channels/{channel_url}/scheduled_messages/{scheduled_message_id}

You can stop showing a typing indicator using this API. To signal that a user is no longer typing, you can let the indicator disappear when the user sends a message or completely deletes the message text. via DELETE /v3/group_channels/{channel_url}/typing

Deletes an open channel. via DELETE /v3/open_channels/{channel_url}

Unbans a user from an open channel. via DELETE /v3/open_channels/{channel_url}/ban/{banned_user_id}

Unmutes a user from an open channel. via DELETE /v3/open_channels/{channel_url}/mute/{muted_user_id}

Cancels the registration of operators from an open channel but leave them as participants. via DELETE /v3/open_channels/{channel_url}/operators

This action deletes a poll. Once a poll is deleted, you can't retrieve its data. via DELETE /v3/polls/{poll_id}

This action deletes an option from a poll. via DELETE /v3/polls/{poll_id}/options/{option_id}

Cancels the registration of a specific GDPR request. via DELETE /v3/privacy/gdpr/{request_id}

Removes a registration or device token from a user who owns it. You can pass one of two values in `token_type`: `gcm`, `huawei`, or `apns`, depending on which push service you are using. via DELETE /v3/push/device_tokens/{token_type}/{token}

Deletes a user. via DELETE /v3/users/{user_id}

Unblocks the user. via DELETE /v3/users/{user_id}/block/{target_id}

Deletes a user metadata's one or all items that are stored in a user. via DELETE /v3/users/{user_id}/metadata

Deletes a user metadata's one or all items that are stored in a user. via DELETE /v3/users/{user_id}/metadata/{key}

Removes a specific user's one or more FCM registration tokens, HMS device tokens, or APNs device tokens. via DELETE /v3/users/{user_id}/push

Removes a specific user's one or more FCM registration tokens, HMS device tokens, or APNs device tokens. via DELETE /v3/users/{user_id}/push/{token_type}/{token}

Resets a user's push preferences. After performing this action, `do_not_disturb` and `snooze_enabled` are set to false. The values of the parameters associated with the time frame are all set to 0. `timezone` is reset to `UTC`. `push_sound` is reset to `default`. via DELETE /v3/users/{user_id}/push_preference

Retrieves a list of announcement groups. via GET /v3/announcement_group

Retrieves the detailed open rate information of an announcement group. via GET /v3/announcement_open_rate_by_group/{announcement_group}

Retrieves the detailed open rate information of an announcement. via GET /v3/announcement_open_rate/{unique_id}

Retrieves the detailed open status information of a specific announcement. via GET /v3/announcement_open_status/{unique_id}

Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. via GET /v3/announcement_stats/daily

Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. via GET /v3/announcement_stats/monthly

Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. via GET /v3/announcement_stats/weekly

Retrieves a list of announcements. via GET /v3/announcements

Retrieves information on a specific announcement. via GET /v3/announcements/{unique_id}

Retrieves the number of devices and opened browser tabs which are currently connected to Sendbird server. via GET /v3/applications/ccu

Retrieves the number of daily active users of the application (DAU). via GET /v3/applications/dau

Retrieves the default channel invitation preference of an application. Note: Using the view channel invitation preference action, you can retrieve the value of a specific user's channel invitation preference, which can be set individually by user. via GET /v3/applications/default_channel_invitation_preference

Retrieves the number of monthly active users of the application (MAU). via GET /v3/applications/mau

Retrieves the number of concurrently connected devices to Sendbird server during the requested time period. via GET /v3/applications/peak_connections

Retrieves a list of an application's registered push configurations. via GET /v3/applications/push/{push_type}

Retrieves a specific push configuration of an application. The type of a push configuration is either `fcm`, `huawei`, or `apns`. via GET /v3/applications/push/{push_type}/{provider_id}

Retrieves a list of push notification content templates of an application. via GET /v3/applications/push/message_templates

Retrieves information on a specific push notification content templates of an application. The name of a content template is either `default` or `alternative`. via GET /v3/applications/push/message_templates/{template_name}

Shows whether the push notifications feature is turned on for an application. via GET /v3/applications/push/settings

Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use. Auto event messages are Admin messages that are automatically generated when a specific event occurs. via GET /v3/applications/settings/auto_event_message

Retrieves a list of users banned from channels with the specified custom channel type. via GET /v3/applications/settings_by_channel_custom_type/{custom_type}/ban

Retrieves a list of the muted users in channels with a custom channel type. via GET /v3/applications/settings_by_channel_custom_type/{custom_type}/mute

Retrieves a list of all the IP ranges and addresses that have access to your Sendbird application. This list is called an IP whitelist and its addresses are granted API access when the IP whitelist API enables CIDR notations. If you specify which IP addresses or ranges to include in the whitelist, any unlisted foreign IP addresses will be denied access. If you don't specify any IP address or range to include in the whitelist, all IP addresses will be granted API access. You can configure the IP whitelist under Settings > Security > Allowed IPs in the Sendbird Dashboard. via GET /v3/applications/settings/ip_whitelist

Retrieves a list of events for your webhook server to receive payloads for. via GET /v3/applications/settings/webhook

Retrieves a list of all bots within an application. via GET /v3/bots

Retrieves information on a bot. via GET /v3/bots/{bot_userid}

Retrieves a list of past messages of a channel. This message retrieval is one of Sendbird's premium features. Contact our sales team for further assistance. via GET /v3/{channel_type}/{channel_url}/messages

Retrieves information on a message. via GET /v3/{channel_type}/{channel_url}/messages/{message_id}

Retrieves a list of reactions made to a message. Note: Currently, this action is only available in group channels. via GET /v3/{channel_type}/{channel_url}/messages/{message_id}/reactions

Retrieves the total number of messages in a channel. via GET /v3/{channel_type}/{channel_url}/messages/total_count

Retrieves channel metacounter's one or more items that are stored in a channel. via GET /v3/{channel_type}/{channel_url}/metacounter

Retrieves channel metacounter's one or more items that are stored in a channel. via GET /v3/{channel_type}/{channel_url}/metacounter/{key}

Retrieves a channel metadata's one or more items that are stored in a channel. via GET /v3/{channel_type}/{channel_url}/metadata

Retrieves a channel metadata's one or more items that are stored in a channel. via GET /v3/{channel_type}/{channel_url}/metadata/{key}

Retrieves a list of all emoji categories registered to the application, including their emojis. via GET /v3/emoji_categories

Retrieves an emoji category with the specified ID, including its emojis. via GET /v3/emoji_categories/{emoji_category_id}

Retrieves a list of all emojis registered to the application. via GET /v3/emojis

Retrieves an emoji with the specified key. via GET /v3/emojis/{emoji_key}

Retrieves a list of message, channel or user data exports via GET /v3/export/{data_type}

Retrieves information on a message, channel or user data export. via GET /v3/export/{data_type}/{request_id}

Retrieves a list of group channels in the application. Note: If you want to get a list of a specific user's group channels, use the list my group channels action instead. via GET /v3/group_channels

Retrieves information on a group channel. via GET /v3/group_channels/{channel_url}

Retrieves a list of the banned users from a group channel. via GET /v3/group_channels/{channel_url}/ban

Retrieves details of a ban imposed on a user. via GET /v3/group_channels/{channel_url}/ban/{banned_user_id}

Retrieves a list of members of a group channel. via GET /v3/group_channels/{channel_url}/members

Checks whether the user is a member of the group channel. via GET /v3/group_channels/{channel_url}/members/{user_id}

Retrieves the total number of each member's unread messages in a group channel. This action is only applicable for users in a group channel. via GET /v3/group_channels/{channel_url}/messages/unread_count

Retrieves a list of the muted users in a group channel. via GET /v3/group_channels/{channel_url}/mute

Checks if a user is muted in a group channel. via GET /v3/group_channels/{channel_url}/mute/{muted_user_id}

Retrieves a list of operators of a group channel. via GET /v3/group_channels/{channel_url}/operators

This action retrieves information on a specific scheduled message. via GET /v3/group_channels/{channel_url}/scheduled_messages/{scheduled_message_id}

Retrieves a list of open channels. You can query the list using various parameters. via GET /v3/open_channels

Retrieves information on a specific open channel. via GET /v3/open_channels/{channel_url}

Retrieves a list of banned users from a specific open channel. via GET /v3/open_channels/{channel_url}/ban

Retrieves details of a ban imposed on a user. via GET /v3/open_channels/{channel_url}/ban/{banned_user_id}

Retrieves a list of muted users in the channel. via GET /v3/open_channels/{channel_url}/mute

Checks if a user is muted in an open channel. via GET /v3/open_channels/{channel_url}/mute/{muted_user_id}

Retrieves a list of operators of an open channel. via GET /v3/open_channels/{channel_url}/operators

Retrieves a list of the participants of an open channel. A participant refers to a user who has entered the open channel and is currently online. via GET /v3/open_channels/{channel_url}/participants

This action retrieves a paginated list of both open and closed polls in an application or a specific channel. To retrieve polls in a specific channel, the channel_url must be specified. via GET /v3/polls

This action retrieves information on a specific poll. via GET /v3/polls/{poll_id}

This action retrieves a poll option. via GET /v3/polls/{poll_id}/options/{option_id}

This action retrieves a list of users who voted for a poll option. via GET /v3/polls/{poll_id}/options/{option_id}/voters

Retrieves a list of GDPR requests of all types. via GET /v3/privacy/gdpr

Retrieves a specific GDPR request. via GET /v3/privacy/gdpr/{request_id}

Retrieves a user who owns a FCM registration token, HMS device token, or APNs device token. You can pass one of two values in `token_type`: `gcm`, `huawei`, or `apns`, depending on which push service you are using. via GET /v3/push/device_tokens/{token_type}/{token}

Retrieves a list of reports within an application regardless of object types. via GET /v3/report

Retrieves a list of reports on a channel that has offensive messages or abusive activities. via GET /v3/report/{channel_type}/{channel_url}

Retrieves a list of reports on a message which contains suspicious, harassing, or inappropriate content. via GET /v3/report/{channel_type}/{channel_url}/messages/{message_id}

Retrieves information on a message that has been moderated by the profanity filter. via GET /v3/report/{channel_type}/{channel_url}/profanity_messages/{message_id}

Retrieves a list of reports on a user who sends an offensive message. via GET /v3/report/users/{offending_user_id}

This action retrieves a list of scheduled messages. A user can only see the list of their own scheduled messages. via GET /v3/scheduled_messages

This action retrieves the total number of scheduled messages that a user has. via GET /v3/scheduled_messages/count

Retrieves Advanced analytics metrics based on the specified parameters. You can retrieve either daily or monthly metrics using the time_dimension parameter. Note: Daily metrics are calculated and updated every three hours, starting at 1 a.m. in UTC. Meanwhile, monthly metrics are calculated after the last day of the month. via GET /v3/statistics/metric

Retrieves a list of users in your application. You can query the list using various parameters. via GET /v3/users

Retrieves information on a user. via GET /v3/users/{user_id}

Retrieves a list of open and group channels with additional information where a user is banned. via GET /v3/users/{user_id}/ban

Retrieves a list of other users that a user has blocked. via GET /v3/users/{user_id}/block

Retrieves channel invitation preference for a user's private group channels. Note: Using the view default channel invitation preference action, you can retrieve the value of channel invitation preference which is globally applied to all users within the application. via GET /v3/users/{user_id}/channel_invitation_preference

Retrieves count preference of a specific group channel of a user. via GET /v3/users/{user_id}/count_preference/{channel_url}

Retrieves the number of a user's group channels by their join status. via GET /v3/users/{user_id}/group_channel_count

Retrieves a user metadata's one or more items that are stored in a user. via GET /v3/users/{user_id}/metadata

Retrieves a user metadata's one or more items that are stored in a user. via GET /v3/users/{user_id}/metadata/{key}

Retrieves a list of open and group channels with additional information where a user is muted. via GET /v3/users/{user_id}/mute

Retrieves all group channels that the user has joined. You can create a request based on various query parameters. via GET /v3/users/{user_id}/my_group_channels

Retrieves a list of a specific user's FCM registration tokens, HMS device tokens, or APNs device tokens. You can specify either `gcm`, `huawei`, or `apns` in the `token_type` parameter, depending on which push notification service you are using. via GET /v3/users/{user_id}/push/{token_type}

Retrieves a user's push preferences about whether the user has set `do_not_disturb` to pause notifications for a certain period of time, and the time frame in which the user has applied the setting. via GET /v3/users/{user_id}/push_preference

Retrieves whether a user has turned on notification messages for a specific channel. The push notifications feature is only available for group channels. via GET /v3/users/{user_id}/push_preference/{channel_url}

Retrieves the total number of a user's group channels with unread messages. via GET /v3/users/{user_id}/unread_channel_count

Retrieves a set of total numbers of a user's unread messages, unread mentioned messages, or received invitations in either super or non-super group channels. This action is only available for the group channels. via GET /v3/users/{user_id}/unread_item_count

Retrieves the total number of a user's currently unread messages in the group channels. The unread counts feature is only available for the group channels. via GET /v3/users/{user_id}/unread_message_count

Schedules a new announcement. You can also schedule an announcement in the Sendbird Dashboard. via POST /v3/announcements

Registers an APNs (Apple Push Notification service) push configuration for your client app. To send push notifications to iOS devices, your should first register the APNs push configuration. You can also register the configurations in your dashboard under Settings > Application > Notifications. Note: To upload a .p12 certificate file to Sendbird server, you should send a Multipart request. via POST /v3/applications/push/apns. WITHHELD: Sendbird accepts push credentials only as a multipart/form-data file upload, which this integration does not send, so this call is refused before any request is made. Manage push credentials in the Sendbird Dashboard (Settings > Application > Notifications).

Registers a FCM (Firebase Cloud Messaging) push configuration for your client app. To send push notifications to Android devices, you should first register the FCM push configuration. You can also register the configurations in your dashboard under Settings > Application > Notifications. via POST /v3/applications/push/fcm. WITHHELD: Sendbird accepts push credentials only as a multipart/form-data file upload, which this integration does not send, so this call is refused before any request is made. Manage push credentials in the Sendbird Dashboard (Settings > Application > Notifications).

Registers an HMS (Huawei Mobile Services) push configuration for your client app. To send push notifications to Android devices for HMS, you should first register the HMS push configuration. You can also register the configurations in your dashboard under Settings > Application > Notifications. via POST /v3/applications/push/huawei

Ban specified users in channels with a custom channel type at once. via POST /v3/applications/settings_by_channel_custom_type/{custom_type}/ban

Mutes specified users in channels with a custom channel type at once. via POST /v3/applications/settings_by_channel_custom_type/{custom_type}/mute

Creates a new bot within the application. Creating a bot is similar to creating a normal user, except that a callback URL is specified in order for the bot to receive events. Note: The bot must join a group channel first to interact with users. In group channels, you can invite a bot through the invite as members action instead. via POST /v3/bots

Makes a bot join one or more channels. via POST /v3/bots/{bot_userid}/channels

Sends a bot's message to a channel. via POST /v3/bots/{bot_userid}/send

Sends a message to a channel. You can send a text message, a file message, and an admin message. Note: With Sendbird Chat SDKs and the platform API, any type of files in messages can be uploaded to Sendbird server. via POST /v3/{channel_type}/{channel_url}/messages

Pin a message to its channel. via POST /v3/{channel_type}/{channel_url}/messages/{message_id}/pin

Adds a specific reaction to a message. Note: Currently, this action is only available in group channels. via POST /v3/{channel_type}/{channel_url}/messages/{message_id}/reactions

Adds one or more key-values items which store additional information for a message. via POST /v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray

Translates a message into specific languages. Only text messages of which type is MESG can be translated into other languages. Note: Message translation is powered by Google Cloud Translation API recognition engine. Find language codes supported by the engine in the Miscellaneous page or visit the Language Support for Google Cloud Translation. via POST /v3/{channel_type}/{channel_url}/messages/{message_id}/translation

Creates a channel metacounter's items to store in a channel. via POST /v3/{channel_type}/{channel_url}/metacounter

Creates a channel metadata's items to store in a channel. via POST /v3/{channel_type}/{channel_url}/metadata

This action sends a scheduled message immediately. A user can only send their own scheduled messages immediately. via POST /v3/{channel_type}/{channel_url}/scheduled_messages/{scheduled_message_id}/send_now

Adds a list of one or more new emoji categories to the application. via POST /v3/emoji_categories

Adds a list of one or more new emojis to the application. via POST /v3/emojis

Registers and schedules a message, channel, or user data export. via POST /v3/export/{data_type}

Creates a new group channel. If you are creating a 1-on-1 direct messaging channel for a user, it is recommended that you turn on the `distinct` property. If the property is turned off, a user can create a new channel even if they have had the previous chat between them, and therefore can't see previously sent messages or data in the new channel. On the other hand, if the `distinct` property is turned on, every 1-on-1 conversation between the same two users occurs within the same channel. via POST /v3/group_channels

Bans a user from a group channel. A banned user is immediately expelled from a channel and allowed to join the channel again after a set time period. via POST /v3/group_channels/{channel_url}/ban

Invites one or more users as members into the group channel. Note: By default, users in your application automatically join a private group channel promptly from an invitation without having to accept it. If you want to give them the option to decide whether to accept or decline an invitation, you should set the value of channel invitation preference to false through the update default channel invitation preference action. Or using the update a user's channel invitation preference action, you can also allow the option individually by user. via POST /v3/group_channels/{channel_url}/invite

Mutes a user in a group channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted. via POST /v3/group_channels/{channel_url}/mute

Registers one or more operators to a group channel. via POST /v3/group_channels/{channel_url}/operators

This action creates a new scheduled message. If a user leaves the channel before the scheduled time for the message to be sent, the scheduled message will be removed. via POST /v3/group_channels/{channel_url}/scheduled_messages

This action updates information on a specific scheduled message. You can’t change the message type. Update operation should be done at least 5 minutes prior to the original scheduled time. via PUT /v3/group_channels/{channel_url}/scheduled_messages/{scheduled_message_id}

You can start showing a typing indicator using this API. Seeing whether other users are typing can help a more interactive conversation environment by showing real-time engagement of other users. via POST /v3/group_channels/{channel_url}/typing

Using our migration API, you can migrate the messages from another system into a Sendbird system's channel which consists of users, messages, and other chat-related data. To turn on this feature, contact our support team. There are three things to do in advance before the migration. Follow the instructions below: 1. Register the users of your current chat solution to your Sendbird application. You can migrate the users into the Sendbird system using the user creation API. 2. Create either an open or a group channel to migrate the messages of your chat solution. The Sendbird system doesn't create a channel for your migration automatically. 3. The maximum number of migrated messages per call is 100. To avoid the failure during your migration, you must adjust the number of messages to process at once via the API. via POST /v3/migration/{target_channel_url}

Creates an open channel. Note: Classic open channels created before the deprecation date of March 2021 will maintain their original form and functions. However, new applications created after December 15, 2020, will be able to create dynamic partitioning open channels only. via POST /v3/open_channels

Bans a user from an open channel. A banned user is immediately expelled from a channel and allowed to participate in the channel again after a set time period. via POST /v3/open_channels/{channel_url}/ban

Mutes a user in the channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted. via POST /v3/open_channels/{channel_url}/mute

Registers one or more operators to an open channel. via POST /v3/open_channels/{channel_url}/operators

This action creates a poll with at least one option.You can configure various settings for your poll, including when the poll will close and whether to allow voting for multiple options. After creating a poll, to share the poll with other users in a channel, the poll must be sent as a message. via POST /v3/polls

This action adds a new option to a poll. via POST /v3/polls/{poll_id}/options

Registers a specific type of GDPR request to meet the GDPR's requirements. Note: Currently, only delete and access of the user data are supported. The features for the right to restriction of processing and right to object will be available soon. via POST /v3/privacy/gdpr

Reports a channel that has offensive messages or abusive activities. via POST /v3/report/{channel_type}/{channel_url}

Reports a message which contains suspicious, harassing, or inappropriate content. via POST /v3/report/{channel_type}/{channel_url}/messages/{message_id}

Reports a user who sends an offensive message in a channel. via POST /v3/report/users/{offending_user_id}

Creates a new user in the application. A user is identified by its unique user ID, and additionally have a changeable nickname, profile image, and so on. via POST /v3/users

Bans a user from channels with particular custom channel types. via POST /v3/users/{user_id}/banned_channel_custom_types

Allows a user to block another user. A user doesn't receive messages from someone they have blocked anymore. Also, blocking someone doesn't alert them that they have been blocked. Blocked users still can send messages as normal in the channel: however, they can't receive any messages from the users who have blocked them. via POST /v3/users/{user_id}/block

Creates a user metadata's items to store in a user. via POST /v3/users/{user_id}/metadata

Mutes a user in channels with particular custom channel types. via POST /v3/users/{user_id}/muted_channel_custom_types

Registers a user as an operator to channels with particular custom channel types. via POST /v3/users/{user_id}/operating_channel_custom_types

Note: A user can have up to 20 FCM registration tokens, 20 HMS device tokens, and 20 APNs device tokens each. The oldest token will be deleted before a new token is added for a user who already has 20 registration or device tokens. Only the 20 newest tokens will be maintained for users who already have more than 20 of each token type. To send notification requests to push notification services on behalf of your server, adds a specific user's FCM registration token, HMS device token, or APNs device token to Sendbird server. Depending on which push service you are using, you can pass one of two values in `token_type`: `gcm`, `huawei`, or `apns`. A FCM registration token and an APNs device token allow identification of each client app instance on each device, and are generated and registered by Android and iOS apps through the corresponding SDKs. Use this method if you need to register a token via your own server. Note: For more information on the registration token and device token, visit the Google's FCM page, Huawei's Push kit and Apple's APNs page. via POST /v3/users/{user_id}/push/{token_type}

Create user token via POST /v3/users/{user_id}/token

Updates information of a specific announcement before it starts or changes the status of a specific announcement after it starts. For the 2 different applications, refer to the request body below. Note: Updating information of an announcement is possible only when the announcement status is scheduled, indicating it hasn't started yet. via PUT /v3/announcements/{unique_id}

Updates the default channel invitation preference of an application. Note: Using the update channel invitation preference action, you can update the value of a specific user's channel invitation preference, which can be set individually by user. via PUT /v3/applications/default_channel_invitation_preference

Updates a specific APNs (Apple Push Notification service) push configuration for your client app. You can also register the configurations in your dashboard under Settings > Application > Notifications. Note: If your HTTP request body contains a .p12 certificate file to upload to Sendbird server, you should send a Multipart request . via PUT /v3/applications/push/apns/{provider_id}. WITHHELD: Sendbird accepts push credentials only as a multipart/form-data file upload, which this integration does not send, so this call is refused before any request is made. Manage push credentials in the Sendbird Dashboard (Settings > Application > Notifications).

Updates a specific FCM (Firebase Cloud Messaging) push configuration for your client app. You can also update the configurations in your dashboard under Settings > Application > Notifications. via PUT /v3/applications/push/fcm/{provider_id}. WITHHELD: Sendbird accepts push credentials only as a multipart/form-data file upload, which this integration does not send, so this call is refused before any request is made. Manage push credentials in the Sendbird Dashboard (Settings > Application > Notifications).

Updates a specific HMS (Huawei Mobile Services) push configuration for your client app. You can also update the configurations in your dashboard under Settings > Application > Notifications. via PUT /v3/applications/push/huawei/{provider_id}

Updates a specific push notification content template of an application. The name of a content template is either `default` or `alternative`. via PUT /v3/applications/push/message_templates/{template_name}

Determines whether to turn on the push notifications feature for an application. via PUT /v3/applications/push/settings

Determines whether to automatically send event messages to group channels when events take place in an application. You can choose which auto event message to receive on the Sendbird Dashboard via PUT /v3/applications/settings/auto_event_message

Sets the application's GLOBAL message moderation settings -- domain filter, profanity filter, image moderation and profanity-triggered moderation -- which apply to every channel of the application, and returns the resulting global settings. Only the fields sent are changed. via PUT /v3/applications/settings_global

Adds IP addresses and ranges to your Sendbird application settings. Both currently added and any previously added IPs are granted API access. You can configure the IP whitelist under Settings > Security > Allowed IPs in the Sendbird Dashboard. via PUT /v3/applications/settings/ip_whitelist

Turn on or off reactions in a Sendbird application. Note: This action also allows reactions in UIKit. via PUT /v3/applications/settings/reactions

Determines whether to use the 7 default emojis initially provided. via PUT /v3/applications/settings/use_default_emoji

Chooses which events for your webhook server to receive payloads for. By subscribing to specific events based on your own needs, you can control the number of HTTP requests to your webhook server. via PUT /v3/applications/settings/webhook

Updates information on a bot. via PUT /v3/bots/{bot_userid}

Updates information on a message in a channel. via PUT /v3/{channel_type}/{channel_url}/messages/{message_id}

Updates the values of specific items by their keys. via PUT /v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray

Updates existing items of a channel metacounter by their keys, or adds new items to the metacounter. via PUT /v3/{channel_type}/{channel_url}/metacounter

Updates existing items of a channel metacounter by their keys, or adds new items to the metacounter. via PUT /v3/{channel_type}/{channel_url}/metacounter/{key}

Updates existing items of a channel metadata by their keys, or adds new items to the metadata. via PUT /v3/{channel_type}/{channel_url}/metadata

Updates existing items of a channel metadata by their keys, or adds new items to the metadata. via PUT /v3/{channel_type}/{channel_url}/metadata/{key}

Updates the URL of an emoji category with the specified ID. via PUT /v3/emoji_categories/{emoji_category_id}

Updates the image URL of an emoji with the specified key. via PUT /v3/emojis/{emoji_key}

Updates information on a group channel. Note: You can't change the members of the channel here. To do so, see invite as members action below. via PUT /v3/group_channels/{channel_url}

Accepts an invitation from a private group channel for a user to join. Since a user is allowed to join up to 2,000 group channels, the invitation to a user who already belongs to a maximum number of group channels will be canceled automatically. Note: This action is effective only when the `auto_accept` property of an application is set to false. You can change the value of the property using the update default channel invitation preference action, or update a user's channel invitation preference action. via PUT /v3/group_channels/{channel_url}/accept

Updates details of a ban imposed on a user. You can change the length of the ban with this action, and also provide an updated description. via PUT /v3/group_channels/{channel_url}/ban/{banned_user_id}

Declines an invitation for a user to not join a private group channel. Note: This action is effective only when the `auto_accept` property of an application is set to false. You can change the value of the property using the update default channel invitation preference action, or update a user's channel invitation preference action. via PUT /v3/group_channels/{channel_url}/decline

Freezes or unfreezes a group channel. Note: Only users designated as channel operators are allowed to talk when a channel is frozen. via PUT /v3/group_channels/{channel_url}/freeze

Hides or archives a channel from the channel list of either a specific user or entire channel members. Normally, a hidden channel comes back and shows up in the channel list when a member in the channel sends a new message. This automatically-triggered behavior is intended for users who want to temporarily remove a channel from their list because leaving the channel would delete all the past messages and stored data. You can also leave out a channel from the list and archive the channel. The channel doesn't appear even when receiving a new message from other member. via PUT /v3/group_channels/{channel_url}/hide

Allows a user to join a public group channel. Since a user is allowed to join up to 2,000 group channels, a user who already belongs to a maximum number of group channels can't join a new channel. Note: This action is only permitted for public group channels where the `is_public` property is true. via PUT /v3/group_channels/{channel_url}/join

Makes one or more members leave a group channel. via PUT /v3/group_channels/{channel_url}/leave

Marks all messages in a group channel as delivered for a given user. This action is only applicable for users in a group channel. via PUT /v3/group_channels/{channel_url}/messages/mark_as_delivered

Marks all messages in a group channel as read for a given user. This action is only applicable for users in a group channel. via PUT /v3/group_channels/{channel_url}/messages/mark_as_read

Resets the properties related to a user's chat history in a group channel, then clears the existing messages in the channel on the user's side only. A user can no longer see the messages in a group channel once this action is called, but those messages are not deleted from the database of the Sendbird system. All other members in the channel can retrieve and see the messages. This action simply clears the messages for the user by updating the `last_message` and `read_receipt` properties of the channel resource in addition to other internally managed data such as the number of the user's unread message. Using the `reset_all` property, you can also reset the properties related to all users' chat history in a group channel. via PUT /v3/group_channels/{channel_url}/reset_user_history

Updates information on an open channel. via PUT /v3/open_channels/{channel_url}

Updates details of a ban imposed on a user. You can change the length of a ban with this action, and also provide an updated description. via PUT /v3/open_channels/{channel_url}/ban/{banned_user_id}

Freezes or unfreezes an open channel. Note: Only users designated as channel operators are allowed to talk when a channel is frozen. via PUT /v3/open_channels/{channel_url}/freeze

This action updates information of a poll. To change the content of a poll option, see the update a poll option page. via PUT /v3/polls/{poll_id}

This action closes a poll and prevents users from voting any further. via PUT /v3/polls/{poll_id}/close

This action updates the content of a poll option. Voting for an option doesn't update the option. via PUT /v3/polls/{poll_id}/options/{option_id}

This action adds or removes a vote from a poll option, changing the number of votes given to each option. Use this action to override a previous vote and update the user's final choice of poll options. via PUT /v3/polls/{poll_id}/vote

Updates information on a user. In addition to changing a user's nickname or profile image, you can issue a new access token for the user. The new access token replaces the previous one as the necessary token for authentication. You can also deactivate or reactivate a user. If the `leave_all_when_deactivated` is true (which it is by default), a user leaves all joined group channels when deactivated. via PUT /v3/users/{user_id}

Updates the channel invitation preference for a user's private group channels. Note: Using the update default channel invitation preference action, you can update the value of channel invitation preference which is globally applied to all users within the application. via PUT /v3/users/{user_id}/channel_invitation_preference

Updates count preference of a specific group channel of a user. via PUT /v3/users/{user_id}/count_preference/{channel_url}

Marks all of a user's unread messages as read in the joined group channels. via PUT /v3/users/{user_id}/mark_as_read_all

Updates existing items of a user metadata by their keys, or adds new items to the metadata. via PUT /v3/users/{user_id}/metadata

Updates existing items of a user metadata by their keys, or adds new items to the metadata. via PUT /v3/users/{user_id}/metadata/{key}

Makes a user leave all joined group channels. via PUT /v3/users/{user_id}/my_group_channels/leave

Updates a user's push preferences. Through this action, you can set `do_not_disturb` for a user, and update the time frame in which the setting applies. via PUT /v3/users/{user_id}/push_preference

Updates push preferences for a user's specific group channel. The push notifications feature is only available for group channels. via PUT /v3/users/{user_id}/push_preference/{channel_url}

Chooses a push notification content template of a user's own. The push notifications feature is only available for group channels. via PUT /v3/users/{user_id}/push/template