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 Product List

AI-generated

Summary

Send a WhatsApp multi-product list message via Kapso API to a specified recipient number using a selected catalog and customized message components.

Inputs

  • Phone Number Name or ID — Select the connected Kapso WhatsApp phone number from which to send the message, loaded from your Kapso project; required for sends and must be chosen from the list or specified by ID via expression.
  • Recipient Phone (required) — The recipient's phone number in Meta format consisting of 8-15 digits with no plus sign or spaces.
  • Product List Header Type (required) — Select the header format type for the multi-product list message; options include text, image, video, or document.
  • Product List Header Text (required) — If header type is text, provide the header text shown above product sections (1–60 characters).
  • Header Media Source — For image, video, or document headers, specify whether the media is a public HTTPS URL or an existing Meta media ID.
  • Header Media URL (required) — If media source is 'link', provide the public HTTPS URL of the header media.
  • Header Media ID (optional) — If media source is 'id', specify the Meta media ID returned by media upload or Kapso Trigger media attachment.
  • Header Document Filename (optional) — For document header type, optionally set the filename shown to the recipient.
  • Catalog (required) — Select the WhatsApp catalog linked to the phone number from which products are chosen; supports searching recent catalogs or specifying by ID.
  • Body Text (required) — Main text body of the interactive message (max 1024 characters).
  • Product Sections (required) — Define 1 to 10 catalog sections with custom section titles and the products they contain (maximum 30 products total), selecting products from the chosen catalog.
  • Footer Text (optional) — Optional footer text displayed below the interactive product list (max 60 characters).
  • Message Send Options — Optional settings including message reply context and callback data metadata for correlation in message status webhooks.

Output shape

a single message send confirmation response object from Kapso API

The output includes the server's response to the send request; no pagination or multiple items returned. Errors are surfaced as operation failures.

Links

Discussion