Update domain address
updateDomainAddressChange an address on a domain: its label, whether it takes mail, whether it keeps the original of every message it receives, where its mail goes (destination, webhookId, tapWebhookIds), when it expires (expiresAt, onExpiry) and, for a group, who may post (groupPosting, groupKeepCopy). A disabled address keeps its settings, and enabling it again restores it. An empty label clears it.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"domain": "<domain>",
"address": "<address>"
},
"name": "updateDomainAddress"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | ||
| domain | Yes | The domain, by its id or by its name (example.com). listDomains names every one. | |
| address | Yes | The address, by its id, by the whole address (sales@example.com) or by the part before the @. listDomainAddresses names every one. | |
| enabled | No | ||
| onExpiry | No | What happens when the address expires. stop switches it off and keeps its mail, and delete removes the address and the conversations delivered to it. | |
| expiresAt | No | When the address expires, an RFC 3339 time from 60 seconds to 10 years ahead. Null keeps it for good. Setting it on an address that expired turns the address back on. | |
| webhookId | No | The webhook endpoint mail goes to while destination is webhook, an id that listWebhooks gives. Pass it with destination webhook. | |
| destination | No | Where mail to the address goes. mailbox keeps it here, forward only forwards it and needs a forwarding destination that is on, webhook sends every message to the endpoint in webhookId and keeps none here, and group sends it to the group members of the address. | |
| groupPosting | No | Who may send to a group address: anyone, members (its group members), or workspace (any address on a domain of this workspace). | |
| keepOriginal | No | True keeps every message the address receives from now on byte for byte as it arrived, so getRawMessage returns that original instead of a source rebuilt from the stored message. False stops keeping new ones. Originals already kept stay with their messages. | |
| groupKeepCopy | No | Whether a group address also keeps a copy of each message in its own mailbox. | |
| tapWebhookIds | No | Up to 5 webhook endpoints that also get every message the address receives, as ids that listWebhooks gives. An empty list or null stops them. |