POST
/
instance
/
create
Create Instance
curl --request POST \
  --url https://{server-url}/instance/create \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "instanceName": "<string>",
  "token": "<string>",
  "qrcode": true,
  "number": "<string>",
  "integration": "WHATSAPP-BAILEYS",
  "rejectCall": true,
  "msgCall": "<string>",
  "groupsIgnore": true,
  "alwaysOnline": true,
  "readMessages": true,
  "readStatus": true,
  "syncFullHistory": true,
  "proxyHost": "<string>",
  "proxyPort": "<string>",
  "proxyProtocol": "<string>",
  "proxyUsername": "<string>",
  "proxyPassword": "<string>",
  "webhook": {
    "url": "<string>",
    "byEvents": true,
    "base64": true,
    "headers": {
      "authorization": "<string>",
      "Content-Type": "<string>"
    },
    "events": [
      "APPLICATION_STARTUP"
    ]
  },
  "rabbitmq": {
    "enabled": true,
    "events": [
      "APPLICATION_STARTUP"
    ]
  },
  "sqs": {
    "enabled": true,
    "events": [
      "APPLICATION_STARTUP"
    ]
  },
  "chatwootAccountId": 123,
  "chatwootToken": "<string>",
  "chatwootUrl": "<string>",
  "chatwootSignMsg": true,
  "chatwootReopenConversation": true,
  "chatwootConversationPending": true,
  "chatwootImportContacts": true,
  "chatwootNameInbox": "<string>",
  "chatwootMergeBrazilContacts": true,
  "chatwootImportMessages": true,
  "chatwootDaysLimitImportMessages": 123,
  "chatwootOrganization": "<string>",
  "chatwootLogo": "<string>"
}'
{
  "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
  }
}

Authorizations

apikey
string
header
required

Your authorization key header

Body

application/json
instanceName
string
required

instance (Instance name)

integration
enum<string>
required

WhatsApp engine

Available options:
WHATSAPP-BAILEYS,
WHATSAPP-BUSINESS
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)

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

rabbitmq
object
sqs
object

Enable 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

Response

Created

instance
object
hash
object
settings
object