Sign in

v46

latestOpenAPI 3.0.3raw.githubusercontent.com2025-05-151340367.2 KB
Instance Controller

Create Instance

post/instance/create

Request body

instanceNamestring required

instance (Instance name)

tokenstring

apikey (Enter or leave empty to create dynamically)

qrcodeboolean

Create QR Code automatically after creation

numberstring

559999999999 (Instance owner number with Country Code)

integration'WHATSAPP-BAILEYS' | 'WHATSAPP-BUSINESS' required

WhatsApp engine

rejectCallboolean

Reject WhatsApp calls automatically

msgCallstring

Message to be sent when a call is rejected automatically

groupsIgnoreboolean

Ignore group messages

alwaysOnlineboolean

Keep WhatsApp always online

readMessagesboolean

Send read receipts to received messages

readStatusboolean

Show sent messages read status

syncFullHistoryboolean

Syncronize full WhatsApp history with EvolutionAPI

proxyHoststring

proxy host

proxyPortstring

proxy port

proxyProtocolstring

proxy protocol

proxyUsernamestring

proxy Username

proxyPasswordstring

proxy password

chatwootAccountIdinteger

Chatwoot account ID

chatwootTokenstring

Chatwoot authentication token

chatwootUrlstring

Chatwoot server URL

chatwootSignMsgboolean

Send message signature on Chatwoot

chatwootReopenConversationboolean

Reopen conversation on Chatwoot

chatwootConversationPendingboolean

TODO

chatwootImportContactsboolean

Import Chatwoot contacts

chatwootNameInboxstring

Name inbox chatwoot

chatwootMergeBrazilContactsboolean

TODO

chatwootImportMessagesboolean

Import chatwoot messages

chatwootDaysLimitImportMessagesinteger

Limit message import chatwoot

chatwootOrganizationstring

Evolution Bot

chatwootLogostring

https://evolution-api.com/files/evolution-api-favicon.png

Response

Created

Example response

{
  "instance": {
    "instanceName": "teste-docs",
    "instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
    "webhook_wa_business": null,
    "access_token_wa_business": "",
    "status": "created"
  },
  "hash": {
    "apikey": "123456"
  },
  "settings": {
    "reject_call": false,
    "msg_call": "",
    "groups_ignore": true,
    "always_online": false,
    "read_messages": false,
    "read_status": false,
    "sync_full_history": false
  }
}