LIVE API campaign. You supply the contact’s details, the campaign to use, and the dynamic values to fill into the template’s placeholders — Convo handles routing the message through the WhatsApp Business API.
Each call sends to exactly one contact. To send to multiple contacts, call this endpoint once per recipient (in parallel or sequentially).
Endpoint
Authentication
Path Parameters
string
required
Your Convo project ID.
Request Body
string
required
The contact’s full name. Used to create or update the contact record in Convo.
string
required
The contact’s phone number including the country code, without a leading
+ or spaces (e.g., "917089379345" for an Indian number). If the country code is omitted, provide default_country_code to prepend it automatically.string
required
The
name of the API campaign to use for this send. The campaign must have status: "LIVE". Use the name you specified when creating the campaign.array
An ordered array of string values to substitute into the template’s
{{1}}, {{2}}, {{3}} placeholders. The number of items must exactly match total_parameters on the linked template.You can use the following dynamic variables anywhere in the array:Example:
["Priya", "#ORD-789", "3"]object
Required for campaigns linked to
IMAGE, VIDEO, or FILE type templates. Contains:string
The acquisition source for this contact (e.g.,
"website", "facebook_ad", "referral"). Stored on the contact record for segmentation and analytics.object
A key-value object of custom attributes to set on the contact record. Keys must correspond to existing custom attribute definitions in your Convo project.Example:
{"plan": "premium", "city": "Mumbai", "order_value": "1299"}string
A country code (without
+) to prepend to phone_number if the number does not already include one. For example, "91" for India. Useful when your data source stores numbers without country codes.array
An array of tag name strings to assign to the contact. Tags must already exist in your Convo project — this endpoint does not create new tags.Example:
["vip", "Q4-cohort"]Request Examples
- Simple Send
Send a shipping update with order details as template parameters:
Response
A successful send returns200 OK.
success response means Convo has accepted and queued the message for delivery. It does not guarantee delivery to the end user’s device — use webhook events or the Get Campaign endpoint to track delivery status.