Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

Update sender

patch/v1/senders/{senderId}

Path parameters

senderIdstring required

Request body

namestring
enableVoiceboolean

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.

setAsDefaultboolean
webhookUrlstring uri nullable

HTTPS URL for webhook events. Set to null to remove webhook.

webhookEventsWebhookEvent[]

Events to subscribe to.

webhookActiveboolean

Whether the webhook is active.

emailReceivingEnabledboolean

Enable or disable inbound email receiving for this sender.

emailCatchAllEnabledboolean

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.

emailAddressstring 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.

emailDomainIdstring

ID of the verified email domain to attach. Optional — resolved from emailAddress's domain when omitted.

emailFromNamestring

Display name shown in the recipient's inbox for the email channel.

Example request

{
  "emailAddress": "noreply@yourdomain.com"
}

Response

Sender updated.

idstring required
namestring required
phoneNumberstring required

Phone number in E.164 format.

channelsstring[]

Channels this sender can actually send on right now, computed from its configuration. Empty means the sender cannot send or receive anything yet: a phoneNumber alone does not enable SMS or voice. Check this rather than inferring capability from phoneNumber or emailAddress.

isDefaultboolean

Whether this sender is the project's default.

emailAddressstring

From-address for the email channel, if configured.

emailReceivingEnabledboolean

Whether inbound email receiving is enabled for this sender.

emailCatchAllEnabledboolean

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.

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "sender_12345",
  "name": "Primary sender",
  "phoneNumber": "+13125551212",
  "channels": [
    "sms",
    "voice"
  ],
  "webhook": {
    "url": "https://api.example.com/webhooks/zavu",
    "secret": "whsec_abc123..."
  },
  "whatsapp": {
    "displayPhoneNumber": "+14155551234",
    "paymentStatus": {
      "setupStatus": "COMPLETE",
      "methodStatus": "VALID"
    }
  },
  "emailAddress": "noreply@yourdomain.com"
}