Business API Proxy
PATCH Request
Proxy a PATCH request to the Official WhatsApp Business API
PATCH
/
api
/
v1
/
whatsapp-accounts
/
{id}
/
proxy
/
{path}
/
cURL
curl --request PATCH \
--url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"waId": "<string>"
}
'import requests
url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/"
payload = {
"name": "<string>",
"waId": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', waId: '<string>'})
};
fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'waId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"waId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"waId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"waId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"waId": "<string>",
"phoneNumbers": "<string>",
"templatesUrl": "<string>",
"name": "<string>"
}This endpoint lets you proxy a PATCH request to the Official WhatsApp Business API.
You will be authenticated to the whatsapp account you are proxying for.
Look to the WhatsApp Business API documentation for more information on the available endpoints.
Authorizations
API key authentication. Pass your API key in the X-API-Key header.
Was this page helpful?
⌘I
cURL
curl --request PATCH \
--url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"waId": "<string>"
}
'import requests
url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/"
payload = {
"name": "<string>",
"waId": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', waId: '<string>'})
};
fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'waId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"waId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"waId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-accounts/{id}/proxy/{path}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"waId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"waId": "<string>",
"phoneNumbers": "<string>",
"templatesUrl": "<string>",
"name": "<string>"
}