Skip to main content
POST
Creating an instance

Overview

Method used to create an instance linked to your account.
You don’t necessarily need to subscribe now; you have 2 days for trial use. After 2 days without subscription, the instance is automatically deleted.
To use Partner endpoints, provide the Partner Token in the Authorization field using the following format: Bearer <Partner-Token>It is not necessary to send the Client-Token in these requests.

Attributes

Required

string
required
Instance name

Optional

string
Session name on connected devices
string
Webhook URL for sent messages
string
Webhook URL for received messages
string
Webhook URL for received and sent messages
string
Webhook URL for chat presence status
string
Webhook URL for disconnection
string
Webhook URL for connection
string
Webhook URL for message status
boolean
Automatically reject calls
string
Message when rejecting a call
boolean
Automatic message reading
boolean
Automatic status reading
boolean
Mobile instance (true) or web (false)
boolean
WhatsApp Business version
boolean
Enable/disable queue when disconnected

Optional - only for creating mobile instances

string
WhatsApp profile name
string
URL for the WhatsApp profile photo

Request Body


Response

200

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.