Update SimpleLogin Alias
alias_updateUpdate an existing alias: change display name, note, assigned mailboxes, PGP encryption, or pin status. Provide only fields to modify.
Instructions
Update an existing SimpleLogin alias in place: display name (shown in replies), note, which mailbox(es) receive its mail, PGP on/off, and pinned state. Provide only the fields you want to change; at least one is required. Use alias_list to find the aliasId and alias_list_mailboxes-equivalent workflow (mailbox_ids come from SimpleLogin's dashboard) to retarget delivery.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Display name shown in replies (empty string clears it) | |
| note | No | Free-text note describing what this alias is for | |
| pinned | No | Pin the alias to the top of the SimpleLogin dashboard | |
| aliasId | Yes | ||
| account_id | No | Optional account ID to route this call to (multi-account configs). Omit to use the active account. Configured account IDs are listed in the settings UI (Accounts tab). | |
| disablePgp | No | true disables PGP encryption for forwards to the mailbox | |
| mailboxIds | No | Mailbox IDs that should receive this alias's mail (replaces the current set) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | ||
| success | Yes | ||
| messageId | No |