{"id":3694,"date":"2026-01-02T08:54:33","date_gmt":"2026-01-02T08:54:33","guid":{"rendered":"https:\/\/zestudents.com\/misbah\/?page_id=3694"},"modified":"2026-01-02T11:24:52","modified_gmt":"2026-01-02T11:24:52","slug":"developer-apis","status":"publish","type":"page","link":"https:\/\/zestudents.com\/misbah\/developer-apis\/","title":{"rendered":"Developer APIs"},"content":{"rendered":"\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t
\n\t\t\t<\/path><\/svg>\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Search for articles…<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t

\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

All Collection <\/a><\/span>Template Messages & Broadcasting \u00a0<\/a><\/span>API Reference Docs<\/span><\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t

\n\t\t\t\t\t

API Reference Docs<\/h2>\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

API Reference Docs to run automated API campaigns.<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t

\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"\"\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
Written by\u00a0Shivam Aggarwal<\/div>

Updated over 7 months ago<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t

\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t
Table of contents <\/div><\/span>\n\t\t\t\t\t\t\t\t\t<\/summary>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
Step: 1- Create an API campaign in AiSensy.<\/a><\/span><\/section>
1. In AiSensy App, go to Campaigns, click on +Launch & select API Campaign<\/a><\/span><\/section>
2. Add a Campaign name, select a pre-approved template to which you wish to send using the campaign & set the API campaign live<\/a><\/span><\/section>
Step 2: Integrating AiSensy with your CRM<\/a><\/span><\/section>
1. Connect your trigger point of your CRM\/ website\/ 3rd party software using JSON key format & endpoint URL given below<\/a><\/span><\/section>
HTTP Request<\/a><\/span><\/section>
Example Postman Request<\/a><\/span><\/section>
Response Bod<\/a><\/span><\/section><\/div><\/div><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/details>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Wish to automate WhatsApp campaigns by connecting your CRM with AiSensy?<\/p><\/div>

In this document, we’ll explain the exact steps to automate WhatsApp notifications via API campaigns using AiSensy.<\/p><\/div>

Step: 1- Create an API campaign in AiSensy.<\/b><\/span><\/h4>

1. In AiSensy App, go to Campaigns, click on +Launch & select API Campaign<\/span><\/b><\/h3><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"\"\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t

2. Add a Campaign name, select a pre-approved template to which you wish to send using the campaign & set the API campaign live\n<\/h2>\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"\"\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Note: Make sure your WhatsApp template message is created & approved before creating the API Campaign. For reference, check out how to create WhatsApp templates in AiSensy<\/a>.<\/span><\/span>
\u200bStep 2: Integrating AiSensy with your CRM<\/b><\/p><\/div>

For this step, you would need your development team to help you out with the integration process.<\/p><\/div>

1. Connect your trigger point of your CRM\/ website\/ 3rd party software using JSON key format & endpoint URL given below<\/b><\/p><\/div>

HTTP Request<\/b><\/span><\/h4><\/div>

POST<\/span> https:\/\/backend.aisensy.com\/campaign\/t1\/api\/v2<\/a><\/span><\/p><\/div>

{
\"apiKey\": string,
\"campaignName\": string,
\"destination\": string,
\"userName\": string,
\"source\": string,
\"media\": {
\"url\": string,
\"filename\": string
},
\"templateParams\": [
string
],
\"tags\": [
string
],
\"attributes\": {
\"attribute_name\": string
}
}<\/pre><\/div>
Send notifications to users through API:<\/p><\/div>
NOTE<\/b><\/span>: In case of a new user (i.e. the user doesn\u2019t exist on your contact list in AiSensy Platform) then a new contact will get created with the incoming details.<\/p><\/div>
Populate the Jason key strings against each attribute according to the table below<\/p><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t\t
\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Fields<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\t\nDescription<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
apiKey<\/span><\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string<\/span>
\u200b<\/span>\u200bRequired<\/b>. API key generated from the dashboard.<\/span><\/p>
Go to manage> API Key >Copy the key<\/span><\/p><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
campaignName<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string
\u200bRequired<\/b>. Name of thecampaign which has to be sent to the user. The status of the campaign should be \u2018Live\u2019.<\/p><\/div>
Go to campaigns> Copy the name of the API campaign created<\/span><\/p><\/div><\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
destination<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string
\u200b
\u200bRequired<\/b>. Mobile number of users with country dial-code to whom the campaign has to be sent.
e.g. \u2013 +917428526285 (India)<\/p><\/div>
For all numbers outside India, it’s mandatory to provide it in +(country code)(phone number)<\/p><\/div>
For Indian numbers, it’s optional to provide it in +(country code)(phone number)<\/p><\/div>
If a phone number can’t be resolved to any country then, it is by default considered to be from India(+91).<\/p><\/div><\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
userName<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string
\u200b\u200bRequired<\/b> Name of the user to whom the campaign has to be sent.<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
source<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string
\u200b
\u200bOptional<\/b>. Source of lead. It is to create a source-based segment to re-target.
e.g.- \u2018Facebook forms\u2019, \u2018Website lead\u2019, \u2018Youtube lead\u2019<\/p><\/div><\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
media<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
object
\u200b
\u200bOptional<\/b>. URL & filename of media that has to be sent with the template message.<\/p><\/div><\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
location<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string<\/p><\/div>

Required. latitude, longitude, name & address of location that has to be sent with the template message<\/p><\/div><\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
templateParams[]<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string
\u200b\u200bOptional<\/b>. An array of parameter values to fill in a template message<\/p><\/div>
If there is any dynamic value included in the template message enter the details of it. Multiple values are separated by comma<\/p><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
tags[]<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
string
\u200b
\u200bOptional<\/b>. An array of tag names to assign to the user.<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
attributes<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
object with key-value pairs. The only string is allowed as the key’s value.<\/p><\/div>
Optional<\/b>. The object should contain keys already added as assistant attributes paired with values that you want to set as user’s attributes.<\/span><\/p><\/div><\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t
\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
Example Postman Request<\/b><\/span><\/h3>
Step 1 – Setup request type to “POST”<\/span><\/p><\/div>
Step 2 – Setup URL<\/span><\/p><\/div>
Step 3 – Choose body type “raw”<\/span><\/p><\/div>
Step 4 – Select “JSON” type<\/span><\/p><\/div>
Step 5 – Set content of the request<\/span><\/p><\/div>
You can find more examples here – <\/span>Open in Postman<\/a><\/p><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"\"\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
NOTES:<\/b><\/span><\/p><\/div>