API atual/Referência completa/WhatsApp: configuração

Ajustes do canal

Lê e grava as chaves que ligam e desligam recursos do WhatsApp da loja e os parâmetros de ajuste fino.

Os ajustes do canal são um único documento por loja: chaves booleanas que ligam recursos (campanhas, mini-loja, pagamento por PIX, assistente, reconhecimento de áudio...) e alguns números de ajuste fino (prazo do carrinho, pausa do bot). A leitura devolve o valor efetivo de cada chave, já com o padrão aplicado. A gravação mescla o que você enviar com o documento atual.

Ler ajustes

GET/api/v1/vendor/whatsapp-confluence/settingsSeller

Retorna o documento de ajustes do canal

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/settings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ajustes

json

{
  "enable_inbox": true,
  "enable_bot": true,
  "enable_ai": true,
  "enable_campaigns": true,
  "enable_web_preview": true,
  "enable_meta_flows": false,
  "enable_pay_pix": true,
  "enable_audio_recognition": false,
  "allow_guest_cart": true,
  "cart_ttl_days": 30
}

Campos da resposta

(chave)boolean

Cada chave de capacidade da tabela da página inicial desta seção aparece sempre, com o valor efetivo. Chaves de ajuste fino (cart_ttl_days e similares) só aparecem depois de gravadas.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
500	Falha ao ler o documento.	`{"error":"..."}`

Quais chaves existem

Grupo	Chaves
Sempre ligadas (o valor enviado é ignorado)	`enable_inbox`, `enable_bot`, `enable_ai`, `enable_human_attendant`, `enable_async_queue`, `enable_templates`, `enable_media_outbound`, `allow_auto_phone_login`
Ligadas por padrão	`enable_campaigns`, `enable_web_preview`, `enable_native_catalog`, `enable_automations`, `enable_channels`, `enable_analytics`, `enable_order_alerts`, `enable_kb`, `enable_multi_number`, `allow_email_login`, `allow_guest_cart`, `cancel_in_chat`, `enable_pay_pix`, `enable_pay_boleto`, `enable_pay_card`, `show_product_barcode`, `show_product_sku`, `show_product_brand`, `show_pack_pricing`, `show_product_weight`, `show_volume_tiers`, `show_stock_count`, `enforce_minimum_order`, `show_wallet_on_bag`, `reuse_saved_document`
Desligadas por padrão	`enable_attendant_presence`, `enable_audio_recognition`, `enable_image_recognition`, `enable_visual_search`, `enable_tts`, `enable_vector_search`, `enable_meta_flows`, `enable_flow_builder`, `enable_canned_replies`, `show_out_of_stock`, `group_products_by_vendor`, `marketplace_all_sellers`, `allow_cnpj_login`, `allow_cpf_login`, `hide_price_until_login`, `show_credit_limit`, `require_document_first`, `enable_company_switch`, `enable_customer_eligibility`, `enable_approval_watch`, `show_tax_breakdown`, `show_stock_origin`, `enable_sales_rep_selection`, `show_product_stickers`, `show_buy_together`, `show_product_reviews`, `show_delivery_forecast`, `show_pdp_shipping_calc`, `cart_virtual_split`, `cart_virtual_item_limit`, `min_order_by_kind`, `handoff_external_routes`, `orders_when_closed`, `credit_limit_silent`, `require_cnpj_for_price`, `find_consultant`, `grouped_payment_conditions`, `pix_manual_receipt`, `payment_link_external`

Gravar ajustes

Envie só as chaves que quer mudar. As chaves que você não enviar continuam como estavam. As chaves marcadas como sempre ligadas são forçadas para true, qualquer que seja o valor enviado.

PUT/api/v1/vendor/whatsapp-confluence/settingsSeller

Mescla chaves no documento de ajustes

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Corpo da requisição

enable_*, allow_*, show_*...boolean

Qualquer chave de capacidade. Veja a lista na leitura acima.

default_languagestring

Idioma padrão de templates e do assistente. Padrão pt-BR.

web_preview_base_pathstring

Prefixo do endereço da mini-loja. Padrão /wa.

cart_ttl_daysinteger

Dias que um carrinho de WhatsApp abandonado é mantido. Padrão 90.

campaign_rate_limit_per_minuteinteger

Teto de envios de campanha por minuto. Padrão 60.

require_marketing_optinboolean

Quando true, campanhas pulam quem não deu consentimento de marketing. Padrão true.

abandoned_cart_delay_hoursinteger

Horas até o lembrete de carrinho abandonado. Padrão 4.

bot_pause_on_echo_minutesinteger

Minutos em que o bot fica pausado numa conversa depois que uma pessoa responde pelo aplicativo WhatsApp Business. Padrão 120.

service_auto_pause_botboolean

Quando true, qualquer resposta de atendente pela caixa de entrada passa a conversa para o atendimento humano. Padrão true.

service_monthly_franchiseinteger

Franquia mensal de mensagens de serviço usada no relatório de Uso e custos. Padrão 1000.

service_franchise_scopestring

accountwabatenant

Como a franquia é contada: por número (account), por conta WhatsApp Business (waba) ou para a loja inteira (tenant). Padrão waba.

service_price_microsinteger

Preço de cada mensagem de serviço acima da franquia, em milionésimos de real (1 real = 1000000). 0 significa desconhecido e zera a estimativa.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enable_campaigns": false,
  "cart_ttl_days": 30,
  "abandoned_cart_delay_hours": 6
}'

Resposta

200Ajustes gravados

json

