Lark Contacts icon

Lark Contacts

Lark Contacts Management

Overview

This node operation removes one or more members from a specified user group within the Lark Contacts system. It is useful for managing membership dynamically, such as when users leave a team or need to be excluded from certain communications or permissions associated with a user group.

Typical use cases include:

  • Automating the removal of former employees or contractors from internal communication groups.
  • Managing access control by updating group memberships based on role changes.
  • Synchronizing user group memberships with external systems by programmatically removing outdated members.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: Tenant Token, OAuth2
Group Id The unique identifier of the user group from which members will be removed
Member Id Identifier of the member to remove from the group
Member Id Type Specifies the type of the member ID (e.g., user ID, email)
Member Type Type of the member (e.g., user, bot, etc.)
Custom Body JSON object allowing custom request body definition for advanced use cases
Use Custom Body Boolean flag indicating whether to send a custom JSON body instead of the standard parameters

Output

The node outputs JSON data representing the response from the Lark Contacts API after attempting to remove the specified member(s) from the user group. This typically includes status information about the success or failure of the removal operation.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Lark Suite Open APIs.
  • Needs either a Tenant Token or OAuth2 authentication configured in n8n credentials.
  • Network access to https://open.larksuite.com/open-apis must be available.

Troubleshooting

  • Common Issues:

    • Invalid or expired authentication tokens can cause authorization failures.
    • Incorrect or non-existent Group Id or Member Id values will result in errors indicating that the resource was not found.
    • Using an incorrect Member Id Type or Member Type may cause the API to reject the request.
  • Error Messages and Resolutions:

    • 401 Unauthorized: Check that the authentication credentials are valid and have not expired.
    • 404 Not Found: Verify that the Group Id and Member Id are correct and exist in the system.
    • 400 Bad Request: Ensure that all required fields are provided and correctly formatted; if using a custom body, validate its JSON structure.

Links and References

Discussion