API atual/Referência completa/WhatsApp: número e perfil

Sugestões de nome e descrição

Ajudantes do cadastro: candidatos a nome de exibição e texto de descrição do negócio.

Duas rotas de apoio ao formulário de cadastro. Elas não gravam nada: só devolvem texto para o seller aceitar, editar ou ignorar.

Sugerir nomes de exibição

A Meta revisa o nome oficial do número e recusa nomes genéricos ou com termos como "loja" e "comércio" no fim. Esta rota devolve até três candidatos prontos para colocar no formulário do cadastro. Os campos do corpo são opcionais: o que faltar é completado com os dados do cadastro do seller.

POST/api/v1/vendor/whatsapp/self-setup/suggest-namesSeller

Retorna três candidatos a nome de exibição

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

company_namestring

Nome fantasia.

legal_namestring

Razão social.

citystring

Cidade.

statestring

UF.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp/self-setup/suggest-names" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Casa do Pão Quente",
    "city": "Curitiba",
    "state": "PR"
  }'

Resposta

200Candidatos

json

{
  "success": true,
  "names": [
    "Casa Pão Quente",
    "Casa Pão Quente PR",
    "Casa Pão Quente Curiti"
  ]
}

Campos da resposta

successboolean

Sempre true.

namesarray

Lista de nomes candidatos, do mais ao menos provável de passar na revisão. Pode ter menos de três.

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, o módulo de WhatsApp está desligado na loja (`module_disabled`) ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"module_disabled","module":"whatsapp-commerce"}`
403	O usuário não tem o privilégio de seller `vendor_manage_whatsapp`.	`{"error":"insufficient vendor privileges","required":"vendor_manage_whatsapp"}`

Sugerir a descrição

Devolve um texto de apresentação do negócio para o campo description do perfil. A sugestão vem de um modelo de texto pronto ou de geração automática, e o campo source diz de qual. O seller deve revisar e aprovar antes de enviar.

POST/api/v1/vendor/whatsapp/self-setup/suggest-descriptionSeller

Retorna uma sugestão de descrição para o perfil

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

company_namestring

Nome fantasia. Omitido, usa o do cadastro do seller.

categorystringpadrão: RETAIL

Categoria da Meta.

citystring

Cidade. Omitida, usa a do cadastro.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp/self-setup/suggest-description" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Casa do Pão Quente",
    "category": "RETAIL",
    "city": "Curitiba"
  }'

Resposta

200Sugestão

json

{
  "success": true,
  "description": "Casa do Pão Quente em Curitiba. Atendimento rápido pelo WhatsApp: tire dúvidas, veja produtos e faça seu pedido com a gente.",
  "source": "template"
}

Campos da resposta

successboolean

Sempre true.

descriptionstring

Texto sugerido.

sourcestring

aitemplate

De onde veio o texto.

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, o módulo de WhatsApp está desligado na loja (`module_disabled`) ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"module_disabled","module":"whatsapp-commerce"}`
403	O usuário não tem o privilégio de seller `vendor_manage_whatsapp`.	`{"error":"insufficient vendor privileges","required":"vendor_manage_whatsapp"}`

Veja também

API atual/Referência completa/WhatsApp: número e perfil

Sugestões de nome e descrição

Ajudantes do cadastro: candidatos a nome de exibição e texto de descrição do negócio.

Duas rotas de apoio ao formulário de cadastro. Elas não gravam nada: só devolvem texto para o seller aceitar, editar ou ignorar.

Sugerir nomes de exibição

POST/api/v1/vendor/whatsapp/self-setup/suggest-namesSeller

Retorna três candidatos a nome de exibição

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

company_namestring

Nome fantasia.

legal_namestring

Razão social.

citystring

Cidade.

statestring

UF.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp/self-setup/suggest-names" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Casa do Pão Quente",
    "city": "Curitiba",
    "state": "PR"
  }'

Resposta

200Candidatos

json

{
  "success": true,
  "names": [
    "Casa Pão Quente",
    "Casa Pão Quente PR",
    "Casa Pão Quente Curiti"
  ]
}

Campos da resposta

successboolean

Sempre true.

namesarray

Lista de nomes candidatos, do mais ao menos provável de passar na revisão. Pode ter menos de três.

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, o módulo de WhatsApp está desligado na loja (`module_disabled`) ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"module_disabled","module":"whatsapp-commerce"}`
403	O usuário não tem o privilégio de seller `vendor_manage_whatsapp`.	`{"error":"insufficient vendor privileges","required":"vendor_manage_whatsapp"}`

Sugerir a descrição

POST/api/v1/vendor/whatsapp/self-setup/suggest-descriptionSeller

Retorna uma sugestão de descrição para o perfil

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

company_namestring

Nome fantasia. Omitido, usa o do cadastro do seller.

categorystringpadrão: RETAIL

Categoria da Meta.

citystring

Cidade. Omitida, usa a do cadastro.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp/self-setup/suggest-description" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Casa do Pão Quente",
    "category": "RETAIL",
    "city": "Curitiba"
  }'

Resposta

200Sugestão

json

{
  "success": true,
  "description": "Casa do Pão Quente em Curitiba. Atendimento rápido pelo WhatsApp: tire dúvidas, veja produtos e faça seu pedido com a gente.",
  "source": "template"
}

Campos da resposta

successboolean

Sempre true.

descriptionstring

Texto sugerido.

sourcestring

aitemplate

De onde veio o texto.

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, o módulo de WhatsApp está desligado na loja (`module_disabled`) ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"module_disabled","module":"whatsapp-commerce"}`
403	O usuário não tem o privilégio de seller `vendor_manage_whatsapp`.	`{"error":"insufficient vendor privileges","required":"vendor_manage_whatsapp"}`