Wavixo API Reference Documentation

Step 1 — Create an API Campaign inside Wavixo

(Shown in the images on pages 1–2)
1. Open the Campaigns section in Wavixo

2. Click +Launch

3. Select API Campaign

On page 2, the UI screenshot shows the campaign type selection modal with "API Campaign" highlighted.
Next:

Enter your Campaign Name

Select a Pre-approved WhatsApp Template Message

Click Set Live to activate the campaign

📌 Your WhatsApp Template Message must already be created and approved before setting an API campaign live.

Step 2 — Integrate Wavixo with Your CRM

Your development team will be required to perform the API integration.
You’ll need to send a POST request to the Wavixo endpoint with JSON payload parameters.

Field-by-Field Explanation

Below is the rewritten description of each field:

Required Fields
apiKey
Your unique API key from Wavixo Dashboard

Retrieve it via Manage → API Key → Copy

campaignName

The name of the active API Campaign

Must match exactly with the campaign created inside Wavixo

Campaign should be LIVE

Found under Campaigns section


destination
Customer’s mobile number including country code

Example for India: +91765432102

For non-Indian numbers: including +country code is mandatory

If no country code is provided and cannot be inferred → defaults to +91 (India)

userName
Name of the user receiving the message

Optional Fields
source
Used to identify the lead source. Examples include:
Facebook Forms

Website Lead

YouTube Lead

Useful for segment creation & retargeting.

media (object)
Contains media information:
url: publicly accessible media file link

filename: name of the file

location
Used when your template uses WhatsApp location messages.
Includes:

latitude

longitude

address

location name

templateParams[]
Array of values required to fill your template placeholders

If template has {{1}}, {{2}}, etc — populate their values here

Must match exact number of required parameters


tags[]
Array of tag names to assign to the user

Tags must already exist in Wavixo

If a tag doesn't exist → it is ignored

attributes (object)
Key-value pairs representing custom attributes

Attribute keys must already exist

Only string values are allowed

Unknown attributes are ignored

Example POST Request (from page 5–6 screenshots)

The Postman example includes:
Setting request type to POST

Adding endpoint URL

Choosing body type raw

Selecting JSON

Adding request payload

(Screenshot on page 7 displays a full working JSON example.)

Important Notes

Optional fields are not required in the request payload

Media URLs must be publicly accessible or the request will fail

The number of template parameters must match the template’s variable count

Tags should exist beforehand or they will be ignored

Attributes should exist beforehand or they will be ignored

API Response

If the request is successful:
Response Status: 200 OK

Prerequisites Before Using API

You must have a verified WhatsApp Business API

Your WhatsApp Template Messages must be approved

An API Campaign must already be created inside Wavixo

Related Articles