vértice
Produto Preços Painel
WhatsApp Business

Atualizar perfil business

Atualiza descrição, e-mail, sites, endereço e horário comercial.

API key Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id/business/profile" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"description":"Empresa","email":"contato@empresa.com","websites":["https://empresa.com"]}'
PATCH /instances/{id}/business/profile
API key
Entenda

Conceituação

Atualiza descrição, e-mail, sites, endereço e horário comercial.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

Body

description string opcional

Campo description do corpo JSON.

email string opcional

E-mail da conta ou convite.

websites array<string> opcional

Campo websites do corpo JSON.

Payload

Request Body

{
  "description": "Empresa",
  "email": "contato@empresa.com",
  "websites": [
    "https://empresa.com"
  ]
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.