v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB

instances

update instance

Update the instance.

put/instances/{id}

Path parameters

idinteger required

Instance ID

Request body

namestring

Example request

{
  "name": "My first instance",
  "webhook": {
    "url": "https://my.url.com/webhook/handler",
    "events": [
      "message",
      "qr"
    ]
  }
}

Response

returns the updated instance.

status'success' | 'error'

Example response

{
  "data": {
    "status": "success",
    "instanceId": "1",
    "name": "My first Instance",
    "instanceStatus": "ready",
    "instanceWebhook": "https://my.url.com/webhook/handler",
    "instanceEvents": [
      "message"
    ]
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1"
  },
  "status": "success"
}