Configurações
Atualizar nome e recado do perfil
Atualiza o nome e o recado do perfil do WhatsApp.
API key
Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id/profile" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"name":"Atendimento","status":"Seg a sex, 9h às 18h"}'
const response = await fetch('https://seu-dominio/instances/:id/profile', {
method: 'PATCH',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"name": "Atendimento",
"status": "Seg a sex, 9h às 18h"
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Atualiza o nome e o recado do perfil 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
name
string
opcional
Nome exibido do recurso, contato, enquete ou grupo.
status
string
opcional
Status do workspace na plataforma.
Payload
Request Body
{
"name": "Atendimento",
"status": "Seg a sex, 9h às 18h"
}
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.