Lark Email icon

Lark Email

Lark Email Management

Overview

The node allows modifying a public mailbox in the Lark Email system. It is useful for updating details such as the name of a public mailbox identified by its unique ID or address. This can be beneficial in scenarios where an organization needs to rename or update metadata of shared mailboxes used by teams or departments.

For example, if a team’s public mailbox changes its purpose or ownership, this node can update the mailbox's display name accordingly without needing to recreate it.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Public Mailbox Id Unique identifier or email address of the public mailbox to modify (required).
Name New name to assign to the public mailbox.
Options > Use Custom Body Boolean flag indicating whether to send a custom JSON body instead of the standard one.

If "Use Custom Body" is enabled, the user can provide a full custom JSON payload to send in the request body, allowing advanced customization beyond just changing the name.

Output

The node outputs the response from the Lark Email API after attempting to modify the public mailbox. The output is structured as JSON data representing the updated mailbox information or any error messages returned by the API.

No binary data output is involved.

Dependencies

  • Requires an active connection to the Lark Suite Open APIs.
  • Needs either a Tenant Token credential or OAuth2 authentication configured in n8n.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions on the authenticated account to modify public mailboxes.

Troubleshooting

  • Invalid Public Mailbox Id: If the provided mailbox ID or address is incorrect or does not exist, the API will return an error. Verify the mailbox identifier before running the node.
  • Authentication Errors: Using invalid or expired credentials will cause authentication failures. Ensure that the Tenant Token or OAuth2 token is valid and has necessary scopes.
  • Custom Body Format Issues: When using a custom JSON body, malformed JSON or missing required fields may cause the API to reject the request. Validate the JSON structure carefully.
  • Permission Denied: The authenticated user must have rights to modify the specified public mailbox; otherwise, the API will deny the operation.

Links and References

Discussion