Register a GDPR request | Chat Platform API | Sendbird Docs

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
- - Managing typing indicators
  - 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
- - Getting failed webhooks
  - Get failed webhooks
- 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

/

Privacy

Registers a specific type of GDPR request to comply with the GDPR's requirements.

Note: Currently, Sendbird only provides options to delete and access user data. Features to address the right to restriction of processing and right to object will be available soon.

HTTP request

Request body

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

Properties

Optional	Type	Description
action	string	Determines the type of a GDPR request. Acceptable values are access and delete. If set to access, Sendbird server generates a downloadable zip file containing the data of a user specified in the `user_id` property to comply with GDPR's right of access by the data subject. If set to delete, users specified in the `user_ids` property are permanently deleted from your Sendbird application to comply with GDPR's right to erasure of the data subject. (Default: delete)
user_id	string	Specifies the unique ID of a user. This property should be specified when the value of the `action` property is set to access.
user_ids[]	array of strings	Specifies an array of IDs of users. Up to 100 users can be processed at once. This property should be specified when the value of the `action` property is set to delete.
channel_delete_option	string	Determines the scope of group channels to delete in addition to deleting users specified in the `user_ids` property. Acceptable values are the following: - do_not_delete (default): the specified users are deleted but the group channels they are in will remain. - 1_on_1: only 1-on-1 group channels the specified users are in will be deleted. (This option can be useful when eliminating spam users) - all: all group channels the specified users are in will be deleted. * This only works when the value of the `action` property is set to delete.

Response

If successful, this action returns information about the GDPR request in the response body.

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

Try API requests