Send Media and Location Headers
curl --request POST \
--url https://api.example.com/api/whatsapp/v1/Send \
--header 'Content-Type: application/json' \
--data '
{
"MediaFilePath": "<string>",
"LocationDetail": {},
"LocationDetail.Latitude": "<string>",
"LocationDetail.Longitude": "<string>",
"LocationDetail.Name": "<string>",
"LocationDetail.Address": "<string>"
}
'import requests
url = "https://api.example.com/api/whatsapp/v1/Send"
payload = {
"MediaFilePath": "<string>",
"LocationDetail": {},
"LocationDetail.Latitude": "<string>",
"LocationDetail.Longitude": "<string>",
"LocationDetail.Name": "<string>",
"LocationDetail.Address": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
MediaFilePath: '<string>',
LocationDetail: {},
'LocationDetail.Latitude': '<string>',
'LocationDetail.Longitude': '<string>',
'LocationDetail.Name': '<string>',
'LocationDetail.Address': '<string>'
})
};
fetch('https://api.example.com/api/whatsapp/v1/Send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Send Messages
Send Media and Location Headers
Populate approved WhatsApp templates with media or location headers
Send Media and Location Headers
curl --request POST \
--url https://api.example.com/api/whatsapp/v1/Send \
--header 'Content-Type: application/json' \
--data '
{
"MediaFilePath": "<string>",
"LocationDetail": {},
"LocationDetail.Latitude": "<string>",
"LocationDetail.Longitude": "<string>",
"LocationDetail.Name": "<string>",
"LocationDetail.Address": "<string>"
}
'import requests
url = "https://api.example.com/api/whatsapp/v1/Send"
payload = {
"MediaFilePath": "<string>",
"LocationDetail": {},
"LocationDetail.Latitude": "<string>",
"LocationDetail.Longitude": "<string>",
"LocationDetail.Name": "<string>",
"LocationDetail.Address": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
MediaFilePath: '<string>',
LocationDetail: {},
'LocationDetail.Latitude': '<string>',
'LocationDetail.Longitude': '<string>',
'LocationDetail.Name': '<string>',
'LocationDetail.Address': '<string>'
})
};
fetch('https://api.example.com/api/whatsapp/v1/Send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Templates with dynamic headers can receive an image, video, document, or location at send time. The header type must match the approved template.
The media URL must be publicly reachable by the WhatsApp service.
For per-recipient body values, keep
As with media, a top-level location is shared by all recipients.
Supported media
| Media | File types | Content type |
|---|---|---|
| Image | JPG, JPEG, PNG | image/jpeg, image/png |
| Video | MP4 | video/mp4 |
| Document | application/pdf |
Media header
string
required
Public URL of the image, video, or PDF that matches the template header type.
string
Display name for a PDF document. The value must contain 1–200 characters. If omitted, the document name defaults to
Document.{
"SenderNumber": "15551234567",
"MetaTemplateId": "1754028",
"MediaFilePath": "https://cdn.example.com/invoice.pdf",
"FileName": "Invoice-1042.pdf",
"BulkPayload": {
"RecieverNumber": "15559876543,15557654321",
"BodyVariables": ["Amina", "ORD-1042"]
}
}
MediaFilePath at the top level and replace BulkPayload with CustomPayload:
{
"SenderNumber": "15551234567",
"MetaTemplateId": "1754028",
"MediaFilePath": "https://cdn.example.com/promotion.png",
"CustomPayload": [
{
"RecieverNumber": "15559876543",
"BodyVariables": ["Amina", "20%"]
},
{
"RecieverNumber": "15557654321",
"BodyVariables": ["David", "15%"]
}
]
}
A top-level media file is shared by every recipient in the request. Use carousel cards when each recipient or card needs separate media.
Location header
object
required
Location content for a template with a location header.
string
required
Latitude of the location.
string
required
Longitude of the location.
string
required
Display name for the location.
string
required
Human-readable street address.
curl --request POST \
--url "https://app.notify.ng/api/whatsapp/v1/Send" \
--user "$CLIENT_ID:$API_KEY" \
--header "Content-Type: application/json" \
--data '{
"SenderNumber": "15551234567",
"MetaTemplateId": "18888001",
"LocationDetail": {
"Latitude": "6.5244",
"Longitude": "3.3792",
"Name": "Ruach Lagos Office",
"Address": "Lagos, Nigeria"
},
"BulkPayload": {
"RecieverNumber": "15559876543,15557654321",
"BodyVariables": ["Friday", "10:00 AM"]
}
}'
BodyVariables is optional when the approved template has no body placeholders.