Sign in
WhatsApp Phone Numbers

Update commerce settings

Updates a WhatsApp business phone number's commerce settings. Use this endpoint to enable or disable the shopping cart or the product catalog for a specific business phone number.

patch/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings

Path parameters

wabaIdstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

phoneNumberstring required
Example:+16315551111

Phone number in E.164 format.

Request body

isCartEnabledboolean

When enabled, cart-related buttons appear in the conversation, catalog, and product details views. When the cart is disabled, customers can see products and their details, but all cart related buttons will not appear in any view.

isCatalogVisibleboolean

When enabled, the catalog storefront icon and catalog-related buttons appear in conversation and business profile views. When the catalog is disabled, the storefront icon and catalog-related buttons will not appear in any views and the catalog preview with thumbnails will not appear in the business profile view.

Response

Successfully updated the object.

idstring

Unique ID for the object.

isCartEnabledboolean

When enabled, cart-related buttons appear in the conversation, catalog, and product details views. When the cart is disabled, customers can see products and their details, but all cart related buttons will not appear in any view.

isCatalogVisibleboolean

When enabled, the catalog storefront icon and catalog-related buttons appear in conversation and business profile views. When the catalog is disabled, the storefront icon and catalog-related buttons will not appear in any views and the catalog preview with thumbnails will not appear in the business profile view.

Changes

No recorded changes to this endpoint across all 1 revision of this API.