{
  "status": "ok"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	Falta o privilégio `vendor_settings` ou `vendor_manage_whatsapp`, ou o WhatsApp da loja não é deste seller.	`{"error":"store_whatsapp_owner_required"}`
400	O corpo não é um objeto JSON válido.	`{"error":"invalid request body"}`
500	Falha ao gravar.	`{"error":"..."}`

Veja também

API atual/Referência completa/WhatsApp: configuração

Ajustes do canal

Lê e grava as chaves que ligam e desligam recursos do WhatsApp da loja e os parâmetros de ajuste fino.

Ler ajustes

GET/api/v1/vendor/whatsapp-confluence/settingsSeller

Retorna o documento de ajustes do canal

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/settings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ajustes

json

{
  "enable_inbox": true,
  "enable_bot": true,
  "enable_ai": true,
  "enable_campaigns": true,
  "enable_web_preview": true,
  "enable_meta_flows": false,
  "enable_pay_pix": true,
  "enable_audio_recognition": false,
  "allow_guest_cart": true,
  "cart_ttl_days": 30
}

Campos da resposta

(chave)boolean

Cada chave de capacidade da tabela da página inicial desta seção aparece sempre, com o valor efetivo. Chaves de ajuste fino (cart_ttl_days e similares) só aparecem depois de gravadas.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
500	Falha ao ler o documento.	`{"error":"..."}`

Quais chaves existem

Grupo	Chaves
Sempre ligadas (o valor enviado é ignorado)	`enable_inbox`, `enable_bot`, `enable_ai`, `enable_human_attendant`, `enable_async_queue`, `enable_templates`, `enable_media_outbound`, `allow_auto_phone_login`
Ligadas por padrão	`enable_campaigns`, `enable_web_preview`, `enable_native_catalog`, `enable_automations`, `enable_channels`, `enable_analytics`, `enable_order_alerts`, `enable_kb`, `enable_multi_number`, `allow_email_login`, `allow_guest_cart`, `cancel_in_chat`, `enable_pay_pix`, `enable_pay_boleto`, `enable_pay_card`, `show_product_barcode`, `show_product_sku`, `show_product_brand`, `show_pack_pricing`, `show_product_weight`, `show_volume_tiers`, `show_stock_count`, `enforce_minimum_order`, `show_wallet_on_bag`, `reuse_saved_document`
Desligadas por padrão	`enable_attendant_presence`, `enable_audio_recognition`, `enable_image_recognition`, `enable_visual_search`, `enable_tts`, `enable_vector_search`, `enable_meta_flows`, `enable_flow_builder`, `enable_canned_replies`, `show_out_of_stock`, `group_products_by_vendor`, `marketplace_all_sellers`, `allow_cnpj_login`, `allow_cpf_login`, `hide_price_until_login`, `show_credit_limit`, `require_document_first`, `enable_company_switch`, `enable_customer_eligibility`, `enable_approval_watch`, `show_tax_breakdown`, `show_stock_origin`, `enable_sales_rep_selection`, `show_product_stickers`, `show_buy_together`, `show_product_reviews`, `show_delivery_forecast`, `show_pdp_shipping_calc`, `cart_virtual_split`, `cart_virtual_item_limit`, `min_order_by_kind`, `handoff_external_routes`, `orders_when_closed`, `credit_limit_silent`, `require_cnpj_for_price`, `find_consultant`, `grouped_payment_conditions`, `pix_manual_receipt`, `payment_link_external`

Gravar ajustes

Envie só as chaves que quer mudar. As chaves que você não enviar continuam como estavam. As chaves marcadas como sempre ligadas são forçadas para true, qualquer que seja o valor enviado.

PUT/api/v1/vendor/whatsapp-confluence/settingsSeller

Mescla chaves no documento de ajustes

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Corpo da requisição

enable_*, allow_*, show_*...boolean

Qualquer chave de capacidade. Veja a lista na leitura acima.

default_languagestring

Idioma padrão de templates e do assistente. Padrão pt-BR.

web_preview_base_pathstring

Prefixo do endereço da mini-loja. Padrão /wa.

cart_ttl_daysinteger

Dias que um carrinho de WhatsApp abandonado é mantido. Padrão 90.

campaign_rate_limit_per_minuteinteger

Teto de envios de campanha por minuto. Padrão 60.

require_marketing_optinboolean

Quando true, campanhas pulam quem não deu consentimento de marketing. Padrão true.

abandoned_cart_delay_hoursinteger

Horas até o lembrete de carrinho abandonado. Padrão 4.

bot_pause_on_echo_minutesinteger

Minutos em que o bot fica pausado numa conversa depois que uma pessoa responde pelo aplicativo WhatsApp Business. Padrão 120.

service_auto_pause_botboolean

Quando true, qualquer resposta de atendente pela caixa de entrada passa a conversa para o atendimento humano. Padrão true.

service_monthly_franchiseinteger

Franquia mensal de mensagens de serviço usada no relatório de Uso e custos. Padrão 1000.

service_franchise_scopestring

accountwabatenant

Como a franquia é contada: por número (account), por conta WhatsApp Business (waba) ou para a loja inteira (tenant). Padrão waba.

service_price_microsinteger

Preço de cada mensagem de serviço acima da franquia, em milionésimos de real (1 real = 1000000). 0 significa desconhecido e zera a estimativa.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enable_campaigns": false,
  "cart_ttl_days": 30,
  "abandoned_cart_delay_hours": 6
}'

Resposta

200Ajustes gravados

json

{
  "status": "ok"
}

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	Falta o privilégio `vendor_settings` ou `vendor_manage_whatsapp`, ou o WhatsApp da loja não é deste seller.	`{"error":"store_whatsapp_owner_required"}`
400	O corpo não é um objeto JSON válido.	`{"error":"invalid request body"}`
500	Falha ao gravar.	`{"error":"..."}`