Skip to main content
GET
/
instance
/
connect
/
{instance}
Instances Connect
curl --request GET \
  --url https://{server-url}/instance/connect/{instance} \
  --header 'apikey: <api-key>'
{
  "pairingCode": "WZYEH1YY",
  "code": "2@y8eK+bjtEjUWy9/FOM...",
  "count": 1
}

Authorizations

​
apikey
string
header
required

Your authorization key header

Path Parameters

​
instance
string
required

Name of the instance to connect

Query Parameters

​
number
string

Phone number (with country code) to be connected

Response

Ok

​
pairingCode
string

The unique code used for pairing a device or account.

​
code
string

A specific code associated with the pairing process. This may include tokens or other identifiers.

​
count
integer

The count or number of attempts or instances related to the pairing process.