instances

create instance

Create a new instance. Optionally set a name and webhook configuration.

post/instances

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances
  • Auth: HTTP bearer

Request body

namestring

Example request

{
  "name": "My first instance",
  "webhook": {
    "url": "https://my.url.com/webhook/handler",
    "events": [
      "message",
      "qr"
    ]
  },
  "call_policy": {
    "mode": "reject_with_message",
    "message": "We do not take calls. Please send a message."
  }
}

Response

The created instance

status'success' | 'error'

Example response

{
  "instance": {
    "id": 1,
    "name": "My first instance",
    "owner": "mail@example.com",
    "webhook_url": "https://my.url.com/webhook/handler",
    "webhook_events": [
      "message",
      "qr"
    ],
    "call_policy": {
      "mode": "reject_with_message",
      "message": "We do not take calls. Please send a message."
    },
    "send_protection": {
      "enabled": true,
      "disableable": true
    }
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.