Update alias
alias_updateUpdate an existing SimpleLogin alias by changing its note, display name, mailbox routing, PGP setting, or pinned status. Only supplied fields change.
Instructions
Update an existing alias. Provide at least one field to change: note, display name, the owning mailbox (mailbox_id) or full mailbox set (mailbox_ids), whether PGP is disabled, and whether the alias is pinned. Only the provided fields change. mailbox_id and mailbox_ids are mutually exclusive, and a call that changes nothing is rejected without contacting SimpleLogin. Replacing mailboxes can stop future mail from landing in removed mailboxes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Replace the alias display name. | |
| note | No | Replace the alias note. | |
| pinned | No | Pin or unpin the alias. | |
| alias_id | Yes | Numeric id of the alias to update. | |
| mailbox_id | No | Set a single owning mailbox by id, replacing current alias mailbox routing. | |
| disable_pgp | No | Disable PGP on this alias even if a mailbox supports it. | |
| mailbox_ids | No | Replace the full set of owning mailboxes by id. |