Skip to main content
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>"
}
'
{
  "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

​
X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Path Parameters

​
id
string
required
​
path
string
required
Pattern: ^.+$

Body

application/json
​
name
string | null
Maximum string length: 255
​
waId
string

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
waId
string
required
​
phoneNumbers
string
required
read-only
​
templatesUrl
string
required
read-only
​
name
string | null
Maximum string length: 255