curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"admins": [],
"moderators": [],
"participants": [],
"usersToBan": []
}'
{
"data": {
"usersToBan": {
"superhero6": {
"success": true
}
},
"admins": {
"superhero1": {
"success": true,
"data": {
"id": "32",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero1",
"name": "Iron Man",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/ironman.png",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"description": "project related discussions between members",
"membersCount": 2,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460972,
"updatedAt": 1625460972
}
}
},
"moderators": {
"superhero3": {
"success": true,
"data": {
"id": "33",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero3",
"name": "Spiderman",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png",
"status": "offline",
"createdAt": 1596537299,
"updatedAt": 1625234590
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"updatedAt": 1625460972,
"description": "project related discussions between members",
"membersCount": 3,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460973,
"updatedAt": 1625460973
}
}
},
"participants": {
"superhero4": {
"success": true,
"data": {
"id": "34",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero4",
"name": "Wolverine",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"updatedAt": 1625460973,
"description": "project related discussions between members",
"membersCount": 4,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460973,
"updatedAt": 1625460973
}
},
"superhero5": {
"success": true,
"data": {
"id": "35",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero5",
"name": "Cyclops",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"updatedAt": 1625460973,
"description": "project related discussions between members",
"membersCount": 5,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460973,
"updatedAt": 1625460973
}
}
}
}
}
Adds multiple users as per the scope.
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"admins": [],
"moderators": [],
"participants": [],
"usersToBan": []
}'
{
"data": {
"usersToBan": {
"superhero6": {
"success": true
}
},
"admins": {
"superhero1": {
"success": true,
"data": {
"id": "32",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero1",
"name": "Iron Man",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/ironman.png",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"description": "project related discussions between members",
"membersCount": 2,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460972,
"updatedAt": 1625460972
}
}
},
"moderators": {
"superhero3": {
"success": true,
"data": {
"id": "33",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero3",
"name": "Spiderman",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/spiderman.png",
"status": "offline",
"createdAt": 1596537299,
"updatedAt": 1625234590
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"updatedAt": 1625460972,
"description": "project related discussions between members",
"membersCount": 3,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460973,
"updatedAt": 1625460973
}
}
},
"participants": {
"superhero4": {
"success": true,
"data": {
"id": "34",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero4",
"name": "Wolverine",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"updatedAt": 1625460973,
"description": "project related discussions between members",
"membersCount": 4,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460973,
"updatedAt": 1625460973
}
},
"superhero5": {
"success": true,
"data": {
"id": "35",
"conversationId": "group_project-group",
"sender": "app_system",
"receiverType": "group",
"receiver": "project-group",
"category": "action",
"type": "groupMember",
"data": {
"action": "added",
"entities": {
"by": {
"entity": {
"uid": "app_system",
"name": "System",
"role": "default",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"on": {
"entity": {
"uid": "superhero5",
"name": "Cyclops",
"role": "default",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png",
"status": "offline",
"createdAt": 1596537299
},
"entityType": "user"
},
"for": {
"entity": {
"guid": "project-group",
"icon": "http://placehold.it/120x120&text=image1",
"name": "Project Group",
"tags": [
"friends",
"project"
],
"type": "public",
"owner": "superhero2",
"createdAt": 1625460947,
"updatedAt": 1625460973,
"description": "project related discussions between members",
"membersCount": 5,
"conversationId": "group_project-group"
},
"entityType": "group"
}
}
},
"sentAt": 1625460973,
"updatedAt": 1625460973
}
}
}
}
}
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
UID of the user on whose behalf the action is performed.
A GUID of a group.
Create Group Members
The response is of type object
.
Was this page helpful?