API Reference
View as Markdown Open in ChatGPT Open in Claude
POST
WhatsApp API · QR Codes · v3.0

Update Message QR Code

This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.

https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls
infoOverview

About this API

This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader
Field nameapi key
Example valueYOUR_WABA_API_KEY
routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

NameTypeRequirementDescription
businessPhoneNumberIdstringRequiredResource identifier for businessPhoneNumberId.
uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

Top-Level Fields

NameTypeRequirementDescription
codestringNot specifiedRequest value for code.
generate_qr_imagestringNot specifiedRequest value for generate qr image.
prefilled_messagestringNot specifiedRequest value for prefilled message.
{
  "code": "RPASB5GEAP6FO1",
  "generate_qr_image": "PNG",
  "prefilled_message": "Abhijit..."
}
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "generate_qr_image": {
      "type": "string"
    },
    "prefilled_message": {
      "type": "string"
    }
  }
}
codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

shield_lockCredentials protectedAdd secrets only in your secure server environment.
downloadSDK
curl --request POST 'https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls' \
  --header 'api key: <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "RPASB5GEAP6FO1",
  "generate_qr_image": "PNG",
  "prefilled_message": "Abhijit..."
}'
const response = await fetch('https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls', {
  method: 'POST',
  headers: {
    "api key": "<API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "code": "RPASB5GEAP6FO1",
    "generate_qr_image": "PNG",
    "prefilled_message": "Abhijit..."
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls', {
  method: 'POST',
  headers: {
    "api key": "<API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "code": "RPASB5GEAP6FO1",
    "generate_qr_image": "PNG",
    "prefilled_message": "Abhijit..."
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests

url = 'https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls'
headers = {
  "api key": "<API_KEY>",
  "Content-Type": "application/json"
}
payload = json.loads(r'''{
  "code": "RPASB5GEAP6FO1",
  "generate_qr_image": "PNG",
  "prefilled_message": "Abhijit..."
}''')
response = requests.post(url, headers=headers, json=payload)

response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
String body = """
{
  "code": "RPASB5GEAP6FO1",
  "generate_qr_image": "PNG",
  "prefilled_message": "Abhijit..."
}
""";
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls"))
    .header("api key", "<API_KEY>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
$payload = '{
  "code": "RPASB5GEAP6FO1",
  "generate_qr_image": "PNG",
  "prefilled_message": "Abhijit..."
}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ["api key: <API_KEY>","Content-Type: application/json"],
    CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api key", "<API_KEY>");
var json = """
{
  "code": "RPASB5GEAP6FO1",
  "generate_qr_image": "PNG",
  "prefilled_message": "Abhijit..."
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
)

func main() {
    request, err := http.NewRequest("POST", "https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls", bytes.NewBufferString("{\n  \"code\": \"RPASB5GEAP6FO1\",\n  \"generate_qr_image\": \"PNG\",\n  \"prefilled_message\": \"Abhijit...\"\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Content-Type", "application/json")
    request.Header.Set("Accept", "application/json")
    request.Header.Set("api key", "<API_KEY>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}
downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{
"code": "RPASB5GEAP6FO1",
"prefilled_message": "Abhijit...",

"deep_link_url": "https:
"qr_image_url": "http:
1.amazonaws.com/v3/images?url=https%3A%2F%2Fscontent-bom2-
1.xx.fbcdn.net%2Fm1%2Fv%2Ft6%2FAn9QzAPXFIY1DoJPnlMI13J3KlRyn5YeDA8b39
NdG7NKd1QSd8LduFa5Uzkk3INp9-
2FzX_K3C3LWlp_bzNNSkRzaFYgRmY7WI7vVlTtCpxru2aPJ6djhMvLcXiuuWtBTK4FBI
ueais%3Fccb%3D10-5%26oh%3D00_AYCUqDtBQjltvGvCMW_kc0ch85m6_RaZzwiZ4-
trhUGaDQ%26oe%3D675183BB%26_nc_sid%3D5a413f"
}
{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}
ruleHTTP Responses

Status Codes

200The request was successful.
400Bad request or invalid parameters.
401API key is missing or invalid.
403The request is not authorized for this resource.
404The requested resource was not found.
500The server encountered an error.
Global API SearchProducts, versions, endpoints, paths, and payload fields
Esc
Full search page
manage_searchSearch the complete API catalogEnter at least two characters to begin.