Skip to main content
GET
cURL
Approved Meta templates for one connected phone number. Required query params: type=whatsapp and phoneNumberId (the workflow’s associatedToBusinessId). When to call this
  • Starter / outbound — the bot opens the conversation (workflowTrigger, POST /trigger, campaign-style send, or any send outside the 24-hour window).
  • The user asked for a named catalog template (even on a reply bot).
Skip this call for inbound reply bots (pingmeeTrigger Messages Created / New Conversation Started, keyword router). Those use messageType: "custom" — infer intent on Build a workflow. When you do fetch:
  1. Bind the phone first (GET phone numbers).
  2. GET this list and keep status === "APPROVED".
  3. Copy the template object into the WhatsApp node’s templateInformation.
  4. Set messageType: "template" and templateType: "whatsapp".
  5. Bind BODY / text HEADER placeholders with bodyVariables / headerVariables.
Skip templates whose HEADER format is IMAGE, VIDEO, or DOCUMENT unless attachmentS3Id is already on that component — there is no public upload API. Field mapping: WhatsApp templates.

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Query Parameters

type
enum<string>
required

Template platform type. Use whatsapp for Meta catalog templates.

Available options:
whatsapp
phoneNumberId
string
required

Phone-number id from GET /phone-numbers (workflow associatedToBusinessId). Do not use the WABA id.

Response

WhatsApp templates (Meta catalog shape)

id
string
required

Template id. Copy into templateInformation.id.

name
string
required

Template name. Copy into templateInformation.name. Do not invent this.

language
string

Template language code (for example en, he).

status
string

Use only APPROVED templates when the bot opens a conversation (starter/outbound). Reply bots do not need this list.

category
string

Meta category such as UTILITY, MARKETING, or AUTHENTICATION.

components
object[]

HEADER / BODY / FOOTER / BUTTONS. Copy the array into templateInformation.components. Bind BODY {{n}} with bodyVariables and text HEADER {{n}} with headerVariables.

Last modified on September 4, 2026