Import Groups

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

POST /data_import/groups

Import Groups

cURL

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

200

{
  "data": {
    "guid1": {
      "success": true,
      "data": {
        "guid": "guid1",
        "name": "guid1",
        "type": "public",
        "conversationId": "group_guid1",
        "createdAt": 1673421419,
        "owner": "cometchat-uid-1"
      }
    }
  }
}

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

groups · object

Wrapper for the groups.

Show child attributes

Example:

{
  "guid1": {
    "guid": "guid1",
    "name": "guid1",
    "createdAt": "1673421419",
    "type": "public",
    "owner": "cometchat-uid-1",
    "groupOwnerDetails": {
      "uid": "cometchat-uid-1",
      "name": "cometchat-uid-1"
    }
  }
}

Response

200 - application/json

Import Group(s)

data · object

Show child attributes