Lark Email icon

Lark Email

Lark Email Management

Overview

The node "Lark Email" provides functionality to manage public mailboxes within the Lark platform. Specifically, the "Update A Public Mailbox" operation allows users to modify details of an existing public mailbox by specifying its unique identifier or address. This is useful in scenarios where administrators need to rename a public mailbox or update its metadata without recreating it.

Practical examples include:

  • Renaming a shared team mailbox to reflect a new project name.
  • Updating mailbox properties dynamically based on organizational changes.
  • Automating mailbox management workflows integrated with other systems.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: Tenant Token, OAuth2
Public Mailbox Id Unique identifier or email address of the public mailbox to update (required)
Name New name to assign to the public mailbox
Use Custom Body Boolean flag indicating whether to send a custom JSON body instead of the standard one
Custom Body JSON object representing a fully custom request body to send when updating the public mailbox

Output

The node outputs JSON data representing the response from the Lark API after attempting to update the public mailbox. This typically includes confirmation of the updated mailbox details or error information if the update failed.

No binary data output is involved.

Dependencies

  • Requires an API authentication token, either via a Tenant Token credential or OAuth2 credential configured in n8n.
  • Connects to the Lark Suite Open APIs at https://open.larksuite.com/open-apis.
  • The user must have appropriate permissions to update public mailboxes in their Lark environment.

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 retrying.
  • Authentication Errors: Using invalid or expired credentials will cause authentication failures. Ensure that the API key or OAuth2 token is valid and has necessary scopes.
  • Malformed Custom Body: When using the "Use Custom Body" option, ensure the JSON is correctly formatted and contains all required fields expected by the API.
  • Permission Denied: Lack of sufficient privileges to update mailboxes will result in authorization errors. Confirm user roles and permissions in Lark admin settings.

Links and References

Discussion