SENDIX is a smart platform designed for managing WhatsApp campaigns, facilitating the distribution of messages, publications, ads, surveys, and promotions to a large number of contacts in an efficient and targeted manner. In today's competitive environment, organizations must adopt innovative marketing methods to convey important messages to customers and the public easily and effectively.
\nTo empower organizations in managing relationships and communication with customers, Consist developed SENDIX—a smart platform for campaign management on the WhatsApp channel. SENDIX enables you to send various types of messages, including publications, ads, surveys, invitations, reminders for events, and information about new products and services. It leverages the most popular messaging platform today—WhatsApp.
\nAPI base url: https://api.sendix.io
\nAll requests returning a header named \"TraceId\" should contain the internal request ID in Sendix. We recommend logging the TraceId in your client for future investigation in case of errors.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21971446","collectionId":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","publishedId":"2sAYJAfdyS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-08T16:01:27.000Z"},"item":[{"name":"Token","item":[{"name":"/ex/Token","event":[{"listen":"test","script":{"id":"f8fd07f5-b8e8-4c4c-8a92-d866a2721fa9","exec":["var token = pm.response.json().AccessToken;\r","pm.environment.set(\"token\",token)"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"231032cf-fcf5-4d1b-9a51-739578157a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"Username\": \"{{username}}\",\n \"Password\": \"{{password}}\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/Token","description":"Get the Bearer token for Sendix API
\nGet authorization token for Sendix API. Company and user must have permission for using API
you can use /ex/token method or use OAuth2 to get the token:
OAuth2 parameters:
URL: https://sendix.io/auth/realms/{company-name}/protocol/openid-connect/token
Grant type: client_credentials
\nClient ID: sendixOAuth2
\nClient Secret: [your client secret]
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8f0ddeef-0336-41da-9bbc-491a3928de09","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bafc439-f115-4398-b1b1-ffc9ce6582ff","type":"text/javascript","exec":[""]}}],"_postman_id":"63f08e1e-71f0-42a7-9d4b-00a2f9df1c1f"},{"name":"Department","item":[{"name":"/ex/Department","id":"d751f959-9798-4913-8a16-7645e6486237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":"//ex/Department","description":"Get list of departments name and IDs
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Department"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"6e7c14a8-4daa-4e2f-bd7a-fd01c815bca8","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet information about a specific campaign within a department
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Campaign",":departmentId",":campaignId"],"host":["/"],"query":[],"variable":[{"id":"90fb211c-b92b-4068-a549-2a0f1fd531bf","description":{"content":"(Required) The unique ID of the department that owns the campaign. Use GET /ex/Department to get the id
\n","type":"text/plain"},"type":"any","value":"08db9891-fb9a-410c-85c8-37698cebf9f3","key":"departmentId"},{"id":"c033689c-2249-4650-b1cd-3e06657211ca","description":{"content":"(Required) Campaign's serial number
\n","type":"text/plain"},"type":"any","value":"15","key":"campaignId"}]}},"response":[{"id":"bf69160d-6868-4ab8-a7b0-048abbd16e4c","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAdd more recipients to pending campign (Max request size 50 MB)
\n(Required) The unique ID of the department that owns the campaign. Use GET /ex/Department to get the id
\n","type":"text/plain"},"type":"any","value":"08db9891-fb9a-410c-85c8-37698cebf9f3","key":"departmentId"},{"id":"33bce7a3-a9ed-4f67-ae58-f53036da013d","description":{"content":"(Required) Campaign's serial number
\n","type":"text/plain"},"type":"any","value":"15","key":"campaignId"}]}},"response":[{"id":"8fc136e2-decb-42b1-afe3-eebd402fc9cf","name":"Success","originalRequest":{"method":"PUT","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAdd a new campaign to the specified department
\n(Required) The unique ID of the department for which the campaign is created. Use GET /ex/Department to get the id
\n","type":"text/plain"},"type":"any","value":"08db9891-fb9a-410c-85c8-37698cebf9f3","key":"departmentId"}]}},"response":[{"id":"1e759fc5-c386-4581-a92e-580be337d3a2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-Tenant","value":"","description":"(Required) Header to define company's realm"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"Bearer(Required) Header to define company's realm
\n"}],"url":"//ex/Campaign/DataObfuscation/:campaignId","description":"Encrypts the campaign's details in its final status.The following details will be encrypted: phone numbers, parameters.This method is asynchronous. To get the final ststus of the process, call the DataObfuscationStatus method or subscribe to the campaign status changed webhook message.
\n(Required)
\n","type":"text/plain"},"type":"any","value":"(Required) Header to define company's realm
\n"},{"key":"Accept","value":"text/plain"}],"url":"//ex/Campaign/DataObfuscationStatus/:campaignId","description":"Gets the status of campaign data obfuscation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Campaign","DataObfuscationStatus",":campaignId"],"host":["/"],"query":[],"variable":[{"id":"2f9ea5cb-4273-4b1a-8828-50326444661c","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required) Header to define company's realm
\n"},{"key":"Accept","value":"text/plain"}],"url":"//ex/Campaign/CampaignDetails/:campaignId/:pageNumber","description":"Retrieves detailed information about the recipients of a campaign.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Campaign","CampaignDetails",":campaignId",":pageNumber"],"host":["/"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Get a specific contact by its ID
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Contact",":contactId"],"host":["/"],"query":[],"variable":[{"id":"ef9f6576-dd88-4761-97df-1d603fed311b","description":{"content":"(Required) The unique ID of the contact to retrieve
\n","type":"text/plain"},"type":"any","value":"08dbf739-2545-4ae3-8f20-510bf558d270","key":"contactId"}]}},"response":[{"id":"68027c00-75a7-4094-84fd-1ffcef24e05a","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate an existing contact
\n(Required) The unique ID of the contact to update
\n","type":"text/plain"},"type":"any","value":"08dbf739-2545-4ae3-8f20-510bf558d270","key":"contactId"}]}},"response":[{"id":"8856537d-f882-46de-89a5-3eb9962546e6","name":"Success","originalRequest":{"method":"PUT","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerDelete a contact by its ID
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Contact",":contactId"],"host":["/"],"query":[],"variable":[{"id":"ca91ad9f-ed7a-445e-bb73-ddcd78d25165","description":{"content":"(Required) The unique ID of the contact to delete
\n","type":"text/plain"},"type":"any","value":"08dbf739-2545-4ae3-8f20-510bf558d270","key":"contactId"}]}},"response":[{"id":"bd6fb0d9-1a17-45a4-b96b-73810d41dde8","name":"Success","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet all contacts
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Contact"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"989ff56b-1df1-42ed-9584-4a4430ccef3b","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAdd a new contact
\nGet a specific group by its ID
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Group",":groupId"],"host":["/"],"query":[],"variable":[{"id":"bef774de-f09d-4ced-a35c-e8ff732494e1","description":{"content":"(Required) The unique ID of the group to retrieve
\n","type":"text/plain"},"type":"any","value":"08dba17b-9c21-4a75-85bf-77bbc389937f","key":"groupId"}]}},"response":[{"id":"5e26fae2-1022-4253-80a1-cd6e68d4d8ac","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Header to define company's realm
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"DepartmentId\": \"08db9892-321e-437a-8ffc-aec5867b2097\",\n \"Name\": \"d1-group\",\n \"Contacts\": [\n \"08dba170-ac56-4a9f-8e40-b3d86d7d3879\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/Group/:groupId","description":"Update an existing group
\n(Required) The unique ID of the group to update
\n","type":"text/plain"},"type":"any","value":"dfDAEbb7-112c-DcCF-0234-C9dd6D0CA2CF","key":"groupId"}]}},"response":[{"id":"6c38bbf9-9469-49c6-a15e-4b2f90d6a9c9","name":"Success","originalRequest":{"method":"PUT","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerDelete a group by its ID
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Group",":groupId"],"host":["/"],"query":[],"variable":[{"id":"6109fe3f-d4e9-4cdc-b776-337491da82e8","description":{"content":"(Required) The unique ID of the group to delete
\n","type":"text/plain"},"type":"any","value":"dfDAEbb7-112c-DcCF-0234-C9dd6D0CA2CF","key":"groupId"}]}},"response":[{"id":"a561eca4-3912-4182-acf4-e6f74ac47c43","name":"Success","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet all department groups
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Group"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"9e7749f1-925e-42b1-9eb2-914dade60fcd","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Header to define company's realm
\n","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"my group name\",\n \"DepartmentId\": \"e6466a3A-54fa-7F3d-af59-f6A72bD7dBfc\",\n \"Contacts\": [\n \"08dbf739-2545-4ae3-8f20-510bf558d270\",\n \"67sdf739-2545-4ae3-8f20-550bf558d450\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/Group","description":"Add a new group
\nGet the list of unsubscribed phone numbers
\nAdd phone numbers to the list of unsubsctibed
\nResponse:
\nUnsubscriptionResults:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Unsubscription"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"65d5e34b-10d5-4a94-bf41-2bce3c7f0cb2","name":"Success","originalRequest":{"method":"POST","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRemove phone numbers from the list of unsubsctibed
\nPhoneNumber - with country code start with + sign (Example: +97252957886)
\nResponse:
\nRequestId - Unique Request Id (GUID)
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","id":"f0f2f5a2-f213-4ee9-9098-c0576c624dcc","name":"Sendix API V1.6 (Latest)","type":"collection"}},"urlObject":{"path":["ex","Unsubscription"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"118b387e-2c91-496a-b943-5a6741b92ad4","name":"Success","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Header to define company's realm","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Header to define company's realm
\n","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CampaignId\": 85,\n \"MessageId\": \"e37a28df-6e3d-460d-9eed-0af5d0ec0f3b\",\n \"PhoneNumber\": \"+97250623996\",\n \"Status\": \"Created,Sent,Cancelled,Submitted,Delivered,Read,Rejected,Undeliverable,Error,Unsubscribed,Accepted\",\n \"Text\": \"Hello Daviv, This is a sample message\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"Your https address","description":"Receive message status changed webhook message
\n(Required) Header to define company's realm
\n","key":"X-Tenant","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CampaignId\": 78,\n \"Status\": \"Created,Pending,Starting,Running,Stopped,Successful,Failed\",\n \"CustomParameters\": [\n {\n \"Key\": \"myCRMCampaignId\",\n \"Value\": \"12345\"\n },\n {\n \"Key\": \"AnyParameterFromAPICall\",\n \"Value\": \"some value\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"Your https address","description":"Receive campaign status changed webhook message
\nSendix API provides Webhooks for campaign status change events and campaign message status change events. All methods registered as webhook endpoints must return a response within a maximum of 1 second. If the method returns a response after more than 1 second, we will record the call as a timeout response.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c8bc7a45-5139-4920-9496-d12ce10b139f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"abb88196-795e-44ed-8543-eb917ddf8827","type":"text/javascript","exec":[""]}}],"_postman_id":"debc9cae-8b0d-4faa-b279-154726ebcfc4"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"16288c17-e2b0-42d9-a7ab-1e8792bcc782","type":"text/javascript","requests":{},"exec":["var Header = require('postman-collection').Header","pm.request.headers.add(new Header(\"X-Tenant: \" + pm.variables.get('company')))"]}},{"listen":"test","script":{"id":"65ab1224-f27f-4788-a567-970c25346066","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"/"},{"key":"company","value":""}]}