GET /contact/list Retrieve paginated contact list
Query Parameters
Name Description Value
page Page number
paginate Items per page
search Search by name or mobile
Response
POST /contact/store Create a new contact
Request Body
Name Description Value
firstname required First name
lastname required Last name
mobile_code required Country code without +
mobile required Mobile number
city City (optional)
address Address (optional)
Response
POST /contact/update/{id} Update an existing contact
Path Parameters
Name Description Value
{id} required Contact ID
Request Body
Name Description Value
firstname
lastname
mobile_code
mobile
Response
DELETE /contact/delete/{id} Permanently delete a contact
Path Parameters
Name Description Value
{id} required Contact ID
Response
GET /inbox/conversation-list Paginated list of conversations
Query Parameters
Name Description Value
status Filter by status
— All —, 1 – Done, 2 – Pending, 3 – Important, 4 – Unread
page Page number
paginate Items per page
Response
GET /inbox/conversation-messages/{id} All messages in a conversation
Path Parameters
Name Description Value
{id} required Conversation ID
Response
GET /inbox/conversation-details/{id} Full details of a conversation
Path Parameters
Name Description Value
{id} required Conversation ID
Response
POST /inbox/change-conversation-status/{id} Update conversation status
Path Parameters
Name Description Value
{id} required Conversation ID
Request Body
Name Description Value
status required New status value
1 – Done, 2 – Pending, 3 – Important, 4 – Unread
Response
POST /inbox/send-message Send a WhatsApp text / media message
Request Body
Name Description Value
mobile_code required Country code without +
mobile required Mobile number
message required Message text
from_number Business phone (digits) or Meta phone_number_id; optional
Response
GET /inbox/template-list Get all approved WhatsApp templates
Response
POST /inbox/send-template-message Send template — enable optional sections for body variables (×5) and header
Request Body
Name Description Value
mobile_code required Country code without +
mobile required Recipient mobile (digits only)
template_id required Meta WhatsApp template ID
from_number Business number or phone_number_id (optional)
body_variables[0] Body placeholder #1 (order matches template {{1}})
body_variables[1] Body placeholder #2 (order matches template {{2}})
body_variables[2] Body placeholder #3 (order matches template {{3}})
body_variables[3] Body placeholder #4 (order matches template {{4}})
body_variables[4] Body placeholder #5 (order matches template {{5}})
Response
POST /inbox/send-template-message Shortcut: template with media header only
Request Body
Name Description Value
mobile_code required Country code
mobile required Mobile number
template_id required Template ID
from_number Business phone or phone_number_id
header_media_url Public HTTPS URL (IMAGE/VIDEO/DOCUMENT header)
header_media_type Header media type
image, video, document
header_media_filename Filename for document headers
Response
POST /inbox/send-template-message Shortcut: header media + body variables (same as Send Template with both sections enabled)
Request Body
Name Description Value
mobile_code required Country code
mobile required Mobile number
template_id required Template ID
from_number Business phone or phone_number_id
body_variables[0] Body placeholder #1 (order matches template {{1}})
body_variables[1] Body placeholder #2 (order matches template {{2}})
body_variables[2] Body placeholder #3 (order matches template {{3}})
body_variables[3] Body placeholder #4 (order matches template {{4}})
body_variables[4] Body placeholder #5 (order matches template {{5}})
Response
POST /inbox/send-template-message Send template with order / payment details
Request Body
Name Description Value
mobile_code required Country code
mobile required Mobile number
template_id required Template ID
from_number Business phone or phone_number_id
body_variables[0] Body placeholder #1 (order matches template {{1}})
body_variables[1] Body placeholder #2 (order matches template {{2}})
body_variables[2] Body placeholder #3 (order matches template {{3}})
body_variables[3] Body placeholder #4 (order matches template {{4}})
body_variables[4] Body placeholder #5 (order matches template {{5}})
configuration_name Payment config name
item_name Order item name
amount Amount (INR)
goods_type Goods type
digital-goods, physical-goods
reference_id Order reference ID
quick_pay Enable quick pay
Yes (1), No (0)
Response
POST /inbox/send-template-message Send template with footer button values (URL dynamic suffix, full URL, or phone)
Request Body
Name Description Value
mobile_code required Country code
mobile required Mobile number
template_id required Template ID
from_number Business phone or phone_number_id
button_variables[0][type] Footer button #1 type (must match template button at this index)
— skip —, URL, PHONE_NUMBER
button_variables[0][url_variables][0] Dynamic URL value for button #1 (fills {{1}} in template URL)
button_variables[0][url] Full URL for button #1 when the template has a static URL (no {{}} placeholder)
button_variables[0][phone_number] Phone number for PHONE_NUMBER button #1 (with country code)
button_variables[1][type] Footer button #2 type (must match template button at this index)
— skip —, URL, PHONE_NUMBER
button_variables[1][url_variables][0] Dynamic URL value for button #2 (fills {{1}} in template URL)
button_variables[1][url] Full URL for button #2 when the template has a static URL (no {{}} placeholder)
button_variables[1][phone_number] Phone number for PHONE_NUMBER button #2 (with country code)
button_variables[2][type] Footer button #3 type (must match template button at this index)
— skip —, URL, PHONE_NUMBER
button_variables[2][url_variables][0] Dynamic URL value for button #3 (fills {{1}} in template URL)
button_variables[2][url] Full URL for button #3 when the template has a static URL (no {{}} placeholder)
button_variables[2][phone_number] Phone number for PHONE_NUMBER button #3 (with country code)
Response
POST /auth/app-store-signup Send OTP for app store signup (mobile or email)
Request Body
Name Description Value
name required Full name of the customer
mobile_code Country dial code without + (required if mobile provided)
mobile Mobile number (required if email not provided)
email Email address (required if mobile not provided)
Response