Skip to main content

Update message settings

PATCH 

/api/v1/domains/:domain_uuid/message-settings/:sms_destination_uuid

Changes a messaging phone number's configuration. All fields are optional; omitted fields retain their current values except that custom webhook delivery clears local members and email. When supplied, allowed_extension_uuids replaces the entire access list. Send [] to remove all extension access. Send null to clear the email recipient, description, or provider.

To switch from local members to a webhook, send inbound_delivery: "webhook" and inbound_webhook_url: "https://example.com/messages". This removes existing members and email. To switch back, send inbound_delivery: "members" and the desired members/email; removed assignments are not restored automatically. Choose inherit to follow the account webhook, or members/email when none is set.

Omit the URL to keep the saved custom URL, including when reselecting webhook mode. A URL-only update keeps the delivery mode. The URL cannot be cleared while the resulting mode is webhook; select members or inherit to clear it with null. All supplied URLs must use HTTPS and resolve to public IP addresses.

The account signing secret is reused, or generated if none exists. It is omitted from every API response and cannot be changed here. Retrieve it through Account Settings > Messaging or the number's Message Settings form with messaging management permission. Webhooks sign the raw JSON body with HMAC-SHA256 in the Signature header. Delivery changes apply to new messages; previously received messages keep their route. Requires account access and message_settings_manage.

Request​

Responses​