vértice
Produto Preços Painel
Instâncias

Editar nome, webhook e filtros

Edita nome, URL de webhook, eventos assinados e a opção de incluir mensagens enviadas por você.

API key Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"name":"Comercial","webhookEvents":["message.received","message.sent"],"webhookNotifyFromMe":false}'
PATCH /instances/{id}
API key
Entenda

Conceituação

Edita nome, URL de webhook, eventos assinados e a opção de incluir mensagens enviadas por você. A URL passa por validação SSRF.

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.

webhookEvents array<string> opcional

Lista de eventos assinados. null assina todos; [] desativa todos.

webhookNotifyFromMe boolean opcional

Inclui no message.received as mensagens enviadas pelo próprio número.

Payload

Request Body

{
  "name": "Comercial",
  "webhookEvents": [
    "message.received",
    "message.sent"
  ],
  "webhookNotifyFromMe": false
}
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.
409 Instância não conectada ou conflito de estado.