ChatInstall

Summary

Send a WhatsApp template message to a specified conversation.

Inputs

• accountId (required) — Select the WhatsApp account to use.
• inboxId (required) — Select the inbox through which the message is sent.
• conversationId (required) — Select the conversation that receives the message.
• templateName (required) — Select the WhatsApp message template to use.
• templatePreview — View the structure of the selected template; informational only and does not affect the message.
• components — Add template components with dynamic parameters to customize the message.

Output shape

a single record representing the sent message (typically includes message ID and status)

The response may contain additional metadata such as timestamps; pagination is not applicable.

Examples

Example 1: Send a welcome template to a specific conversation.

accountId=12345, inboxId=67890, conversationId=11223, templateName=welcome_msg, components=[{type:'button', sub_type:'quick_reply', index:0, buttonParameter='greeting'}]

Example 2: Send a promotional template with a header image and a URL button.

accountId=11111, inboxId=22222, conversationId=33333, templateName=promo_msg, components=[{type:'header', headerParameters:{mediaUrl:'https://example.com/img.png'}}, {type:'button', sub_type:'url', index:0, buttonParameter='https://offer.example.com'}]

Example 3: Send a quick reply template using the default button index.

accountId=55555, inboxId=66666, conversationId=77777, templateName=reminder_msg, components=[{type:'button', sub_type:'quick_reply', index:0, buttonParameter='reminder_payload'}]

Links

• n8n community nodes installation guide