hornet icon

hornet

Interact with hornet API

Actions452

Mailboxes → Mailboxes Rename Post

AI-generated

Summary

Renames a mailbox via a POST request to the Hornet API.

Inputs

  • object_id — The ID of an object (user, customer, or partner). Used as a query parameter when provided. Defaults to 0 if omitted or set to its default value. Sent as the query parameter object_id.
  • mailbox_id — ID of a mailbox. Used as a query parameter when provided (takes precedence over object_id if both are given). Defaults to 0 if omitted or set to its default value. Sent as the query parameter mailbox_id.
  • APP-ID (required) — Application identifier issued by Hornet Security. Sent as a request header APP-ID.
  • new_name (required) — The new name or email address for the mailbox. Sent in the request body as the property new_name.
  • requestOptions — Collection of advanced HTTP settings (batching, SSL verification, proxy, timeout). These options are passed through to the underlying request.

Output shape

object

The node returns the raw JSON response from the Hornet API endpoint for the mailbox rename operation. The exact shape depends on the API, but typically includes details of the updated mailbox (e.g., ID, name, status).

Examples

Example 1: Rename a mailbox when you know both the object and mailbox IDs.

Set object_id to 12345, mailbox_id to 67890, provide your APP-ID, and specify the desired new_name. The node will POST to the Hornet API with these values as query parameters and body.

Example 2: Rename a mailbox using only the mailbox ID.

Leave object_id at its default (0), set mailbox_id to the target mailbox ID, supply the required headers and body. The node will use only mailbox_id as the query parameter.

Links

Discussion