Atualizar instância — Instvia Developers

Parâmetros de path

Nome	Exemplo
`instance`	`dac3a956-4e8b-4d76-8caf-fed98dfc8b05`

Request

Headers

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

Body (JSON)

{
    "name": "Financeiro Principal"
}

Exemplos de código

curl -sS -X PATCH "https://api.instvia.com/api/v1/instances/dac3a956-4e8b-4d76-8caf-fed98dfc8b05" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Financeiro Principal"
}'

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

<?php

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

$ch = curl_init('https://api.instvia.com/api/v1/instances/dac3a956-4e8b-4d76-8caf-fed98dfc8b05');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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 200

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

Response 401

{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Invalid API key."
    }
}