Get QR Code for WhatsApp Connection
GET
/v1/instance/{{INSTANCE_ID}}/setting/qrThis API retrieves the QR code required to link a WhatsApp account to a specific instance. The QR code is used to authenticate and establish a connection between your WhatsApp account and Zaply's messaging system. The API allows the QR code to be fetched either as a base64 string or as a direct image.
Request Parameters
Path Parameters
instance_id
(string) - The unique identifier of the WhatsApp instance. Replacegej1iz4pta
with your instance ID.
Query Parameters
base64
(boolean, optional) - Specifies the format of the QR code:If set to
true
, returns the QR code as a base64 encoded string.If omitted or set to
false
(default), returns the QR code image.
Headers
Authorization
(string, required) - Bearer token for authentication. Replace{{ZAPLY_AUTH_TOKEN}}
with your API token.
Error Codes
401 Unauthorized
- Invalid or missingAuthorization
token.404 Not Found
- Instance ID does not exist.500 Internal Server Error
- Server encountered an unexpected condition.
Request
Query Params
base64
string
required
Example:
false
Header Params
Authorization
string
required
Example:
Bearer {{ZAPLY_AUTH_TOKEN}}
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
object {0}
Example
{}
Last modified: a month ago