The GainWix API is organized around REST principles. It features predictable, resource-oriented URLs and supports form-encoded request bodies. The API returns JSON-encoded responses, follows standard HTTP response codes, and uses authentication and standard HTTP verbs for interaction.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38419539","collectionId":"cb1249fd-6d60-457b-8704-a6abff76262a","publishedId":"2sAYkKKJbJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-26T06:53:00.000Z"},"item":[{"name":"WhatsApp Session Message","item":[{"name":"Send Text Message","id":"72ffc3aa-9e97-4269-a5cc-ced08763e366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"brand_id\": \"033c63214caa4a3cad0fb2dd2f78ded2\",\n \"from_number_id\": 745614371958793,\n \"mobile_number\": 7871921095,\n \"country_code\": 91,\n \"body\": {\n \"type\": \"text\",\n \"text\": {\n \"body\": \"Message from Developer API POST\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_message_via_api","description":"This API allows sending a text message. The request includes details such as the body, brand ID, campaign ID, sender number, recipient number.This API endpoint sends a text message using the Developer API. The request payload includes:
\nbrand_id: The unique identifier for the brand sending the message.
from_number_id: The ID of the sender's WhatsApp number.
mobile_number: The recipient's phone number.
country_code: The recipient's country calling code.
body: The content of the message, including the message type (text) and the message text itself.
This API request sends an image message through the Developer API. The payload includes brand and sender details along with the recipient information and the image content.
\nThe API supports the following document formats:
\n.png, .jpg, .jpeg
brand_id: The unique identifier for the brand initiating the message.
from_number_id: The ID of the WhatsApp sender number.
mobile_number: The recipient's phone number.
country_code: The recipient's country dialing code.
message_body: The message payload containing:
type: Must be set to \"image\" for image messages.
image: An object containing:
link: A publicly accessible URL pointing to the image file.
caption: (Optional) A text caption to be sent along with the image.
This API request sends a video message using the Developer API. The request includes brand information, sender and recipient details, and the video payload.
\nThe API supports the following document formats:
\n.mp4
brand_id: Unique identifier for the brand sending the message.
from_number_id: ID of the WhatsApp-enabled sender number.
mobile_number: Recipient’s phone number.
country_code: Country code of the recipient’s phone number.
message_body: Contains:
type: Must be \"video\" to indicate a video message.
video: An object containing:
link: A direct, publicly accessible URL to the video file (MP4 format recommended).
caption: (Optional) Text that appears along with the video.
This API request is used to send a document via the Developer API over WhatsApp. The request includes brand and sender details, recipient contact, and the document content.
\nThe API supports the following document formats:
\n.pdf, .txt, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .csv
brand_id: Unique identifier for the brand sending the message.
from_number_id: ID of the WhatsApp-enabled sender number.
mobile_number: The recipient’s phone number.
country_code: The recipient’s country calling code.
message_body: Contains:
type: Must be \"document\" to indicate a document message.
document: An object containing:
link: A publicly accessible URL pointing to the document file (PDF).
caption: (Optional) Text that appears along with the video.
This API allows sending a pre-approved WhatsApp message template as part of an API campaign. The request includes details such as the template name, brand ID, campaign ID, sender number, recipient number, and dynamic custom values for personalization.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","whatsapp","conversations","send_template_via_api_campaign"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"1d0070b7-09fd-4d70-850f-0b80e386d960","name":"Conversation send","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\"\n\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"fadc128ff3f7ca91f1e97219edc550e6\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ef629711-375e-43bd-9ad8-2b20541f874d"},{"key":"x-runtime","value":"6.871060"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=3185.88, instantiation.active_record;dur=414.70, transaction.active_record;dur=1122.14, process_action.action_controller;dur=6799.62"},{"key":"Content-Length","value":"265"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"meta_res\": {\n \"status\": true,\n \"response\": {\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"919384727144\",\n \"wa_id\": \"919384727144\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgMOTE5Mzg0NzI3MTQ0FQIAERgSMEQwNDkxODczRUJCN0Q5RDY1BB==\",\n \"message_status\": \"accepted\"\n }\n ]\n }\n }\n}"}],"_postman_id":"a817c736-1a11-46f0-bbaf-fd74e484e7bc"},{"name":"Conversation Send - Authentication","id":"e5b96bf4-298b-4671-bd71-4d434c81689c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"auth_test_1\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc16\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168d0\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"otp-number\": 12345\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign","description":"This API is used to send authentication messages via WhatsApp using a pre-approved template. It is commonly used for OTP-based verification, ensuring secure user authentication. The request includes the template name, brand ID, campaign ID, sender number, recipient number, and a dynamically generated OTP value.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","whatsapp","conversations","send_template_via_api_campaign"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"dc06cbb5-4079-48ef-a892-8ff22914a123","name":"Conversation Send - Authentication","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"auth_test_1\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc16\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168d0\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"otp-number\": 12345\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"b07f12548f7c15700378f8b99ce539d3\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"76bbeea5-abc5-4424-9e29-91c7a55f6d5c"},{"key":"x-runtime","value":"3.975313"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1222.06, instantiation.active_record;dur=5.08, transaction.active_record;dur=199.54, process_action.action_controller;dur=3925.05"},{"key":"Content-Length","value":"265"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"meta_res\": {\n \"status\": true,\n \"response\": {\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"919384727144\",\n \"wa_id\": \"919384727144\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgMOTE5Mzg0NzI3MTQ0FQIAERgSOTNENkIwMkJBRTA4NDRCMkM4AA==\",\n \"message_status\": \"accepted\"\n }\n ]\n }\n }\n}"}],"_postman_id":"e5b96bf4-298b-4671-bd71-4d434c81689c"},{"name":"Conversations Send - PDF","id":"8e2ac7d7-7b09-4423-87bf-d7a48468db78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/file.pdf\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign","description":"This API allows sending a WhatsApp message with a PDF attachment using a pre-approved template where the header format is set to \"document\". It is ideal for sharing invoices, reports, e-books, tickets, or other important documents. The request includes the template name, brand ID, campaign ID, sender number, recipient number, and a media URL pointing to the PDF file.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","whatsapp","conversations","send_template_via_api_campaign"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"228bfa3e-6480-4e0f-a150-918e476535ef","name":"Conversations Send - PDF","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/file.pdf\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"28aa66b0f48c38889a881d8bf164ae85\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"89055807-5bfe-4a5f-9044-8829c8efc050"},{"key":"x-runtime","value":"2.229678"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1123.87, instantiation.active_record;dur=4.70, transaction.active_record;dur=505.25, process_action.action_controller;dur=2193.46"},{"key":"Content-Length","value":"265"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"meta_res\": {\n \"status\": true,\n \"response\": {\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"919384727144\",\n \"wa_id\": \"919384727144\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgMOTE5Mzg0NzI3MTQ0FQIAERgSRDE5NjQyMTQ2OThDODA0MkREBB==\",\n \"message_status\": \"accepted\"\n }\n ]\n }\n }\n}"}],"_postman_id":"8e2ac7d7-7b09-4423-87bf-d7a48468db78"},{"name":"Conversations Send - Video","id":"3b91225c-1e96-4443-9557-d563a9cc6dd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/video.mp4\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign","description":"This API allows sending a WhatsApp message with a video attachment using a pre-approved template where the header format is set to \"video\". It is useful for sharing promotional videos, tutorials, announcements, or other video content. The request includes the template name, brand ID, campaign ID, sender number, recipient number, and a media URL pointing to the video file.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","whatsapp","conversations","send_template_via_api_campaign"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"10a27b05-edbd-4216-80ea-4ec344437605","name":"Conversations Send - Video","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/video.mp4\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"8e0841b615d7ca9ba72b7472c8c1c583\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"779c003a-b8d2-430e-a49c-d3ad12c53bc6"},{"key":"x-runtime","value":"3.948071"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1806.78, instantiation.active_record;dur=5.17, transaction.active_record;dur=705.49, process_action.action_controller;dur=3831.52"},{"key":"Content-Length","value":"265"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"meta_res\": {\n \"status\": true,\n \"response\": {\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"919384727144\",\n \"wa_id\": \"919384727144\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgMOTE5Mzg0NzI3MTQ0FQIAERgSRkE4MUU1MEYwM0Q5NDBDMDhIAA==\",\n \"message_status\": \"accepted\"\n }\n ]\n }\n }\n}"}],"_postman_id":"3b91225c-1e96-4443-9557-d563a9cc6dd0"},{"name":"Conversations Send - Image JPG","id":"cfbaed81-a0ef-4cb9-9b63-9b5d298c4d71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241648,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/image.jpg\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign","description":"This API allows sending a WhatsApp message with an image attachment using a pre-approved template where the header format is set to \"image\". It is commonly used for sharing product images, promotional banners, event posters, or other visual content. The request includes the template name, brand ID, campaign ID, sender number, recipient number, and a media URL pointing to the image file.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","whatsapp","conversations","send_template_via_api_campaign"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"4a933a5a-e4a4-47fe-b33e-e5374e670e7d","name":"Conversations Send - Image JPG","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241648,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/image.jpg\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"4f5d26b4f7f9a41ff529d961f64a6754\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"8686b5f2-ace3-4f06-a649-acc51804a259"},{"key":"x-runtime","value":"3.912500"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1494.91, instantiation.active_record;dur=12.39, transaction.active_record;dur=558.14, process_action.action_controller;dur=3870.49"},{"key":"Content-Length","value":"265"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"meta_res\": {\n \"status\": true,\n \"response\": {\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"919384727144\",\n \"wa_id\": \"919384727144\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgMOTE5Mzg0NzI3MTQ0FQIAERgSRDYwNTIzMUFBNTY5QUQxREYyBB=\",\n \"message_status\": \"accepted\"\n }\n ]\n }\n }\n}"}],"_postman_id":"cfbaed81-a0ef-4cb9-9b63-9b5d298c4d71"},{"name":"Conversations Send - Image PNG","id":"ad550bef-886b-4e8f-80a9-5c61215838a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/image.png\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign","description":"This API allows sending a WhatsApp message with an image attachment using a pre-approved template where the header format is set to \"image\". It is commonly used for sharing product images, promotional banners, event posters, or other visual content. The request includes the template name, brand ID, campaign ID, sender number, recipient number, and a media URL pointing to the image file.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","whatsapp","conversations","send_template_via_api_campaign"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"0225f244-1c2c-4a9a-a87d-452263016e99","name":"Conversations Send - Image PNG","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_name\": \"template_name\",\n \"brand_id\": \"c5352e42f18044dca02eba9ac0b4bc\",\n \"campaign_id\": \"dc70f2b9054a4246a9bade9349f168\",\n \"from_number_id\": 118234031241638,\n \"mobile_number\": 9384727144,\n \"country_code\": 91\n ,\"custom_values\": [{\n \"first-name\": \"John\",\n \"last-name\": \"Doe\",\n \"media_url\": \"https://www.api.gainwix.ai/doc/image.png\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/whatsapp/conversations/send_template_via_api_campaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"0b79bf30ae17197a70ec7e7eb42c2722\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"f4b68ed8-754e-44e0-add7-30a95df227fd"},{"key":"x-runtime","value":"2.066311"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1078.40, instantiation.active_record;dur=2.48, transaction.active_record;dur=496.39, process_action.action_controller;dur=2044.96"},{"key":"Content-Length","value":"265"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"meta_res\": {\n \"status\": true,\n \"response\": {\n \"messaging_product\": \"whatsapp\",\n \"contacts\": [\n {\n \"input\": \"919384727144\",\n \"wa_id\": \"919384727144\"\n }\n ],\n \"messages\": [\n {\n \"id\": \"wamid.HBgMOTE5Mzg0NzI3MTQ0FQIAERgSMEMyRkNGRjVCMEQzRDIxQzU1AB=\",\n \"message_status\": \"accepted\"\n }\n ]\n }\n }\n}"}],"_postman_id":"ad550bef-886b-4e8f-80a9-5c61215838a1"}],"id":"cf04eacf-0e3e-496c-a098-206500981354","_postman_id":"cf04eacf-0e3e-496c-a098-206500981354","description":""},{"name":"Sequence","item":[{"name":"Message assigned to Sequence","id":"0829957e-e105-4124-86c0-324e2013a0bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile_number\": \"9876543210\",\n \"country_code\": \"91\",\n \"f_name\": \"John\",\n \"l_name\": \"Doe\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/campaign_sequence/sequences/trigger_sequence/867891dfbded489dae23a2c7524ef6ab","description":"This API triggers a WhatsApp messaging sequence for a specific contact.
The {sequence_id} in the URL should be replaced with the actual ID of the sequence you’ve created in the Gainwix platform. This API request is used to trigger a predefined WhatsApp sequence for a contact using the Developer API. The request requires the recipient’s contact details and any additional attributes configured in the sequence setup.
Required parameters:
\nmobile_number: The recipient’s mobile number (without the country code).
country_code: The recipient’s country calling code (e.g., \"91\" for India).
Optional parameters (used as contact attributes and saved in CRM):
\nf_name: First name of the contact.
l_name: Last name of the contact.
Other custom fields defined during sequence configuration.
\nPath parameter:
\nsequence_id: Unique identifier of the sequence to be triggered. This ID is part of the URL and can be found in the sequence API Trigger.Once triggered, the contact enters the configured sequence flow, and WhatsApp messages (using Meta-approved templates) will be sent according to the steps defined in the sequence.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","campaign_sequence","sequences","trigger_sequence","867891dfbded489dae23a2c7524ef6ab"],"host":["v1","api","gainwix","app"],"query":[],"variable":[]}},"response":[{"id":"1459f2ab-02b7-441f-afde-2d8043ec5297","name":"Message assigned to Sequence","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile_number\": \"9876543210\",\n \"country_code\": \"91\",\n \"f_name\": \"John\",\n \"l_name\": \"Doe\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://v1.api.gainwix.app/api/v1/svc/campaign_sequence/sequences/trigger_sequence/867891dfbded489dae23a2c7524ef6ab"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"6abc51d8561dcc0408223a9b9921eca1\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"804921a3-8380-4eeb-93ee-9b274cd094e2"},{"key":"x-runtime","value":"2.183384"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, sql.active_record;dur=1923.31, instantiation.active_record;dur=9.45, transaction.active_record;dur=1188.05, process_action.action_controller;dur=2156.59"},{"key":"Content-Length","value":"64"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Sequence triggered successfully\"\n}"}],"_postman_id":"0829957e-e105-4124-86c0-324e2013a0bb"}],"id":"0ff06327-5748-403d-95bb-56eef92cb100","_postman_id":"0ff06327-5748-403d-95bb-56eef92cb100","description":""},{"name":"User Login","id":"b5860084-742c-4f9f-ad2d-dfac5f85ea93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"}],"url":"https://v1.api.gainwix.app/api/v1/svc/aaa/authentication/login?email=user@website.com&password=password","description":"This API is used for user authentication in the GainWix service. It allows users to log in by providing their email and password. Upon successful authentication, the API returns an access token details required for further API interactions.
\n","urlObject":{"protocol":"https","path":["api","v1","svc","aaa","authentication","login"],"host":["v1","api","gainwix","app"],"query":[{"key":"email","value":"user@website.com"},{"key":"password","value":"password"}],"variable":[]}},"response":[{"id":"994b33ba-cf9d-4a62-8097-5dab8cf2019d","name":"User Login","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"}],"url":{"raw":"https://v1.api.gainwix.app/api/v1/svc/aaa/authentication/login?email=example@gmail.com&password=12345","protocol":"https","host":["v1","api","gainwix","app"],"path":["api","v1","svc","aaa","authentication","login"],"query":[{"key":"email","value":"example@gmail.com"},{"key":"password","value":"12345"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"etag","value":"W/\"32227c3a30a852868cbc09d68bfda095\""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"cd954343-2a69-4f9c-a9c5-aef6ae35e681"},{"key":"x-runtime","value":"0.387714"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.02, sql.active_record;dur=44.33, instantiation.active_record;dur=10.70, transaction.active_record;dur=22.79, process_action.action_controller;dur=372.55"},{"key":"Content-Length","value":"339"},{"key":"Date","value":"Tue, 25 Mar 2025 12:37:27 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"auth_token\": \"eyJhbGciOiJIUzI1NiJ9.eyJzZXNzaW9uX2tleSI6ImZ6L1dYWlljUDNzNXNQeWltT0hIenVvek5LanhXaG9kVUcxMVYwbWI5ZkVyd2s4QzVxdlk5eHovZWFBbU80T09JOWtFSTVjNnZYZGw2R1ozIiwiZXhwaXJlc19hdCI6IjIwMjUtMDQtMDQgMTI6Mzc6MjcgVVRDIn0.oaEVOlwFANMtsqT3S8Fkmj93HF98Q\",\n \"email_verified\": true,\n \"message\": \"Login Successfully\",\n \"account_count\": true\n}"}],"_postman_id":"b5860084-742c-4f9f-ad2d-dfac5f85ea93"},{"name":"Campaign Leads","id":"898ab699-14d4-412f-8cbb-4ee7af889f13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"url":"https://v1.api.gainwix.app/api/v1/campaigns/leads?brand_id=c5352e42f18044dca02eba9ac0b4bc16&campaign_name=Holiday Promo","description":"This API retrieves leads associated with a specific campaign, with optional filtering capabilities. It's designed to provide paginated results with detailed lead information including contact details and campaign engagement data.
\n(string): Name of the campaign (required)
\n(string): Id of the Brand(required)
\n(string): Filter leads by broadcast name
\n(string): Filter leads by sequence name
\n(datetime): Start time in ISO 8601 UTC format (e.g., 2024-06-25T13:28:16Z)
\n(datetime): End time in ISO 8601 UTC format (defaults to current time if start_time is provided)
\n(integer): Page number (default: 1)
\n(integer): Records per page (default: 20, max: 100)
\nstart_time is provided: Returns leads from start_time to current time
\nstart_time and end_time are provided: Returns leads between the specified range
\nIf no time filters: Returns all leads for the campaign
\nReturns paginated list of leads with contact information and campaign details
\nIncludes pagination metadata (current page, total pages, total count)
\nName of the campaign
\n","type":"text/plain"},"key":"campaign_name","value":"Holiday Promo"},{"disabled":true,"description":{"content":"Filter by broadcast name
\n","type":"text/plain"},"key":"broadcast_name","value":"Webinar Invite"},{"disabled":true,"description":{"content":"Filter by broadcast name
\n","type":"text/plain"},"key":"sequence_name","value":"Follow-Up Sequence A"},{"disabled":true,"description":{"content":"Start time for filtering leads (e.g., 2024-06-25T13:16:43Z)
\n","type":"text/plain"},"key":"start_time","value":"2025-06-01T00:00:00Z"},{"disabled":true,"description":{"content":"Start time for filtering leads (e.g., 2024-06-25T13:16:43Z)
\n","type":"text/plain"},"key":"end_time","value":"2025-06-25T23:59:59Z"},{"disabled":true,"description":{"content":"Page number (default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Records per page (default: 20, max: 100)
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"0cfc4bb4-d2c2-4b6d-b916-6dda0b82f559","name":"Campaign Leads","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"xxx-xxx-xxx","type":"text"},{"key":"Authorization","value":"xxx-xxx-xxx","type":"text"}],"url":{"raw":"https://v1.api.gainwix.app/api/v1/campaigns/leads?brand_id=c5352e42f18044dca02eba9ac0b4bc16&campaign_name=Holiday Promo","protocol":"https","host":["v1","api","gainwix","app"],"path":["api","v1","campaigns","leads"],"query":[{"key":"brand_id","value":"c5352e42f18044dca02eba9ac0b4bc16"},{"key":"campaign_name","value":"Holiday Promo","description":"Name of the campaign"},{"key":"broadcast_name","value":"Webinar Invite","description":"Filter by broadcast name","disabled":true},{"key":"sequence_name","value":"Follow-Up Sequence A","description":"Filter by broadcast name","disabled":true},{"key":"start_time","value":"2025-06-01T00:00:00Z","description":"Start time for filtering leads (e.g., 2024-06-25T13:16:43Z)","disabled":true},{"key":"end_time","value":"2025-06-25T23:59:59Z","description":"Start time for filtering leads (e.g., 2024-06-25T13:16:43Z)","disabled":true},{"key":"page","value":"1","description":"Page number (default: 1)","disabled":true},{"key":"limit","value":"20","description":"Records per page (default: 20, max: 100)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"Accept, Origin"},{"key":"cache-control","value":"no-cache"},{"key":"x-request-id","value":"560c2ca7-e2ee-4c4f-94d5-cc70049a6a4f"},{"key":"x-runtime","value":"0.009021"},{"key":"Content-Length","value":"41"},{"key":"Date","value":"Wed, 25 Jun 2025 07:50:54 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"leads\": [\n {\n \"id\": \"1\",\n \"name\": \"John Doe\",\n \"phone_country_code\": \"91\",\n \"phone_number\": \"9876543210\",\n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"San Francisco\",\n \"campaign_name\": \"Summer2024\",\n \"sequence_name\": \"Follow-up Sequence\",\n \"created_at\": \"2024-06-20T14:30:00Z\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Jane Smith\",\n \"phone_country_code\": \"44\",\n \"phone_number\": \"7700123456\",\n \"country\": \"United Kingdom\",\n \"state\": \"England\",\n \"city\": \"London\",\n \"campaign_name\": \"HolidayPromo2024\",\n \"broadcast_name\": \"Re-engagement Series\",\n \"created_at\": \"2024-06-22T09:15:00Z\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"total_pages\": 5,\n \"total_count\": 42,\n \"per_page\": 10\n }\n }\n}"}],"_postman_id":"898ab699-14d4-412f-8cbb-4ee7af889f13"}]}