Update custom domain
custom_domain_updateChange a SimpleLogin custom domain's catch-all, random-prefix, From name, or mailbox routing. Only supplied fields are updated, and the revised domain is returned.
Instructions
Update a custom domain. Provide at least one change: catch_all toggles whether mail to any unknown address on the domain auto-creates an alias; random_prefix_generation toggles random prefixes for on-the-fly aliases; name sets the display name used as the From name on the domain (null clears it); mailbox_ids replaces the full set of mailboxes receiving the domain's mail (1 to 20 ids from mailbox_list). Only the provided fields change, a call that changes nothing is rejected without contacting SimpleLogin, and the updated domain is returned. Disabling catch_all or replacing mailbox_ids can stop future delivery for affected domain addresses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Display name used as the From name for the domain's aliases; null clears it. | |
| catch_all | No | Auto-create an alias when mail arrives for an unknown address on the domain; false disables that catch-all routing. | |
| mailbox_ids | No | Replace the full set of mailboxes that receive the domain's mail, by id. | |
| custom_domain_id | Yes | Numeric id of the custom domain to update. | |
| random_prefix_generation | No | Use a random prefix instead of the address when auto-creating aliases. |