How do you add or manage group members (collaborators) using the Add Group Members API?
Use this API when you want to programmatically add, remove, or manage collaborators within a group (loop) inside your Community Media Network.
This matters because:
- Groups are collaborative spaces, and member control is critical
- It enables real-time user management via integrations
- It supports content contribution, moderation, and engagement workflows
If you're building dynamic communities, creator collaborations, or access-controlled groups, this API is essential.
What does the Add Group Members API do?
This API allows you to:
- Add new members (collaborators) to a group
- Remove existing members or subscribers
- Update group-level metadata (name, description, tags, DP, topics)
- Modify group settings like discoverability
It acts as the control layer for managing group participation and structure.
API Details
- URL: /api/thirdparty/update_conversation/{chat_id}
- Method: PATCH
- Authentication Required: Yes (Bearer Token)
Before you begin
1. Authenticate your request
Generate a gn-access-token using the Authentication API.
Pass it in the header: Authorization: Bearer <gn-access-token>
2. Ensure group (chat) exists
You must have a valid chat_id (group identifier) where members will be managed.
Request Structure
Request Body
{
"members_added": [
{
"user_id": "b12f13af-ef5a-4906-b0a0-2995e106200d"
}
],
"members_removed": [
"b12f13af-ef5a-4906-b0a0-2995e106200d"
],
"subscribers_removed": [
"b12f13af-ef5a-4906-b0a0-2995e106200d"
],
"name": "new name",
"description": "new description #abc #xyz",
"tags": "abc,xyz",
"dp": "1.png",
"topics": [1, 2],
"settings": {
"discoverable": false
}
}Field-level understanding
Member Management
- members_added - Add new collaborators using user_id
- members_removed - Remove existing members
- subscribers_removed - Remove subscribers (non-collaborators)
Group Metadata Updates
- name - Update group name
- description - Update description with hashtags
- tags - Update discovery tags
- dp - Update display image
- topics - Update group categorization
Settings
- discoverable - Control whether the group is publicly discoverable
What happens on success?
Success Condition
If the request is valid:
- Members are added/removed successfully
- Group updates (if any) are applied
- Updated state is returned
Response Code: 200 OK
Response Highlights
{
"code": 200,
"message": "Conversation updated successfully.",
"data": {
"members_added": [
{
"member_id": "9a42d4ed-3720-49cb-8697-57d7e8269b9d",
"name": null,
"bio": null,
"nickname": null,
"phone": "9533333315",
"is_brand_system_user": false,
"is_avatar": true,
"status": 2,
"role": 2,
"profile_image": "sloth",
"profile_image_s": "",
"profile_image_m": "",
"profile_image_l": ""
}
],
"members_removed": [],
"subscribers_added": [],
"subscribers_removed": [],
"requester_removed": [],
"name_updated": false,
"description_updated": false,
"dp_updated": false,
"topics_updated": false,
"settings_updated": false
}
}Important
- Each object in members_added contains a member_id, which uniquely identifies the collaborator
- Boolean flags (e.g., name_updated) indicate whether specific updates were applied
Error Handling
1. Bad Request
Condition:
- Invalid request payload
- Incorrect or malformed data
Response Code: 400 Bad Request
Response Body:
{
"code": "1099",
"message": "An unexpected error occurred processing the request",
"data": {}
}2. Unauthorized
Condition: Missing or invalid authentication token
Response Code: 401 Unauthorized
Response Body:
{
"code": "5159",
"message": "Invalid Use of API",
"data": {}
}3. Internal Server Error
Condition: Server-side failure while updating the group
Response Code: 500 Internal Server Error
Response Body:
{
"code": "5158",
"message": "Could not update the conversation.",
"data": {}
}Best Practices
- Always validate chat_id before making updates
- Ensure users exist before adding them as members
- Avoid unnecessary updates, send only required fields
- Handle partial updates using response flags (*_updated)
- Secure your API usage with proper token management
What to do next
After managing group members:
- Start posting content via the Post Video API
- Monitor engagement and participation
- Expand groups with more collaborators or subscribers
- Layer moderation or monetization workflows
