Skip to content
LeadPattern
Reference/Outgoing Messages

Outgoing Messages API

LeadPattern Outgoing Messages API: 13 endpoints with request parameters, response schemas, error codes and cURL, Node.js and Python examples.

POSTSend Text Message/whatsapp/message/textSend a plain text WhatsApp message to a contact.POSTSend Image Message/whatsapp/message/imageSend an image to a contact using a public URL.POSTSend Document Message/whatsapp/message/documentSend a PDF or other document file using a public URL.POSTSend Audio Message/whatsapp/message/audioSend an audio file to a contact using a public URL.POSTSend Video Message/whatsapp/message/videoSend a video file to a contact using a public URL.POSTSend Location Message/whatsapp/message/locationSend a geographic location pin to a contact.POSTBatch Send Messages/whatsapp/message/batchSend one request to multiple recipients, each with its own message type and content (text, image, document, audio, video, location). Each recipient counts as one request against the API key's per-minute rate limit.POSTSend Template Message/whatsapp/message/templateSend an approved WhatsApp template. Supports batch sending via the messages array — each item can also include an optional "scheduledAt" (ISO date-time) to send that recipient's message at a future time instead of immediately. Body placeholders are positional strings, matched in order to the template's variables. For a DOCUMENT header, also pass header.filename (e.g. "invoice.pdf") — without it, WhatsApp shows the recipient a generic/blank file name instead of a readable one. filename only applies to DOCUMENT headers, not IMAGE or VIDEO.POSTSend Template Message (V2)/v2/whatsapp/message/templateSend approved templates with named key-value placeholders instead of positional strings. Recommended for clarity. Each message item can also include an optional "scheduledAt" (ISO date-time) to send at a future time instead of immediately. Media headers use the same templateData.header shape as the v1 endpoint (type, mediaUrl, and — for a DOCUMENT header only — filename, e.g. "invoice.pdf", so WhatsApp shows a readable file name instead of a generic one).POSTSend Authentication Template/whatsapp/message/auth-templateSend an approved AUTHENTICATION/OTP template. Dedicated endpoint — Meta requires a positional body parameter (the code) plus a matching OTP button parameter, which the generic /whatsapp/message/template endpoint does not build. Supports batch sending via the messages array.POSTSend Interactive Button Message/whatsapp/message/interactive-buttonSend a message with up to 3 quick-reply buttons.POSTSend Interactive List Message/whatsapp/message/interactive-listSend a message with a scrollable list of options organised into sections.POSTSend Interactive Media Button Message/whatsapp/message/interactive-mediaSend an interactive button message with an image or video header.