Conta e Instâncias
Atualizar Instância
Atualiza webhook_url e/ou metadata de uma instância. O metadata é um JSON livre para vincular a instância ao seu sistema (ex: ID do cliente, plano, etc). O metadata é incluído automaticamente nos webhooks recebidos.
PUT
https://api.zapzapapi.com/api/v1/instances/{id}Autenticação por cabeçalhos x-api-key e x-api-secret.
Parâmetros
| Nome | Tipo | Onde | Obrigatório | Descrição |
|---|---|---|---|---|
id | text | caminho | Sim | ID da instância |
webhook_url | text | corpo | Não | URL do webhook (HTTPS) |
metadata | text | corpo | Não | Dados livres (JSON) |
Exemplo de requisição
curl
curl -X PUT "https://api.zapzapapi.com/api/v1/instances/{id}" \
-H "x-api-key: SUA_API_KEY" \
-H "x-api-secret: SEU_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"webhook_url":"https://meusite.com/webhook","metadata":"{\"clientId\":\"123\"}"}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/instances/{id}", {
method: "PUT",
headers: {
"x-api-key": "SUA_API_KEY",
"x-api-secret": "SEU_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"webhook_url": "https://meusite.com/webhook",
"metadata": "{\"clientId\":\"123\"}"
}),
});
console.log(await res.json());Python
import requests
res = requests.put(
"https://api.zapzapapi.com/api/v1/instances/{id}",
headers={"x-api-key": "SUA_API_KEY", "x-api-secret": "SEU_API_SECRET"},
json={"webhook_url":"https://meusite.com/webhook","metadata":"{\"clientId\":\"123\"}"},
)
print(res.json())Exemplo de resposta
JSON
{
"id": "uuid",
"name": "minha-instancia",
"webhook_url": "https://meusite.com/webhook",
"metadata": {
"clientId": "123"
}
}Os valores são ilustrativos; os campos seguem o formato real da resposta.
Outros endpoints desta categoria
Pegue suas chaves de API
Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.