Lark Email icon

Lark Email

Lark Email Management

Actions30

Overview

This node allows you to create a member in a mailing list (mail group) within the Lark Email system. It is useful for automating the management of email distribution lists by programmatically adding new members based on their email, user ID, or department ID. Typical use cases include onboarding workflows where new employees are automatically added to relevant mailing lists, or marketing campaigns where contacts are dynamically grouped.

For example, you can add a user to a mailing list by specifying their email address and the target mail group ID, streamlining communication setup without manual intervention.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Mailgroup Id The unique identifier or email address of the mailing list to which the member will be added. (Required)
Department Id The department ID associated with the member to add.
Email The email address of the member to add to the mailing list.
Type The type/category of the member (e.g., user, department).
User Id The user ID of the member to add.
Custom Body A JSON object allowing you to specify a custom request body for the API call instead of using the standard fields. Useful for advanced or non-standard use cases.
Options > Use Custom Body Boolean flag indicating whether to send the custom JSON body instead of the standard parameters.

Output

The node outputs JSON data representing the response from the Lark Email API after attempting to add the member to the mailing list. This typically includes confirmation details such as the status of the operation and any metadata about the newly created mailing list member.

If the operation supports binary data output (not indicated here), it would represent attachments or related files, but this node focuses on JSON responses only.

Dependencies

  • Requires an active connection to the Lark Suite Open APIs.
  • Needs one of the following authentication credentials configured in n8n:
    • An API token credential (referred to as "Tenant Token").
    • OAuth2 authentication credential.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions on the Lark tenant to manage mailing list members.

Troubleshooting

  • Common Issues:

    • Invalid or expired authentication tokens will cause authorization errors.
    • Providing an incorrect or non-existent mailing list ID will result in not found or validation errors.
    • Missing required fields like Mailgroup Id or Email may cause the API to reject the request.
    • Using the custom body option incorrectly formatted JSON can lead to request failures.

  • Error Messages:

    • 401 Unauthorized: Check that your authentication credentials are valid and have not expired.
    • 404 Not Found: Verify the mailing list ID exists and is accessible.
    • 400 Bad Request: Ensure all required fields are provided and correctly formatted; if using custom body, validate JSON syntax.

  • To resolve issues, verify credentials, confirm resource IDs, and test API calls independently if needed.

Links and References

Discussion