Actions30
- Mail Group Actions
- Mail Group Member Actions
- Mail Group Permission Member Actions
- Mail Group Alias Actions
- Public Mailbox Actions
- Public Mailbox Member Actions
- Public Mailbox Alias Actions
Overview
This node allows users to update an existing mailing list (mail group) in the Lark Email system. It is useful for managing email distribution lists by modifying their attributes such as name, description, and permissions on who can send emails to the list. Typical use cases include updating mailing list details when team structures change or adjusting access controls for sending emails.
For example, a user might update a mailing list's description to reflect a new project focus or restrict sending permissions to certain roles within an organization.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests; options are "Tenant Token" or "OAuth2". |
| Mailgroup Id | The unique identifier or email address of the mailing list to update (required). |
| Description | New description text for the mailing list. |
| Name | New display name for the mailing list. |
| Who Can Send Mail | Defines who is allowed to send emails to this mailing list (e.g., members only, anyone). |
| Custom Body | JSON object allowing full customization of the request body sent to the API instead of using individual fields. |
| Options > Use Custom Body | Boolean flag to indicate whether to send a custom JSON body instead of individual properties. |
Output
The node outputs JSON data representing the response from the Lark Email API after attempting to update the mailing list. This typically includes confirmation of the updated mailing list details or error information if the update failed.
No binary data output is involved.
Dependencies
- Requires an active connection to the Lark Suite Open APIs.
- Needs either a Tenant Token or OAuth2 authentication credential configured in n8n.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper permissions on the mailing list resource are necessary to perform updates.
Troubleshooting
- Common Issues:
- Invalid or missing mailing list ID will cause the update to fail.
- Insufficient permissions due to incorrect or expired authentication tokens.
- Malformed JSON in the custom body option may result in API errors.
- Error Messages:
- "Unauthorized" or "Authentication failed": Check that the API credentials are valid and have not expired.
- "Mailing list not found": Verify the mailing list ID or address is correct.
- "Invalid request body": Ensure that the custom JSON body is properly formatted and matches API expectations.
- To resolve these issues, verify input parameters, refresh credentials, and consult the Lark API documentation for correct request formats.
Links and References
- Lark Suite Open API Documentation
- Managing Mailing Lists with Lark Email API (example section)