Atriomail icon

Atriomail

Manage email domains, mailboxes, forwarders, and catch-all configurations with Atriomail

Forwarder → Update

AI-generated

Summary

Update an existing email forwarder by specifying its ID and modifying properties such as active status, forwarding email addresses, and a private comment.

Inputs

  • Forwarder ID (required) — The ID of the forwarder to update.
  • Update Fields — Fields to update on the forwarder, including whether it is active, the list of forwarding email addresses (comma-separated), and a private comment.

Output shape

A single JSON object representing the updated forwarder.

The operation returns the updated forwarder data from the Atriomail API. The forwarding addresses are supplied as a comma-separated string but sent as an array to the API.

Examples

Example 1: Update the forwarder to be active, set new forwarding addresses, and add a private comment.

Provide the Forwarder ID, set 'Active' to true or false, input a comma-separated list of emails for 'Forward To', and add a 'Private Comment' if needed.

Discussion