VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: conexão e configuração

Segmento e textos

Escolhe o segmento comercial da loja (moda, alimentos, autopeças...) e personaliza os textos do assistente e da mini-loja.

Listar os segmentos

Devolve os segmentos comerciais que a plataforma conhece, com as capacidades de cada um. Use para montar o seletor de segmento.

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

Lista os segmentos comerciais

Exemplo de requisição

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

Resposta

200Segmentos
json
{
  "segments": [
    {
      "id": "fashion",
      "name_key": "fashion",
      "description_key": "fashionDesc",
      "capabilities": [
        "catalog",
        "cart",
        "checkout",
        "variants",
        "size_guide",
        "campaigns"
      ]
    }
  ]
}

Campos da resposta

segmentsarray
Um item por segmento: general, food, grocery, pharmacy, auto_parts, fashion, beauty, electronics, pet, construction, b2b, health.
segments[].idstring
Identificador do segmento, o valor aceito em segment.
segments[].name_keystring
Chave de tradução do nome (o texto vem do front-end).
segments[].description_keystring
Chave de tradução da descrição.
segments[].capabilitiesarray
Capacidades do segmento, por exemplo variants, age_gate, cold_chain, vehicle_fitment, quote.
segments[].default_rule_hintsarray
Regras sugeridas ao escolher o segmento (por exemplo min_age). Ausente quando não há.

Erros

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

Os nomes legíveis dos segmentos não vêm da API: use name_key e description_key para buscar a tradução no seu front-end.

Ler o perfil comercial

Devolve o segmento escolhido pela loja, o objeto de configuração e as trocas de texto (labels). Uma loja que nunca gravou nada recebe o segmento general com tudo vazio.

GET/api/v1/admin/whatsapp-confluence/commerce-profileAdmin

Lê o perfil comercial

Exemplo de requisição

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

Resposta

200Perfil
json
{
  "segment": "fashion",
  "config": {},
  "labels": {
    "cart.noun": "Sacola"
  },
  "updated_at": "2026-10-01T14:20:00Z",
  "capabilities": [
    "catalog",
    "cart",
    "checkout",
    "variants",
    "size_guide",
    "campaigns"
  ]
}

Campos da resposta

segmentstring
generalfoodgrocerypharmacyauto_partsfashionbeautyelectronicspetconstructionb2bhealth
Segmento ativo.
configobject
Configuração livre do segmento (regras da loja). Objeto vazio se não houver.
labelsobject
Trocas de texto: chave de texto para o texto que a loja prefere. Chaves usadas pelo assistente: cart.noun, cart.headline, cart.view_cta, cart.empty_title e outras.
updated_atstring
Última gravação (RFC 3339). Fica em 0001-01-01T00:00:00Z ou ausente se nunca gravou.
capabilitiesarray
Capacidades derivadas do segmento ativo. Somente leitura.

Erros

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

Gravar o perfil comercial

Troca o segmento e substitui config e labels pelo que você enviar. Exige o privilégio manage_settings. A resposta é o perfil já gravado.

PUT/api/v1/admin/whatsapp-confluence/commerce-profileAdmin

Grava o perfil comercial

Corpo da requisição

segmentstringpadrão: general
generalfoodgrocerypharmacyauto_partsfashionbeautyelectronicspetconstructionb2bhealth
Segmento. Vazio vale general.
configobject
Configuração do segmento. Se faltar, é zerada.
labelsobject
Trocas de texto. Se faltar, é zerada.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/admin/whatsapp-confluence/commerce-profile" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"segment": "fashion", "labels": {"cart.noun": "Sacola"}}'

Resposta

200Perfil gravado
json
{
  "segment": "fashion",
  "config": {},
  "labels": {
    "cart.noun": "Sacola"
  },
  "updated_at": "2026-10-01T14:20:00Z",
  "capabilities": [
    "catalog",
    "cart",
    "checkout",
    "variants",
    "size_guide",
    "campaigns"
  ]
}

Campos da resposta

(corpo)object
O perfil, com os mesmos campos de Ler o perfil comercial.

Erros

StatusQuandoCorpo de exemplo
400JSON inválido.{"error":"invalid json"}
400Segmento desconhecido.{"error":"unknown segment \"tecnologia\""}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
403O administrador não tem o privilégio manage_settings.{"error":"insufficient privileges","required":"manage_settings"}
Substitui, não mescla

config e labels são gravados por inteiro. Para mudar uma única troca de texto, leia o perfil, altere o objeto e devolva-o completo; senão as outras trocas se perdem.

Como as trocas valem

Cada texto é resolvido nesta ordem: troca da loja em labels, pacote do segmento, pacote general. Por isso trocar o segmento muda o vocabulário de tudo o que você não personalizou.

Veja também

  • Boas-vindas e consentimento
  • Configurações do canal
Anterior
Configurações do canal
Próxima
Boas-vindas e consentimento
Nesta página
  • Listar os segmentos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Ler o perfil comercial
  • Exemplo de requisição
  • Resposta
  • Erros
  • Gravar o perfil comercial
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também