Lark Email icon

Lark Email

Lark Email Management

Overview

This node enables the creation of a mailing list (mail group) within the Lark Email system. It is useful for automating the management of email distribution groups, allowing users to programmatically create new mailing lists with specific attributes such as name, description, and permissions on who can send emails to the group.

Common scenarios include:

  • Automatically setting up mailing lists for new projects or teams.
  • Managing communication channels by creating targeted email groups.
  • Integrating with other systems to dynamically manage email groups based on organizational changes.

For example, a company could use this node to create a mailing list named "Marketing Team" with a description and specify that only team members can send emails to it.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Description Text description of the mailing list being created.
Email The email address associated with the mailing list.
Name The display name of the mailing list.
Who Can Send Mail Defines who is allowed to send emails to this mailing list (e.g., all members, admins only).
Custom Body A JSON object allowing the user to provide a fully custom request body instead of individual fields.
Options → Use Custom Body Boolean flag to indicate whether to use the custom JSON body instead of the standard fields.

Output

The node outputs JSON data representing the response from the Lark Email API after attempting to create the mailing list. This typically includes details about the newly created mailing list such as its ID, name, email, description, and permissions.

If the operation is successful, the output JSON will confirm the creation and provide relevant metadata. If there is an error, the output will contain error information.

The node does not output binary data.

Dependencies

  • Requires access to the Lark Suite Open APIs endpoint at https://open.larksuite.com/open-apis.
  • Requires authentication via either a Tenant Token or OAuth2 credentials configured in n8n.
  • The node sends requests with Content-Type: application/json and expects JSON responses.

Troubleshooting

  • Authentication errors: Ensure that the correct authentication method is selected and that valid credentials are provided. Invalid or expired tokens will cause failures.
  • Invalid input data: Missing required fields like email or name may result in API errors. Verify that all mandatory properties are correctly set.
  • API rate limits or network issues: Temporary failures might occur due to rate limiting or connectivity problems. Retrying after some time or checking network settings can help.
  • Custom Body usage: When using the custom JSON body option, ensure the JSON structure matches the API requirements exactly; malformed JSON or incorrect fields will cause errors.

Links and References

Discussion