Import Users

The CometChat user import API allows customers to import their users’ data into the CometChat systems.

POST /data_import/users

Import Users

cURL

curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/data_import/users \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{}'

200

{
  "data": {
    "uid1": {
      "success": true,
      "data": {
        "uid": "uid1",
        "name": "uid1",
        "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp",
        "metadata": {
          "key": "value"
        },
        "status": "offline",
        "role": "default",
        "lastActiveAt": 1673421425,
        "createdAt": 1673421419
      }
    }
  }
}

Constraints

Item	Constraint	Notes
Entities per request	50	Transmit up to 50 entities within a single request for efficient processing
Requests per minute	60	Rate limit for data import endpoints; exceeding returns a rate limit error

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json

users · object

Wrapper for the users.

Show child attributes

Example:

{
  "uid1": {
    "uid": "uid1",
    "name": "uid1",
    "avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp",
    "createdAt": "1673421419",
    "metadata": { "key": "value" },
    "lastActiveAt": "1673421425"
  }
}

Response

200 - application/json

Import User(s)

data · object

Show child attributes