---
title: "Update sender"
method: PATCH
path: "/v1/senders/{senderId}"
---

# Update sender

`PATCH /v1/senders/{senderId}`

## Request

- Base URL: `https://api.zavu.dev`
- URL: `https://api.zavu.dev/v1/senders/{senderId}`
- Auth: HTTP bearer

## Path parameters

- `senderId` string, required

## Request body

- SenderUpdateRequest
  - `name` string
  - `enableVoice` boolean: Turn the voice channel on or off. The sender must already have a phone number provisioned for calls; enabling it otherwise returns 400 instead of storing a flag that changes nothing. Confirm with the `channels` array on the response.
  - `enableSmsOneway` boolean: Turn the one-way SMS channel on or off. Enabling needs no number or credential and takes effect immediately (US and Canadian destinations still need an approved 10DLC campaign); disabling removes the channel from the sender. Confirm with the `channels` array on the response.
  - `setAsDefault` boolean
  - `webhookUrl` string, uri, nullable: HTTPS URL for webhook events. Set to null to remove webhook.
  - `webhookEvents` WebhookEvent[]: Events to subscribe to.
  - `webhookActive` boolean: Whether the webhook is active.
  - `emailReceivingEnabled` boolean: Enable or disable inbound email receiving for this sender. Enabling requires a verified inbound MX record on the domain; the request is ignored otherwise, and `emailReceivingEnabled` comes back `false` on the response. Disabling always applies.
  - `emailCatchAllEnabled` boolean: Enable or disable domain catch-all. When enabled (with emailReceivingEnabled true), this sender receives email for any address at its domain. Ignored (treated as false) if receiving is not enabled.
  - `emailAddress` string, email: Attach or change the sender's email from-address (e.g. noreply@yourdomain.com). The domain must be a verified email domain in your project.
  - `emailDomainId` string: ID of the verified email domain to attach. Optional — resolved from `emailAddress`'s domain when omitted.
  - `emailFromName` string: Display name shown in the recipient's inbox for the email channel.
  - `webhookSignatureVersion` 'v1' | 'v1+v2' | 'v2': Which `X-Zavu-Signature` scheme this receiver is sent. - `v1`: `v1=HMAC_SHA256(secret, body)`. The scheme used before this was configurable. Existing webhooks stay on it until you move them. - `v2`: `v2=HMAC_SHA256(secret, "{t}.{body}")`. The current scheme, and the default for new senders. It signs the timestamp together with the body. - `v1+v2`: both signatures, sharing one `t`. The migration setting: a receiver reading either one works, so you can deploy and confirm your new verifier before switching over. Moving from `v1` straight to `v2` returns `400`. Set `v1+v2` first. See https://docs.zavu.dev/guides/receiving-messages/signature-migration

## Response `200`

Sender updated.

- Sender
  - `id` string, required
  - `name` string, required
  - `phoneNumber` string: Phone number in E.164 format. Absent on a sender that has none: an email-only sender, or one created with only `enableSmsOneway`.
  - `channels` string[]: Channels this sender can actually send on right now: configured AND activated. Empty means the sender cannot send or receive anything yet: a phoneNumber alone does not enable SMS or voice, and a connected account that is not activated is left out, because every send on it is refused. Check this rather than inferring capability from phoneNumber or emailAddress, and turn a connected channel on with `POST /v1/senders/{senderId}/channels/{channel}/activate`.
  - `isDefault` boolean: Whether this sender is the project's default.
  - `webhook` SenderWebhook: Webhook configuration for the sender.
    - `url` string, uri, required: HTTPS URL that will receive webhook events.
    - `events` WebhookEvent[], required: List of events the webhook is subscribed to.
    - `secret` string: Webhook secret for signature verification. Only returned on create or regenerate.
    - `active` boolean, required: Whether the webhook is active.
    - `signatureVersion` 'v1' | 'v1+v2' | 'v2', required: Which `X-Zavu-Signature` scheme this receiver is sent. - `v1`: `v1=HMAC_SHA256(secret, body)`. The scheme used before this was configurable. Existing webhooks stay on it until you move them. - `v2`: `v2=HMAC_SHA256(secret, "{t}.{body}")`. The current scheme, and the default for new senders. It signs the timestamp together with the body. - `v1+v2`: both signatures, sharing one `t`. The migration setting: a receiver reading either one works, so you can deploy and confirm your new verifier before switching over. Moving from `v1` straight to `v2` returns `400`. Set `v1+v2` first. See https://docs.zavu.dev/guides/receiving-messages/signature-migration
  - `whatsapp` object: WhatsApp Business Account information. Only present if a WABA is connected.
    - `phoneNumberId` string: WhatsApp phone number ID from Meta.
    - `displayPhoneNumber` string: Display phone number.
    - `paymentStatus` object: Payment configuration status from Meta.
      - `setupStatus` string: Payment setup status (COMPLETE, NOT_STARTED, etc.).
      - `methodStatus` string: Payment method status (VALID, NONE, etc.).
      - `canSendTemplates` boolean: Whether template messages can be sent. Requires setupStatus=COMPLETE and methodStatus=VALID.
  - `emailAddress` string: From-address for the email channel, if configured.
  - `emailReceivingEnabled` boolean: Whether inbound email receiving is enabled for this sender.
  - `emailCatchAllEnabled` boolean: Whether catch-all receiving is enabled. When true (and emailReceivingEnabled is true), this sender receives email addressed to any local part at its domain, not just its own address. The original recipient is delivered in the message.inbound webhook's data.to.
  - `createdAt` string, date-time
  - `updatedAt` string, date-time

## Other responses

- `400`: Invalid update.
- `401`: Unauthorized.
- `404`: Sender not found.

## Changes

> 80 revisions in range; 1 not diffed.

- **2026-10-23** `ce129d29ce3c`: 1 warning, 1 info
  - added the new `contact.identity_linked` enum value to the `webhook/events/items/` response property for the response status `200`
  - added the new `contact.identity_linked` enum value to the request property `webhookEvents/items/`
- **2026-08-07** `358ec4c351c6`: 2 info
  - added the new optional request property `webhookSignatureVersion`
  - added the required property `webhook/signatureVersion` to the response with the `200` status
- **2026-08-05** `07b87b6ae707`: 1 info
  - added the new optional request property `enableSmsOneway`
- **2026-07-27** `7bedd013ec33`: 1 info
  - added the new optional request property `enableVoice`
- **2026-07-27** `dafd7726c168`: 1 info
  - added the optional property `channels` to the response with the `200` status

[Operation history](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api/changes/v1/senders/:senderId/patch.md)

---

[API](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api.md) - [All operations](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api/revisions/75bc777b0ffb?raw)