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

Voz do assistente

Define o tom e as regras da loja para o assistente de vendas que responde no WhatsApp.

O assistente de vendas conversa com o cliente em nome da loja. A "voz" é o que a loja controla: o tom, alguns traços de estilo, regras próprias e fatos sobre o negócio. Existe uma única voz por loja, valendo para o WhatsApp e para o chat da mini-loja. Mudanças valem a partir da próxima mensagem do cliente.

Ler a voz

GET/api/v1/vendor/whatsapp-confluence/ai/personaSeller

Retorna a voz do assistente

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/ai/persona" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Voz

json

{
  "style": "A",
  "traits": {
    "emoji": "less",
    "tamanho": "less",
    "formato": "conversa"
  },
  "custom_instructions": "Sempre ofereça o frete grátis acima de R$ 199.",
  "store_context": "Vendemos material de construção em São Paulo. Entregamos em até 2 dias úteis.",
  "updated_at": "2026-09-30T14:20:11Z"
}

Campos da resposta

stylestring

DPARVE

Tom geral: D natural e prestativo, P profissional e cortês (padrão), A amigável e próximo, R direto e objetivo, V leve e divertido, E eficiente. Um código desconhecido cai no tom profissional.

traitsobject

Ajustes finos, uma chave por traço. Valores more, less ou default para acolhedor, entusiasmado, emoji, listas e tamanho; formato aceita enxuto (padrão), conversa ou resumo. Chaves desconhecidas são guardadas e ignoradas.

custom_instructionsstring

Regras da loja em texto livre, por exemplo políticas que o assistente deve seguir.

store_contextstring

Fatos sobre a loja que o assistente pode usar: ramo, região, prazos.

updated_atstring

Última gravação (RFC 3339). Vale 0001-01-01T00:00:00Z enquanto nunca foi gravada.

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.	`{"error":"..."}`

Gravar a voz

A gravação substitui o registro inteiro: o que você não enviar é apagado (style volta para P). Note que a resposta é só {"status":"ok"}, sem devolver o registro.

PUT/api/v1/vendor/whatsapp-confluence/ai/personaSeller

Grava a voz do assistente

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

stylestringpadrão: P

DPARVE

Tom geral. Vazio vale P.

traitsobject

Traços de estilo, ver a leitura.

custom_instructionsstring

Regras da loja. Vazio apaga.

store_contextstring

Fatos da loja. Vazio apaga.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/ai/persona" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "style": "A",
  "traits": {
    "emoji": "less",
    "tamanho": "less",
    "formato": "conversa"
  },
  "custom_instructions": "Sempre ofereça o frete grátis acima de R$ 199.",
  "store_context": "Vendemos material de construção em São Paulo. Entregamos em até 2 dias úteis."
}'

Resposta

200Voz gravada

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	Corpo que não é JSON.	`{"error":"invalid body"}`
500	Falha ao gravar.	`{"error":"..."}`

Veja também

Voz do assistente

Define o tom e as regras da loja para o assistente de vendas que responde no WhatsApp.

Ler a voz

GET/api/v1/vendor/whatsapp-confluence/ai/personaSeller

Retorna a voz do assistente

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/ai/persona" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Voz

json

{
  "style": "A",
  "traits": {
    "emoji": "less",
    "tamanho": "less",
    "formato": "conversa"
  },
  "custom_instructions": "Sempre ofereça o frete grátis acima de R$ 199.",
  "store_context": "Vendemos material de construção em São Paulo. Entregamos em até 2 dias úteis.",
  "updated_at": "2026-09-30T14:20:11Z"
}

Campos da resposta

stylestring

DPARVE

traitsobject

custom_instructionsstring

Regras da loja em texto livre, por exemplo políticas que o assistente deve seguir.

store_contextstring

Fatos sobre a loja que o assistente pode usar: ramo, região, prazos.

updated_atstring

Última gravação (RFC 3339). Vale 0001-01-01T00:00:00Z enquanto nunca foi gravada.

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.	`{"error":"..."}`

Gravar a voz

A gravação substitui o registro inteiro: o que você não enviar é apagado (style volta para P). Note que a resposta é só {"status":"ok"}, sem devolver o registro.

PUT/api/v1/vendor/whatsapp-confluence/ai/personaSeller

Grava a voz do assistente

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

stylestringpadrão: P

DPARVE

Tom geral. Vazio vale P.

traitsobject

Traços de estilo, ver a leitura.

custom_instructionsstring

Regras da loja. Vazio apaga.

store_contextstring

Fatos da loja. Vazio apaga.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/ai/persona" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "style": "A",
  "traits": {
    "emoji": "less",
    "tamanho": "less",
    "formato": "conversa"
  },
  "custom_instructions": "Sempre ofereça o frete grátis acima de R$ 199.",
  "store_context": "Vendemos material de construção em São Paulo. Entregamos em até 2 dias úteis."
}'

Resposta

200Voz gravada

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	Corpo que não é JSON.	`{"error":"invalid body"}`
500	Falha ao gravar.	`{"error":"..."}`