Atualizar dados da instancia

curl --request PATCH \ --url https://api.vzaps.com/instances/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "My instance", "webhook": "https://cliente.exemplo.com/webhooks/vzaps", "events_subscribe": "Message,Connected", "reject_calls": false, "auto_read_messages": true } '

{ "id": "VZ9K2M4N8P1Q3R5S7T0WABCD01EF", "name": "My instance", "token": "inst_xxxxxxxxxxxxx", "url": "https://app.vzaps.com/instances/VZ9K2M4N8P1Q3R5S7T0WABCD01EF", "webhook": "https://cliente.exemplo.com/webhooks/vzaps", "events_subscribe": "Message,Connected,Disconnected", "reject_calls": false, "auto_read_messages": false, "connected": false, "billing_status": "TRIALING", "created_at": "2026-04-13T10:00:00Z", "updated_at": "2026-04-13T10:00:00Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Example:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Body

application/json

name

string

required

Required string length: 3 - 255

webhook

string

reject_calls

boolean

auto_read_messages

boolean

Response

Instancia atualizada

string

Identificador publico no formato VZ + hash alfanumerico.

name

string

token

string

url

string<uri>

webhook

string

reject_calls

boolean

auto_read_messages

boolean

connected

boolean | null

connected_at

string<date-time> | null

whatsapp_push_name

string | null

whatsapp_jid

string | null

billing_status

string

created_at

string<date-time>

updated_at

string<date-time>

cancel_at

string<date-time> | null

expired_at

string<date-time> | null