Message

Migrate messages

Changed on

Migrate messages

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.

https://sendbird.com/docs/chat/platform-api/v3/message/migration/migrate-messages#1-migrate-messages

post/v3/migration/{target_channel_url}

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

target_channel_urlstring required

(Required)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Request body

update_read_tsboolean
rewind_read_tsboolean

Example request

{
  "rewind_read_ts": true,
  "messages": [
    null,
    null
  ],
  "update_read_ts": true
}

Response

Successful response

EmptyObjectResponse required

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • warning

      deleted the header request parameter Api-Token

    • info

      api operation id migrateMessagesByUrl removed and replaced with migrateMessages

    • info

      added the new optional header request parameter api-token

    • info

      added the media type application/json for the response with the status