Contatos
Adicionar ou editar contato
Adiciona ou edita um contato na agenda do WhatsApp.
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/contacts" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"phone":"5511999999999","name":"Maria Silva","saveOnPrimaryAddressbook":true}'
const response = await fetch('https://seu-dominio/instances/:id/contacts', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"phone": "5511999999999",
"name": "Maria Silva",
"saveOnPrimaryAddressbook": true
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Adiciona ou edita um contato na agenda do WhatsApp.
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
phone
string
opcional
Telefone com DDI e DDD, apenas dígitos ou no formato exibido.
name
string
opcional
Nome exibido do recurso, contato, enquete ou grupo.
saveOnPrimaryAddressbook
boolean
opcional
Campo saveOnPrimaryAddressbook do corpo JSON.
Payload
Request Body
{
"phone": "5511999999999",
"name": "Maria Silva",
"saveOnPrimaryAddressbook": true
}
Contrato
200
Resposta
{
"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.