Import Group Members

The CometChat group member import API allows customers to import their group members’ data into the CometChat systems.

POST /data_import/members

Import Group Members

cURL

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

200

{
  "data": {
    "guid1_member_uid2": {
      "success": true,
      "data": {
        "guid": "guid1",
        "uid": "uid2",
        "scope": "admin",
        "joinedAt": 1673421419
      }
    }
  }
}

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

members · object

Wrapper for the members.

Show child attributes

Example:

{
  "guid1_member_uid2": {
    "memberId": "guid1_member_uid2",
    "uid": "uid2",
    "guid": "guid1",
    "joinedAt": "1673421419",
    "scope": "admin",
    "groupDetails": {
      "guid": "guid1",
      "name": "guid1",
      "type": "public",
      "owner": "uid1",
      "createdAt": "1673421419"
    },
    "userDetails": { "uid": "uid2", "name": "uid2" }
  }
}

Response

200 - application/json

Import Group Member(s)

data · object

Show child attributes