---
title: "Create a new WhatsApp instance"
method: POST
path: "/instance/create"
tags: ["Instance"]
---

# Create a new WhatsApp instance

`POST /instance/create`

Creates a new WhatsApp instance with the given name and optional configuration

## Request body

- DtoCreateInstanceRequest
  - `alwaysOnline` boolean
  - `groupsIgnore` boolean
  - `id` string
  - `instanceName` string
  - `migration` DtoMigrationData
    - `creds` integer[], required
    - `preKeys` DtoMigrationPreKey[]
      - `keyId` integer
      - `private` DtoMigrationBuffer
        - `data` string
        - `type` string
  - `msgCall` string
  - `proxyHost` string
  - `proxyPassword` string
  - `proxyPort` string
  - `proxyProtocol` string
  - `proxyUsername` string
  - `readMessages` boolean
  - `readStatus` boolean
  - `rejectCall` boolean
  - `remoteJID` string
  - `syncFullHistory` boolean
  - `syncRecentHistory` boolean
  - `webhook` ModelsInstanceWebhook
    - `base64` boolean
    - `byEvents` boolean
    - `enabled` boolean
    - `events` string[]
    - `headers` object
    - `url` string

## Response `201`

Created

- DtoCreateInstanceResponse
  - `alwaysOnline` boolean
  - `groupsIgnore` boolean
  - `id` string
  - `migration` DtoMigrationResult
    - `connected` boolean
    - `jid` string
    - `lid` string
    - `preKeysImported` integer
  - `msgCall` string
  - `proxyHost` string
  - `proxyPassword` string
  - `proxyPort` string
  - `proxyProtocol` string
  - `proxyUsername` string
  - `readMessages` boolean
  - `readStatus` boolean
  - `rejectCall` boolean
  - `remoteJID` string
  - `syncFullHistory` boolean
  - `syncRecentHistory` boolean
  - `webhook` ModelsInstanceWebhook
    - `base64` boolean
    - `byEvents` boolean
    - `enabled` boolean
    - `events` string[]
    - `headers` object
    - `url` string

## Other responses

- `400` — Bad Request
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/verbeux-ai/apis/whatsmiau-api.md) · [All operations](https://skmtc.net/verbeux-ai/apis/whatsmiau-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verbeux-ai/whatsmiau-api/versions/5af3cb49985a/schema)