---
title: "update instance"
method: PUT
path: "/instances/{id}"
tags: ["instances"]
---

# update instance

`PUT /instances/{id}`

Update the instance.

## Path parameters

- `id` integer, required

## Request body

- InstanceUpdate
  - `name` string
  - `webhook` object
    - `url` string
    - `events` EventType[]

## Response `200`

returns the updated instance.

- object
  - `data` InstanceClientStatus
    - `status` 'success' | 'error'
    - `instanceId` string
    - `name` string
    - `data` object
    - `instanceStatus` 'booting' | 'loading_screen' | 'qr' | 'authenticated' | 'auth_failure' | 'ready' | 'disconnected'
    - `instanceWebhook` string
    - `instanceEvents` EventType[]
  - `links` object
    - `self` string
  - `status` 'success' | 'error'

## Other responses

- `401` — Unauthorized — invalid or missing bearer token
- `403` — Forbidden — insufficient permissions or account blocked
- `404` — Not found — instance does not exist or does not belong to you
- `409` — Conflict — instance is not ready
- `422` — Validation error — invalid or missing request parameters
- `429` — Too many requests — rate limit exceeded

---

[API](https://skmtc.net/waapi/apis/waapi-api.md) · [All operations](https://skmtc.net/waapi/apis/waapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/waapi/waapi-api/revisions/1e2cc7c12090/schema)