Overview

Import users, groups, members, and message history from a previous chat system into CometChat.

The Data Import API provides an efficient way to migrate data from your previous chat system to CometChat. You can import users, groups, group members, and full message history in bulk.

Endpoints

Method	Endpoint	Description
POST	/data_import/users	Import users in bulk
POST	/data_import/groups	Import groups in bulk
POST	/data_import/members	Import group members in bulk
POST	/data_import/messages	Import messages in bulk

Key capabilities

• Import Users — Create multiple users at once from an existing data source.
• Import Groups — Migrate all existing groups into your CometChat app.
• Import Members — Add members to specific groups during migration.
• Import Messages — Migrate chat history including 1-on-1 and group messages.

Getting started

All Data Import API requests require your appId, apiKey, and region, available from the CometChat Dashboard. Requests must be made over HTTPS.

Base URL:

https://<appId>.api-<region>.cometchat.io/v3/data_import

Replace <appId> and <region> with your actual App ID and region.

Rate limits

Data import operations are rate-limited to 60 requests per minute. See Rate Limits for details.

Error handling

Error Code	Description
AUTH_ERR_EMPTY_APIKEY	API key is missing from the request headers
AUTH_ERR_APIKEY_NOT_FOUND	The provided API key is invalid
ERR_TOO_MANY_REQUESTS	Rate limit exceeded — retry after the specified time

For the complete list of error codes, see Error Guide.

For all system limits, see Properties and Constraints.