---
title: "Create Instance"
method: POST
path: "/instance/create"
tags: ["Instance Controller"]
---

# Create Instance

`POST /instance/create`

## Request

- Base URL: `https://evolution-example`
- URL: `https://evolution-example/instance/create`
- Auth: API key in header `apikey`

## Request body

- object
  - `instanceName` string, required: instance (Instance name)
  - `token` string: apikey (Enter or leave empty to create dynamically)
  - `qrcode` boolean: Create QR Code automatically after creation
  - `number` string: 559999999999 (Instance owner number with Country Code)
  - `integration` 'WHATSAPP-BAILEYS' | 'WHATSAPP-BUSINESS', required: WhatsApp engine
  - `rejectCall` boolean: Reject WhatsApp calls automatically
  - `msgCall` string: Message to be sent when a call is rejected automatically
  - `groupsIgnore` boolean: Ignore group messages
  - `alwaysOnline` boolean: Keep WhatsApp always online
  - `readMessages` boolean: Send read receipts to received messages
  - `readStatus` boolean: Show sent messages read status
  - `syncFullHistory` boolean: Syncronize full WhatsApp history with EvolutionAPI
  - `proxyHost` string: proxy host
  - `proxyPort` string: proxy port
  - `proxyProtocol` string: proxy protocol
  - `proxyUsername` string: proxy Username
  - `proxyPassword` string: proxy password
  - `webhook` object: Webhook URL
    - `url` string: The URL of the webhook.
    - `byEvents` boolean: Enable Webhook by events
    - `base64` boolean: Sends files in base64 when available
    - `headers` object: Headers for send the API from webhook
      - `authorization` string: Your authorization key header
      - `Content-Type` string: content-type
    - `events` string[]: Events to be sent to the Webhook
  - `rabbitmq` object
    - `enabled` boolean: Enable RabbitMQ
    - `events` string[]: Events to be sent to the RabbitMQ
  - `sqs` object: Enable SQS
    - `enabled` boolean: Enable SQS
    - `events` string[]: Events to be sent to the SQS
  - `chatwootAccountId` integer: Chatwoot account ID
  - `chatwootToken` string: Chatwoot authentication token
  - `chatwootUrl` string: Chatwoot server URL
  - `chatwootSignMsg` boolean: Send message signature on Chatwoot
  - `chatwootReopenConversation` boolean: Reopen conversation on Chatwoot
  - `chatwootConversationPending` boolean: TODO
  - `chatwootImportContacts` boolean: Import Chatwoot contacts
  - `chatwootNameInbox` string: Name inbox chatwoot
  - `chatwootMergeBrazilContacts` boolean: TODO
  - `chatwootImportMessages` boolean: Import chatwoot messages
  - `chatwootDaysLimitImportMessages` integer: Limit message import chatwoot
  - `chatwootOrganization` string: Evolution Bot
  - `chatwootLogo` string: https://evolution-api.com/files/evolution-api-favicon.png

## Response `201`

Created

- object
  - `instance` object
    - `instanceName` string: The name of the instance
    - `instanceId` string: The unique identifier for the instance
    - `webhook_wa_business` string: The webhook URL for WhatsApp Business integration
    - `access_token_wa_business` string: The access token for WhatsApp Business
    - `status` string: The current status of the instance
  - `hash` object
    - `apikey` string: The API key for authentication
  - `settings` object
    - `reject_call` boolean: Indicates whether calls are rejected
    - `msg_call` string: Message to be sent when a call is rejected
    - `groups_ignore` boolean: Indicates whether groups are ignored
    - `always_online` boolean: Indicates whether the instance is always online
    - `read_messages` boolean: Indicates whether messages are marked as read
    - `read_status` boolean: Indicates whether status updates are marked as read
    - `sync_full_history` boolean: Indicates whether the full message history is synchronized

## Other responses

- `403`: Forbidden

## Changes

- **2025-03-05** (v2) `11f35f0c0508`: 1 warning, 1 info
  - removed the request property `webhook/headers/autorization`
  - added the new optional request property `webhook/headers/authorization`
- **2024-11-25** (v2) `c153448703e5`: 4 breaking, 33 info
  - added the new required request property `instanceName`
  - added the new required request property `integration`
  - request body became required
  - removed the success response with the status `200`
  - …33 more
- **2024-09-09** (v2) `0c4620ca5ed5`: 1 breaking, 44 warning, 3 info
  - removed the success response with the status `201`
  - removed the request property `alwaysOnline`
  - removed the request property `chatwootAccountId`
  - removed the request property `chatwootConversationPending`
  - …44 more
- **2024-08-09** (v2) `996acfdb07ce`: 27 warning, 37 info
  - removed the request property `always_online`
  - removed the request property `chatwoot_account_id`
  - removed the request property `chatwoot_conversation_pending`
  - removed the request property `chatwoot_reopen_conversation`
  - …60 more

[Operation history](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/changes/instance/create/post.md)

---

[API](https://skmtc.dev/evolution-foundation/apis/evolution-api-3.md) - [All operations](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/llms.txt) - [OpenAPI document](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/revisions/153363ee7f38?raw)