Lark Contacts icon

Lark Contacts

Lark Contacts Management

Actions38

Overview

The "Create A User Group" operation in the "User Group" resource of the Lark Contacts node allows users to create a new user group within their Lark workspace. This is useful for organizing contacts into manageable groups, facilitating communication and collaboration among team members or departments.

Typical use cases include:

  • Automatically creating user groups based on project teams or departments.
  • Managing contact groups dynamically as part of onboarding workflows.
  • Structuring contacts for targeted notifications or permissions management.

For example, a company could use this node to create a "Marketing Team" user group with a specific description and type, enabling streamlined communication within that group.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Description Text description of the user group being created.
Group Id Unique identifier string for the user group.
Name Name of the user group.
Type Numeric type indicator for the user group (meaning depends on Lark API documentation).
Custom Body JSON object allowing full customization of the request body sent to the API.
Use Custom Body Boolean option to toggle between using the standard properties or sending a custom body.

Output

The node outputs JSON data representing the response from the Lark API after attempting to create the user group. This typically includes details about the newly created group such as its ID, name, description, and other metadata returned by the API.

If the API supports binary data in responses (not indicated here), it would be summarized accordingly, but this operation primarily deals with JSON data.

Dependencies

  • Requires an active connection to the Lark Suite API.
  • Needs one of two authentication methods configured in n8n: either a Tenant Token credential or OAuth2 credential.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions/scopes must be granted to the credentials used to allow user group creation.

Troubleshooting

  • Authentication errors: Ensure the selected authentication method is correctly configured and the token or OAuth2 credentials are valid and have sufficient permissions.
  • Invalid input data: Check that required fields like name and group_id are provided and conform to expected formats.
  • API errors: If the API returns errors related to group type or duplicate group IDs, verify the values against Lark's API documentation.
  • Custom Body usage: When using the custom body option, ensure the JSON structure matches the API requirements exactly; malformed JSON or missing required fields will cause failures.

Links and References

Discussion