POST
/
instance
/
create

Authorizations

apikey
string
header
required

Your authorization key header

Body

application/json
instanceName
string
required

instance (Instance name)

alwaysOnline
boolean

Keep WhatsApp always online

chatwootAccountId
integer

Chatwoot account ID

chatwootConversationPending
boolean

Start the conversation as pending instead of open

chatwootDaysLimitImportMessages
integer

Specifies how many days' messages to import from today

chatwootImportContacts
boolean

Import contacts from WhatsApp to Chatwoot

Chatwoot logo URL

chatwootMergeBrazilContacts
boolean

Whether to merge Brazilian number contacts with and without the additional 9. Ex: 553198765432 merges with 5531998765432

chatwootNameInbox
string

Chatwoot inbox name (uses the instance name if empty)

chatwootOrganization
string

Chatwoot organization name

chatwootReopenConversation
boolean

Reopen conversation on Chatwoot

chatwootSignMsg
boolean

Send message signature on Chatwoot

chatwootToken
string

Chatwoot authentication token

chatwootUrl
string

Chatwoot server URL

groupsIgnore
boolean

Ignore group messages

integration
enum<string>

WhatsApp engine

Available options:
WHATSAPP-BAILEYS,
WHATSAPP-BUSINESS
msgCall
string

Message to be sent when a call is rejected automatically

number
string

559999999999 (Instance owner number with Country Code)

proxyHost
string

Proxy host

proxyPassword
string

Proxy password

proxyPort
string

Proxy port

proxyProtocol
enum<string>

Proxy protocol

Available options:
http,
https
proxyUsername
string

Proxy username

qrcode
boolean

Create QR Code automatically after creation

rabbitmqEnabled
boolean

Enables RabbitMQ

rabbitmqEvents
enum<string>[]

Events to be sent to the RabbitMQ

Available options:
APPLICATION_STARTUP,
QRCODE_UPDATED,
MESSAGES_SET,
MESSAGES_UPSERT,
MESSAGES_UPDATE,
MESSAGES_DELETE,
SEND_MESSAGE,
CONTACTS_SET,
CONTACTS_UPSERT,
CONTACTS_UPDATE,
PRESENCE_UPDATE,
CHATS_SET,
CHATS_UPSERT,
CHATS_UPDATE,
CHATS_DELETE,
GROUPS_UPSERT,
GROUP_UPDATE,
GROUP_PARTICIPANTS_UPDATE,
CONNECTION_UPDATE,
LABELS_EDIT,
LABELS_ASSOCIATION,
CALL,
TYPEBOT_START,
TYPEBOT_CHANGE_STATUS
readMessages
boolean

Send read receipts to received messages

readStatus
boolean

Show sent messages read status

reject_call
boolean

Reject WhatsApp calls automatically

sqsEnabled
boolean

Enable SQS

sqsEvents
enum<string>[]

Events to be sent to the SQS

Available options:
APPLICATION_STARTUP,
QRCODE_UPDATED,
MESSAGES_SET,
MESSAGES_UPSERT,
MESSAGES_UPDATE,
MESSAGES_DELETE,
SEND_MESSAGE,
CONTACTS_SET,
CONTACTS_UPSERT,
CONTACTS_UPDATE,
PRESENCE_UPDATE,
CHATS_SET,
CHATS_UPSERT,
CHATS_UPDATE,
CHATS_DELETE,
GROUPS_UPSERT,
GROUP_UPDATE,
GROUP_PARTICIPANTS_UPDATE,
CONNECTION_UPDATE,
LABELS_EDIT,
LABELS_ASSOCIATION,
CALL,
TYPEBOT_START,
TYPEBOT_CHANGE_STATUS
syncFullHistory
boolean

Whether to sync the full history of messages and chats or not

token
string

apikey (Enter or leave empty to create dynamically)

typebot
string

Typebot flow name

typebotDelayMessage
integer

Default delay for the typebot messages

typebotExpire
integer

Time to expire the session in seconds

typebotKeywordFinish
string

Keyword to finish the typebot flow (escape keyword)

typebotListeningFromMe
boolean

Typebot listen messages sent by the connected number

typebotUnknownMessage
string

TODO

typebotUrl
string

Typebot server URL

webhookBase64
boolean

Sends media files on base64 via Webhook

webhookByEvents
boolean

Enables the Webhook by events

webhookEvents
enum<string>[]

Events to be sent to the Webhook

Available options:
APPLICATION_STARTUP,
QRCODE_UPDATED,
MESSAGES_SET,
MESSAGES_UPSERT,
MESSAGES_UPDATE,
MESSAGES_DELETE,
SEND_MESSAGE,
CONTACTS_SET,
CONTACTS_UPSERT,
CONTACTS_UPDATE,
PRESENCE_UPDATE,
CHATS_SET,
CHATS_UPSERT,
CHATS_UPDATE,
CHATS_DELETE,
GROUPS_UPSERT,
GROUP_UPDATE,
GROUP_PARTICIPANTS_UPDATE,
CONNECTION_UPDATE,
LABELS_EDIT,
LABELS_ASSOCIATION,
CALL,
TYPEBOT_START,
TYPEBOT_CHANGE_STATUS
webhookUrl
string

Webhook URL

Response

201 - application/json
hash
object
instance
object
settings
object