Cuenta e Instancias
Actualizar Instancia
Actualiza webhook_url y/o metadata de una instancia. El metadata es un JSON libre para vincular la instancia a tu sistema (ej: ID del cliente, plan, etc). El metadata se incluye automáticamente en los webhooks recibidos.
PUT
https://api.zapzapapi.com/api/v1/instances/{id}Autenticación con los encabezados x-api-key y x-api-secret.
Parámetros
| Nombre | Tipo | Dónde | Obligatorio | Descripción |
|---|---|---|---|---|
id | text | ruta | Sí | ID de la instancia |
webhook_url | text | cuerpo | No | URL del webhook (HTTPS) |
metadata | text | cuerpo | No | Datos libres (JSON) |
Ejemplo de solicitud
curl
curl -X PUT "https://api.zapzapapi.com/api/v1/instances/{id}" \
-H "x-api-key: TU_API_KEY" \
-H "x-api-secret: TU_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": "TU_API_KEY",
"x-api-secret": "TU_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": "TU_API_KEY", "x-api-secret": "TU_API_SECRET"},
json={"webhook_url":"https://meusite.com/webhook","metadata":"{\"clientId\":\"123\"}"},
)
print(res.json())Ejemplo de respuesta
JSON
{
"id": "uuid",
"name": "minha-instancia",
"webhook_url": "https://meusite.com/webhook",
"metadata": {
"clientId": "123"
}
}Los valores son ilustrativos; los campos siguen el formato real de la respuesta.
Otros endpoints de esta categoría
Consigue tus claves de API
Crea tu cuenta, conecta un número en minutos y empieza a usar la API. R$15 por número activo/mes, con un crédito de bienvenida al crear la cuenta, sujeto a la campaña vigente.