Kapso API icon

Kapso API

Send WhatsApp messages, templates, flows, media, contacts, broadcasts, and inbox records through Kapso. Choose a resource, then follow each operation setup hints.

Message → Send Template

AI-generated

Summary

Send an approved WhatsApp template message from a selected Kapso WhatsApp phone number to a specified recipient, filling in all required placeholders and optionally configuring buttons and header content according to the template's structure.

Inputs

  • Phone Number Name or ID — Select the Kapso connected WhatsApp phone number used to send the template message; options load dynamically from your Kapso project.
  • Recipient Phone (required) — The recipient's phone number formatted as 8-15 digits without the plus sign or spaces.
  • Template (required) — Approved WhatsApp template for the message, selectable by search or by entering template_name|language_code; ensure the template is synced and approved in Kapso.
  • Detected Template Header Format Name or ID — Automatically detected header type from the selected template; typically read-only and used for determining header input fields.
  • Detected Template Layout Name or ID — Automatically detected template layout (Standard or Carousel); used to control which template fields appear, typically read-only.
  • Body Text Parameters — For standard templates with body placeholders, map one value per placeholder selecting appropriate types (Text, Currency, Date & Time).
  • Header Text — Optional header text (max 60 characters) shown above the message body for text headers when the template requires it.
  • Header Media Source and Content — For templates with media headers, specify a public URL or media ID corresponding to the approved template type (image, video, document).
  • Header Location Details — For location header templates, provide latitude and longitude as required, with optional location name and address.
  • Carousel Body Parameters — For carousel-layout templates, map values for each carousel card body placeholder, grouped by card index.
  • Carousel Cards — Define each carousel card's header media, buttons, and content aligned with the approved template's zero-based card index.
  • Button Parameters — For standard templates, provide dynamic button values including URL suffixes, quick replies (text or payload), flow buttons with optional action data, copy-code coupons, catalog buttons, or multi-product message buttons as required by the template.
  • Template Advanced Options — Provide expert JSON overrides for edge cases unhandled by structured parameters.

Output shape

a single record

The operation returns the raw response from the Kapso API representing the sent template message status or error details if sending fails.

Links

Discussion