Actions38
- Message Actions
- Message Buzz Message Actions
- Message Batch Message Actions
- Message Image Actions
- Message File Actions
- Message Message Card Actions
- Message Message Reaction Actions
- Group Actions
- Group Group Member Actions
- Group Group Announcement Actions
Overview
The "Update Group Information" operation in the Lark Messenger node allows users to modify various settings and metadata of a group chat within the Lark Messenger platform. This includes changing the group's name, description, avatar, permissions related to adding members or editing, visibility of join/leave messages, membership approval settings, labels, and localized names.
This operation is beneficial when managing group chats dynamically, such as updating group details after creation, adjusting permissions based on evolving team roles, or localizing group names for international teams.
Practical examples:
- Changing the group name and description to reflect a new project phase.
- Updating the group avatar to a new logo.
- Adjusting permissions so only certain members can add others or edit group info.
- Setting localized group names for English, Japanese, and Chinese users.
- Controlling visibility of join/leave messages to reduce noise in busy groups.
Properties
Name | Meaning |
---|---|
Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
Chat Id | The unique identifier of the group chat to update. Required. |
Add Member Permission | Permission setting controlling who can add members to the group. |
At All Permission | Permission setting controlling who can mention all members in the group. |
Avatar | URL or identifier for the group's avatar image. |
Description | Text description of the group. |
Edit Permission | Permission setting controlling who can edit group information. |
I 18 N Names | Localized group names for different languages; supports English (en_us), Japanese (ja_jp), and Simplified Chinese (zh_cn). |
Join Message Visibility | Controls visibility of join messages when members enter the group. |
Labels | List of labels/tags associated with the group. Multiple values allowed. |
Leave Message Visibility | Controls visibility of leave messages when members exit the group. |
Membership Approval | Setting that controls whether joining the group requires approval. |
Name | The display name of the group. |
Owner Id | Identifier of the user who owns the group. |
Share Card Permission | Permission setting controlling who can share contact cards within the group. |
Custom Body | JSON object allowing full customization of the request body instead of using individual fields. When enabled, this overrides other property inputs. |
Options > Use Custom Body | Boolean flag indicating whether to send a custom JSON body instead of individual parameters. |
Output
The node outputs the response from the Lark Messenger API after attempting to update the group information. The output is structured as JSON data containing the updated group details or error information if the update failed.
If the operation succeeds, the json
output typically includes confirmation of the updated fields and possibly the full current state of the group.
No binary data output is expected from this operation.
Dependencies
- Requires an active connection to the Lark Messenger API.
- User must provide valid authentication credentials, either via a Tenant Token or OAuth2 token.
- The node uses the base URL
https://open.larksuite.com/open-apis
for API requests. - Proper permissions/scopes must be granted to the provided credentials to allow group updates.
Troubleshooting
- Missing or invalid Chat Id: The operation requires a valid group chat ID. Ensure the ID is correct and corresponds to an existing group.
- Authentication errors: If the API key/token is invalid or expired, the request will fail. Refresh or reconfigure credentials as needed.
- Permission denied: Insufficient permissions for the authenticated user to update group info may cause errors. Verify user roles and scopes.
- Invalid field values: Providing unsupported or incorrectly formatted values (e.g., malformed JSON in custom body) can cause API errors. Validate input formats carefully.
- Using Custom Body: When enabling the custom body option, ensure the JSON structure matches the API specification exactly, as incorrect bodies will lead to request failures.
Links and References
- Lark Messenger API Documentation — Details on group chat IDs and API usage.
- Lark Developer Portal — Official developer resources and API references.