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

Configurações do canal

Lê e altera os interruptores de recursos e os ajustes de uso do WhatsApp da loja.

Ler as configurações

Devolve o documento de configuração do canal: um objeto plano com dezenas de interruptores booleanos e alguns ajustes de uso. Para cada interruptor, a resposta traz o valor efetivo: o que a loja gravou ou, se nunca gravou, o padrão da plataforma.

GET/api/v1/admin/whatsapp-confluence/settingsAdmin

Lê as configurações do WhatsApp

Exemplo de requisição

bash

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

Resposta

200Configurações

json

{
  "enable_inbox": true,
  "enable_bot": true,
  "enable_ai": true,
  "enable_campaigns": true,
  "enable_web_preview": true,
  "enable_meta_flows": false,
  "enable_native_catalog": true,
  "enable_pay_pix": true,
  "enable_pay_boleto": true,
  "enable_pay_card": true,
  "show_product_sku": true,
  "hide_price_until_login": false,
  "enforce_minimum_order": true,
  "allow_guest_cart": true,
  "cancel_in_chat": true,
  "marketplace_all_sellers": false
}

Campos da resposta

enable_inbox / enable_bot / enable_ai / enable_human_attendant / enable_templates / enable_media_outbound / enable_async_queue / allow_auto_phone_login

boolean

Recursos essenciais: sempre true.

enable_campaigns / enable_analytics / enable_native_catalog / enable_automations / enable_order_alerts / enable_kb / enable_channels / enable_multi_number

boolean

Recursos do canal, ligados por padrão.

enable_web_previewboolean

Liga a mini-loja que abre pelo link da conversa. Padrão ligado.

enable_meta_flowsboolean

Compra dentro de um fluxo nativo do WhatsApp (WhatsApp Flows). Padrão desligado. Ligar força enable_web_preview para false.

enable_pay_pix / enable_pay_boleto / enable_pay_cardboolean

Formas de pagamento oferecidas na conversa. Padrão ligadas.

enable_audio_recognition / enable_image_recognition / enable_visual_search / enable_tts / enable_vector_searchboolean

Recursos avançados de IA com custo próprio. Padrão desligados.

allow_email_login / allow_cpf_login / allow_cnpj_login / allow_guest_cartboolean

Como o cliente se identifica e se pode montar carrinho sem conta.

show_*boolean

O que a mini-loja mostra (SKU, marca, peso, estoque, avaliações, previsão de entrega...).

hide_price_until_login / enforce_minimum_order / cancel_in_chat / marketplace_all_sellers / require_document_first / ...boolean

Regras de venda opcionais. Padrão desligadas, exceto enforce_minimum_order e cancel_in_chat, que vêm ligadas.

(outras chaves)any

Ajustes de uso gravados pela loja (idioma padrão, tempo de vida do carrinho, franquia de mensagens...). Aparecem só depois de gravados.

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Alterar as configurações

Grava interruptores e ajustes. O corpo é um objeto plano; as chaves enviadas são mescladas às que já existem (as que você não enviar ficam como estão). Os recursos essenciais são forçados para true em toda gravação.

PUT/api/v1/admin/whatsapp-confluence/settingsAdmin

Altera as configurações do WhatsApp

Corpo da requisição

(qualquer chave)any

Qualquer chave listada em Ler as configurações. Booleanos para interruptores; números e textos para ajustes de uso.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/whatsapp-confluence/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enable_campaigns": false, "show_product_reviews": true}'

Resposta

200Configurações salvas

json

{
  "status": "ok"
}

Campos da resposta

statusstring

Sempre ok quando gravou.

Erros

Status	Quando	Corpo de exemplo
400	Corpo não é um objeto JSON.	`{"error":"invalid request body"}`
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Veja também

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

Configurações do canal

Lê e altera os interruptores de recursos e os ajustes de uso do WhatsApp da loja.

Ler as configurações

GET/api/v1/admin/whatsapp-confluence/settingsAdmin

Lê as configurações do WhatsApp

Exemplo de requisição

bash

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

Resposta

200Configurações

json

{
  "enable_inbox": true,
  "enable_bot": true,
  "enable_ai": true,
  "enable_campaigns": true,
  "enable_web_preview": true,
  "enable_meta_flows": false,
  "enable_native_catalog": true,
  "enable_pay_pix": true,
  "enable_pay_boleto": true,
  "enable_pay_card": true,
  "show_product_sku": true,
  "hide_price_until_login": false,
  "enforce_minimum_order": true,
  "allow_guest_cart": true,
  "cancel_in_chat": true,
  "marketplace_all_sellers": false
}

Campos da resposta

enable_inbox / enable_bot / enable_ai / enable_human_attendant / enable_templates / enable_media_outbound / enable_async_queue / allow_auto_phone_login

boolean

Recursos essenciais: sempre true.

enable_campaigns / enable_analytics / enable_native_catalog / enable_automations / enable_order_alerts / enable_kb / enable_channels / enable_multi_number

boolean

Recursos do canal, ligados por padrão.

enable_web_previewboolean

Liga a mini-loja que abre pelo link da conversa. Padrão ligado.

enable_meta_flowsboolean

Compra dentro de um fluxo nativo do WhatsApp (WhatsApp Flows). Padrão desligado. Ligar força enable_web_preview para false.

enable_pay_pix / enable_pay_boleto / enable_pay_cardboolean

Formas de pagamento oferecidas na conversa. Padrão ligadas.

enable_audio_recognition / enable_image_recognition / enable_visual_search / enable_tts / enable_vector_searchboolean

Recursos avançados de IA com custo próprio. Padrão desligados.

allow_email_login / allow_cpf_login / allow_cnpj_login / allow_guest_cartboolean

Como o cliente se identifica e se pode montar carrinho sem conta.

show_*boolean

O que a mini-loja mostra (SKU, marca, peso, estoque, avaliações, previsão de entrega...).

hide_price_until_login / enforce_minimum_order / cancel_in_chat / marketplace_all_sellers / require_document_first / ...boolean

Regras de venda opcionais. Padrão desligadas, exceto enforce_minimum_order e cancel_in_chat, que vêm ligadas.

(outras chaves)any

Ajustes de uso gravados pela loja (idioma padrão, tempo de vida do carrinho, franquia de mensagens...). Aparecem só depois de gravados.

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Alterar as configurações

PUT/api/v1/admin/whatsapp-confluence/settingsAdmin

Altera as configurações do WhatsApp

Corpo da requisição

(qualquer chave)any

Qualquer chave listada em Ler as configurações. Booleanos para interruptores; números e textos para ajustes de uso.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/whatsapp-confluence/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enable_campaigns": false, "show_product_reviews": true}'

Resposta

200Configurações salvas

json

{
  "status": "ok"
}

Campos da resposta

statusstring

Sempre ok quando gravou.

Erros

Status	Quando	Corpo de exemplo
400	Corpo não é um objeto JSON.	`{"error":"invalid request body"}`
500	Falha ao gravar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`