POST https://api.instvia.com/api/v1/instances

Criar instância

Cria uma nova sessão WhatsApp. Status inicial: `CREATED`. Em seguida chame Connect e Get QR Code. Debita saldo pré-pago (~R$ 29,90). Sem crédito: `402 INSUFFICIENT_BALANCE`.

Campos

Campo	Tipo	Descrição
`name`	string	Nome amigável (ex.: setor).

Request

Body JSON obrigatório.

Headers

{
    "Accept": "application/json",
    "Authorization": "Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef",
    "Content-Type": "application/json"
}

Body (JSON)

{
    "name": "Financeiro"
}

Exemplos de código

curl -sS -X POST "https://api.instvia.com/api/v1/instances" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Financeiro"
}'

const response = await fetch('https://api.instvia.com/api/v1/instances', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef',
  },
  body: JSON.stringify({"name":"Financeiro"}),
});
const data = await response.json();
console.log(data);

<?php

$payload = array (
  'name' => 'Financeiro',
);

$ch = curl_init('https://api.instvia.com/api/v1/instances');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'Authorization: Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload),
]);
$body = curl_exec($ch);
curl_close($ch);
\$data = json_decode($body, true);

Response 201

{
    "success": true,
    "data": {
        "id": "dac3a956-4e8b-4d76-8caf-fed98dfc8b05",
        "name": "Financeiro",
        "phone": null,
        "status": "CREATED",
        "connected_at": null,
        "disconnected_at": null,
        "last_seen_at": null,
        "created_at": "2026-08-25T12:00:00+00:00",
        "updated_at": "2026-08-25T18:00:00+00:00"
    }
}

Response 402

{
    "success": false,
    "error": {
        "code": "INSUFFICIENT_BALANCE",
        "message": "Saldo insuficiente para criar a instância."
    }
}