---
title: "Update private email address forwarding and metadata"
method: PUT
path: "/addresses/{email}"
tags: ["Addresses"]
---

# Update private email address forwarding and metadata

`PUT /addresses/{email}`

For a private email address, set it to forward to another place.

It can be forwarded to another email (with `via mailsac` indicator), to a websocket, to a webhook,
or to a Slack channel.

## Request body

- UpdatePrivateAddressForwarding — body object to update address forwarding
  - `info` string — User configurable metadata about this enhanced private address.
  - `forward` string — email address - SMTP forwarding / standard email forwarding - set to "" or null to disable forwarding
  - `enablews` boolean — boolean, defaults false - set to true to enable web socket forwarding (see Web Socket API)
  - `webhook` string — url - set to your public webhook endpoint to receive mail via webhook - set to "" or null to disable webhooks
  - `webhookSlack` string — Slack webhook URL where messages will be published.
  - `webhookSlackToFrom` boolean — When webhookSlack is set, controls whether the message includes TO and FROM

## Response `200`

email forwarding successfully configured

## Other responses

- `401` — Not authorized. You may need to log in first.

---

[API](https://skmtc.dev/mailsac/apis/mailsac-api-specification.md) · [All operations](https://skmtc.dev/mailsac/apis/mailsac-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mailsac/mailsac-api-specification/revisions/5f8b55c76229/schema)