POST
/
instance
/
create
curl --request POST \
  --url https://{server-url}/instance/create \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "instanceName": "<string>",
  "token": "<string>",
  "number": "<string>",
  "qrcode": true,
  "integration": "WHATSAPP-BAILEYS",
  "reject_call": true,
  "msgCall": "<string>",
  "groupsIgnore": true,
  "alwaysOnline": true,
  "readMessages": true,
  "readStatus": true,
  "syncFullHistory": true,
  "proxyHost": "<string>",
  "proxyPort": "<string>",
  "proxyProtocol": "http",
  "proxyUsername": "<string>",
  "proxyPassword": "<string>",
  "webhookUrl": "<string>",
  "webhookByEvents": true,
  "webhookBase64": true,
  "webhookEvents": [
    "APPLICATION_STARTUP"
  ],
  "rabbitmqEnabled": true,
  "rabbitmqEvents": [
    "APPLICATION_STARTUP"
  ],
  "sqsEnabled": true,
  "sqsEvents": [
    "APPLICATION_STARTUP"
  ],
  "chatwootAccountId": 123,
  "chatwootToken": "<string>",
  "chatwootUrl": "<string>",
  "chatwootSignMsg": true,
  "chatwootReopenConversation": true,
  "chatwootConversationPending": true,
  "chatwootImportContacts": true,
  "chatwootNameInbox": "<string>",
  "chatwootMergeBrazilContacts": true,
  "chatwootDaysLimitImportMessages": 123,
  "chatwootOrganization": "<string>",
  "chatwootLogo": "<string>",
  "typebotUrl": "<string>",
  "typebot": "<string>",
  "typebotExpire": 123,
  "typebotKeywordFinish": "<string>",
  "typebotDelayMessage": 123,
  "typebotUnknownMessage": "<string>",
  "typebotListeningFromMe": true
}'
{
  "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

Response

201
application/json
Created

The response is of type object.