Lark Contacts

Lark Contacts Management

Actions38

User Actions
Department Actions
User Group Actions
User Group Member Actions
Unit Actions
Workforce Type Actions
Custom User Field Actions
- Obtain Custom User Fields Of A Company
Contact Scope Actions
- Obtain The Range Of Contacts Data That An App Can Access

Overview

The "Update A User Group" operation in the "User Group" resource allows users to modify existing user groups within the Lark Contacts system. This node is useful for updating group metadata such as the group's name and description, enabling dynamic management of contact groups. Practical scenarios include renaming a team group after reorganization or updating the description to reflect new group purposes.

Properties

Name	Meaning
Authentication	Method of authentication to use: either "Tenant Token" or "OAuth2".
Group Id	The unique identifier of the user group to update (required).
Description	New description text for the user group.
Name	New name for the user group.
Custom Body	JSON object allowing full customization of the request body sent to the API.
Options > Use Custom Body	Boolean flag indicating whether to send the custom JSON body instead of standard fields.

Output

The node outputs JSON data representing the updated user group details returned from the Lark Contacts API. This typically includes the group's ID, updated name, description, and possibly other metadata confirming the successful update. There is no indication that binary data is output by this node.

Dependencies

Requires an API key credential for authentication, either via a Tenant Token or OAuth2.
Connects to the Lark Suite Open APIs at https://open.larksuite.com/open-apis.
Proper configuration of credentials in n8n is necessary to authenticate requests.

Troubleshooting

Common Issues:
- Missing or invalid Group Id will cause the update to fail.
- Incorrect or expired authentication tokens will result in authorization errors.
- Using the custom body option incorrectly (e.g., malformed JSON) may cause request failures.
Error Messages:
- Authorization errors typically indicate issues with the provided API credentials; verify and refresh tokens as needed.
- Validation errors may occur if required fields are missing or contain invalid values; ensure Group Id is set and JSON bodies are well-formed.
- Network or API endpoint errors suggest connectivity problems or incorrect base URL configurations.