Group Permissions

Update permission flags on a group conversation. Flags control who can send messages, edit group info, modify messages, add or remove members, and whether moderation is enabled — the SDK should read these values to show or hide actions in the group settings and composer.

Send the full groupPermissions object with the desired boolean values. The response returns the updated conversation document.

Use Group Permissions when:

• A group admin toggles "Only admins can send messages" in the SDK settings panel.
• You switch a broadcast-style group to read-only for regular members.
• You enable or disable member self-service add/remove from the people picker.
• You turn on moderation for a moderated community channel.

Part of the Chat Conversation APIs for the chat package / SDK — not Platform → Conversations. Requires a chat user Bearer token with admin privileges on the group (subject to onlyAdminCanEditInfo).

Each key inside groupPermissions controls a specific capability in the chat SDK:

Example updating all permission flags for a group conversation:

{
  "conversationId": "694b...d8",
  "groupPermissions": {
    "onlyAdminCanSendMessage": false,
    "onlyAdminCanEditInfo": false,
    "senderCanEditMessage": true,
    "allowMemberAdd": true,
    "allowMemberRemove": false,
    "moderationEnabled": false
  }
}

On success, data.conversation.groupPermissions reflects the new flag values. Sync these in the SDK immediately so composers and settings menus match server state.

{
  "success": true,
  "message": "Group conversation permissions updated successfully",
  "data": {
    "conversation": {
      "_id": "694b...d8",
      "conversationType": "group",
      "groupName": "Dev Team",
      "groupDescription": "Sprint coordination",
      "groupImage": null,
      "participants": [
        "694b...a1",
        "694b...a2",
        "694b...a3"
      ],
      "groupAdmins": [
        "694b...a3"
      ],
      "owner": "694b...a3",
      "groupPermissions": {
        "onlyAdminCanSendMessage": false,
        "onlyAdminCanEditInfo": false,
        "senderCanEditMessage": true,
        "allowMemberAdd": true,
        "allowMemberRemove": false,
        "moderationEnabled": false
      },
      "unreadCount": {},
      "pinnedMessage": [],
      "lastMessage": "70a1...c4",
      "metadata": {
        "workspaceId": "c1"
      },
      "createdAt": "2026-07-10T09:00:00.000Z",
      "updatedAt": "2026-07-10T09:00:00.000Z"
    }
  },
  "error": null
}

Permission updates fail when the token is invalid, the conversation is missing, the caller is not an admin, or the payload is incomplete.

{
  "success": false,
  "message": "No token, authorization denied",
  "data": null,
  "error": "Unauthorized"
}

{
  "success": false,
  "message": "Access denied: insufficient permissions",
  "data": null,
  "error": null
}

{
  "success": false,
  "message": "Conversation not found",
  "data": null,
  "error": null
}

{
  "success": false,
  "message": "groupPermissions object is required",
  "data": null,
  "error": null
}

{
  "success": false,
  "message": "These permissions are locked by your workspace admin: onlyAdminCanSendMessage",
  "data": null,
  "error": ["onlyAdminCanSendMessage"]
}

• Send all six flags in each update so the server state stays predictable — merge current values in your SDK before PATCHing.
• Reflect onlyAdminCanSendMessage in the composer immediately; do not rely on failed send attempts alone.
• Pair permission changes with UI copy so members understand why actions were disabled.
• Set conservative defaults at group create time via Create Group Conversation, then adjust here as needed.