Welcome to the HeltarChat API collection. HeltarChat is a powerful platform that integrates WhatsApp Business functionalities, revolutionising the CRM landscape. It nurtures client relationships and offers a unique app store that developers can monetise. Now, with our public APIs, developers can have direct access to our robust functionalities and integrate them into their own platforms.
\nOur API requests use the HeltarChat Environment variables, which consists of 3 variables:
\nclientWaNumber: This is the WhatsApp number you are performing the API actions on, such as sending messages, fetching client details, etc. This can also be modified directly in the URL.templateName: This variable is used to fetch the respective template.apiKey: This is your API key that can be obtained from your HeltarChat account accessible through app.heltar.com (Navigate to Settings/API Key).Please note that the clientWaNumber variable should be concatenated with your country code. This is crucial for the API's functioning.
To work with these APIs, add the HeltarChat Environment to your Postman environments, and replace the variable placeholders with your respective data. Here's a brief description of how you can do that:
\nclientWaNumber, templateName, and apiKey. Set their respective values as per your requirements.Now, you're all set to start exploring the HeltarChat APIs!
\nWe are excited to see the innovative applications you will develop using HeltarChat APIs. Happy coding!
\nPlease ensure that the clientWaNumber **used throughout the documentation is concatenated with your country code. The proper functioning of the API calls depends on this.
DONT USE ANY PLUS SIGN BEFORE NUMBER!!!!**
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21364364","collectionId":"342b7661-de04-43a5-8c3c-8168e4083e63","publishedId":"2s93zCYL9G","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-07-02T18:26:09.000Z"},"item":[{"name":"Business","item":[{"name":"Add Webhook Url","id":"01c154a9-5192-401d-abde-b921134e2a1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"urls\": [\n {\n \"url\": \"http://localhost:8000\",\n \"isEnabled\": true\n },\n {\n \"url\": \"http://localhost:8001\",\n \"isEnabled\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/business/webhook-url","description":"This API allows you to add a new webhook URL to the list of webhook URLs of your business. It will update the URL if already there in the list (You can enable or disable subscribing to the webhook), adds new if not in the list.
\nRequest Body Schema Details
\ntrue, HeltarChat will send updates to this URL.Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/business/webhook-url?url=http://localhost:8000","description":"This API allows you to remove a webhook URL from your business's list of webhook URLs.
\nParams Schema Details
\nThe url to be deleted from business webhook url list.
\n","type":"text/plain"},"key":"url","value":"http://localhost:8000"}],"variable":[]}},"response":[{"id":"7e793433-fbba-4f61-946c-0544c2574685","name":"Delete Webhook Url","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"url":{"raw":"https://api.heltar.com/v1/business/webhook-url?url=http://localhost:8000","protocol":"https","host":["api","heltar","com"],"path":["v1","business","webhook-url"],"query":[{"key":"url","value":"http://localhost:8000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"105"},{"key":"ETag","value":"W/\"69-kCvkJ22JFfAGENcth/kahFkXB4o\""},{"key":"Date","value":"Sun, 02 Jul 2023 11:10:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully deleted webhook URL\",\n \"data\": [\n {\n \"url\": \"http://localhost:8001\",\n \"isEnabled\": false\n }\n ]\n}"}],"_postman_id":"751f206b-6c73-4457-a052-e5d297832d59"},{"name":"Fetch Business Employees","id":"28501d24-20d8-466d-bf89-5345407ecd28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/auth/business-employees","urlObject":{"protocol":"https","path":["v1","auth","business-employees"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"28501d24-20d8-466d-bf89-5345407ecd28"}],"id":"68992a6f-b79d-4c5d-8f67-fb9629db584d","description":"The Business folder in the HeltarChat API collection allows businesses to manage their Webhook URLs.
\nWebhooks are a method of augmenting or altering the behaviour of a web page or web application with custom callbacks. These callbacks may be maintained, modified, and managed by third-party users and developers. They can be used for numerous applications such as data validation, form submission and more.
\nIn the context of HeltarChat, when events occur on WhatsApp (like messages, status updates etc.), WhatsApp sends these event notifications to HeltarChat. If you want to receive these events on your own server, you can add your server's webhook URL using these APIs. This allows you to get real-time updates and perform actions as needed.
\n","_postman_id":"68992a6f-b79d-4c5d-8f67-fb9629db584d"},{"name":"Campaign","item":[{"name":"List of Campaigns","id":"75821457-6b69-4f4d-8411-1a9dc3e09e82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/campaigns","description":"This API provides a list of all the campaigns that a business has conducted.
\n","urlObject":{"protocol":"https","path":["v1","campaigns"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75821457-6b69-4f4d-8411-1a9dc3e09e82"},{"name":"Send Bulk Campaign","id":"de38c16b-ff0f-4c26-aa76-070bdaef3796","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"campaignName\": \"Student Details\",\n \"campaignDesc\": \"... your description\",\n \"templateName\": \"hello_world\",\n \"languageCode\": \"en_US\",\n \"templateContent\": \"Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform’s Cloud API. Thank you for taking the time to test with us.\",\n \"messages\": [\n {\n \"clientWaNumber\": \"918005756750\",\n \"variables\": []\n },\n {\n \"clientWaNumber\": \"917764800143\",\n \"variables\": []\n }\n ]\n}"},"url":"https://api.heltar.com/v1/campaigns/send","description":"This API enables you to create and broadcast a campaign to multiple clients.
\nRequest Body Schema Details
\ncampaignName: The name of your campaign.campaignDesc: A description of your campaign.templateName: The name of the template used in the campaign.languageCode: The language code for the template's content.templateContent: The content of the message.messages: An array of message objects, each containing a clientWaNumber and variables for the message.The Campaigns folder in the HeltarChat API collection offers businesses the capability to conduct extensive bulk messaging campaigns via WhatsApp. As a powerful tool for reaching out to a vast audience concurrently, WhatsApp campaigns can significantly enhance your business's reach, engagement, and overall marketing effectiveness.
\nBroadcasting campaigns allows businesses to disseminate crucial information, promotional offers, or updates to their client base quickly and efficiently. This is particularly beneficial when:
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/clients","description":"This API fetches details of all the client of your business and returns an array.
\n","urlObject":{"protocol":"https","path":["v1","clients"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[{"id":"e897f419-f049-45f5-a814-25d4629ce41c","name":"Fetch Client List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"url":"https://api.heltar.com/v1/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"e92-RTRE/edTJicP4JJse+40JpgFjOE\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Sun, 02 Jul 2023 11:54:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully retrieved client list\",\n \"data\": [\n {\n \"id\": \"1f38a3f9-1a76-4e37-86cc-4e0ca70ef51f\",\n \"username\": \"Prashant Jangid\",\n \"attributes\": \"{\\\"age\\\":\\\"29\\\",\\\"gender\\\":\\\"male\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-02T18:38:48.000Z\",\n \"latestMessageTimestamp\": \"2023-07-01T18:38:48.000Z\",\n \"latestMessage\": {\n \"text\": \"HELLO\",\n \"type\": \"text\",\n \"timestamp\": \"2023-07-01T18:38:48.000Z\",\n \"historyText\": \"HELLO\"\n },\n \"countryCode\": 91,\n \"clientWaNumber\": \"918005756750\",\n \"createdAt\": \"2023-07-01T15:06:21.423Z\"\n },\n {\n \"id\": \"5ca9c287-35b9-4b85-9450-8f13a5eacf5f\",\n \"username\": \"Vikesh ❤️\",\n \"attributes\": \"{\\\"Custom Column 1\\\":\\\"4545\\\",\\\"Custom Column 2\\\":\\\"o7t667\\\",\\\"Custom Column 3\\\":\\\"ju7676\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-01T15:07:15.364Z\",\n \"latestMessageTimestamp\": \"2023-07-01T15:07:15.364Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"917764800143\",\n \"createdAt\": \"2023-07-01T15:07:15.367Z\"\n },\n {\n \"id\": \"d5f856da-6adc-4ab6-80e2-f7db14eeebb4\",\n \"username\": \"Deepak\",\n \"attributes\": \"{\\\"Custom Column 1\\\":\\\"5079\\\",\\\"Custom Column 2\\\":\\\"09ja61\\\",\\\"Custom Column 3\\\":\\\"js5079\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": false,\n \"conversationExpire\": \"2023-07-01T15:07:15.362Z\",\n \"latestMessageTimestamp\": \"2023-07-01T15:07:15.362Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"918989766767\",\n \"createdAt\": \"2023-07-01T15:07:15.366Z\"\n },\n {\n \"id\": \"cd02dfae-cb45-4839-b20f-b5d6797f5eb2\",\n \"username\": \"Mohan\",\n \"attributes\": \"{\\\"Custom Column 1\\\":\\\"4081\\\",\\\"Custom Column 2\\\":\\\"30no86\\\",\\\"Custom Column 3\\\":\\\"cj4081\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-01T15:07:15.361Z\",\n \"latestMessageTimestamp\": \"2023-07-01T15:07:15.361Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"912323223223\",\n \"createdAt\": \"2023-07-01T15:07:15.364Z\"\n },\n {\n \"id\": \"18c8a32d-de7f-40b7-ac0c-310533ef52b6\",\n \"username\": \"Shyam\",\n \"attributes\": \"{\\\"Custom Column 1\\\":\\\"2070\\\",\\\"Custom Column 2\\\":\\\"04ap67\\\",\\\"Custom Column 3\\\":\\\"lg2070\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-01T15:07:15.360Z\",\n \"latestMessageTimestamp\": \"2023-07-01T15:07:15.360Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"912323244422\",\n \"createdAt\": \"2023-07-01T15:07:15.362Z\"\n },\n {\n \"id\": \"6dc82bd5-fcf5-4df5-9e9f-b96dc2119877\",\n \"username\": \"Ram\",\n \"attributes\": \"{\\\"Custom Column 1\\\":\\\"9012\\\",\\\"Custom Column 2\\\":\\\"12se74\\\",\\\"Custom Column 3\\\":\\\"rb9012\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-01T15:07:15.358Z\",\n \"latestMessageTimestamp\": \"2023-07-01T15:07:15.358Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"917764993992\",\n \"createdAt\": \"2023-07-01T15:07:15.361Z\"\n },\n {\n \"id\": \"07717d9a-70db-48cb-adc9-810bfd64d8ff\",\n \"username\": \"Sohan\",\n \"attributes\": \"{\\\"Custom Column 1\\\":\\\"9346\\\",\\\"Custom Column 2\\\":\\\"14ju73\\\",\\\"Custom Column 3\\\":\\\"mj9346\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-01T15:07:15.356Z\",\n \"latestMessageTimestamp\": \"2023-07-01T15:07:15.356Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"912456465444\",\n \"createdAt\": \"2023-07-01T15:07:15.360Z\"\n },\n {\n \"id\": \"dd72bace-d8d3-454d-9188-0969af108a82\",\n \"username\": \"johnDoe\",\n \"attributes\": \"{\\\"age\\\":30,\\\"gender\\\":\\\"male\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": true,\n \"conversationExpire\": \"2023-07-01T14:52:27.090Z\",\n \"latestMessageTimestamp\": \"2023-07-01T14:52:27.090Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"911234567890\",\n \"createdAt\": \"2023-07-01T14:52:27.091Z\"\n },\n {\n \"id\": \"24f8d040-9700-4547-8f3d-abbf4618f7cd\",\n \"username\": \"janeSmith\",\n \"attributes\": \"{\\\"age\\\":25,\\\"gender\\\":\\\"female\\\"}\",\n \"unreadMessages\": 0,\n \"isOpen\": false,\n \"conversationExpire\": \"2023-07-01T14:52:27.089Z\",\n \"latestMessageTimestamp\": \"2023-07-01T14:52:27.089Z\",\n \"latestMessage\": null,\n \"countryCode\": 91,\n \"clientWaNumber\": \"919876543210\",\n \"createdAt\": \"2023-07-01T14:52:27.091Z\"\n }\n ]\n}"}],"_postman_id":"48beb436-94cb-46d7-8c3b-60cbc386734e"},{"name":"Create/Update Client","id":"3f203e5f-b262-4854-9c00-76d2e32c0b3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"username\": \"Ram Jain\",\n \"attributes\": \"{\\\"age\\\": 50, \\\"gender\\\": \\\"male\\\"}\",\n \"countryCode\": 91,\n \"clientWaNumber\": \"919998889990\"\n }\n]"},"url":"https://api.heltar.com/v1/clients","description":"This API allows you to add new clients to your business or update existing ones. By 'update', we refer to changing the attributes or username of a client, as the clientWaNumber remains fixed for a specific client associated with your business.
The unique aspect of this API is that it facilitates both creation and update operations concurrently. You may have multiple clients in the request body; some might be new (to be created), and others might already exist (to be updated). The API will intelligently handle these operations together.
\nNote: Uniqueness is identified by the clientWaNumber that decides where a record is to be created or updated.
Request Body Schema Details:
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/clients/{{clientWaNumber}}","description":"This API fetches details of a particular client whose clientWaNumber is passed in the parameters and returns the object with details.
Request Parameter Schema Details
\nclientWaNumber: contact number of the client to be fetched (countryCodeconcatenated)Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"isOpen\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/clients/chat/toggle/{{clientWaNumber}}","description":"One of the key features of the HeltarChat platform is giving businesses the control to manage their chats. An open chat allows for active communication with the client, while a closed chat indicates that the conversation is currently not active.
\nThis API enables you to change the isOpen flag of the chat of the client. If you don't want a particular client to be in your Open Chats then you can turn it off.
Request Body Schema Details
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientWaNumber\": \"917764800143\",\n \"email\": \"executive1@heltar.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/clients/chat/assign","description":"This API will assign the business employee email to that lead.
\nYou can fetch the list of all business employees from Fetch Business Employees API in Business Section
\nThe assigning logic has to be handled by the developers using the API to assign chats. Here is an example format how you can do it in typescript.
interface Employee {\n id: number;\n name: string;\n email: string;\n // other fields...\n}\nclass RoundRobinAssigner {\n private employees: Employee[];\n private lastIndex: number;\n\nconstructor(employees: Employee[]) {\n this.employees = employees;\n this.lastIndex = -1;\n}\nassignToNextChat(): Employee {\n if (this.employees.length === 0) {\n throw new Error(\"No employees available for assignment.\");\n }\n this.lastIndex = (this.lastIndex + 1) % this.employees.length;\n return this.employees[this.lastIndex];\n}\n}\n// Example usage\nconst employees: Employee[] = [\n // ... list of employees ...\n];\nconst assigner = new RoundRobinAssigner(employees);\n// Assign an employee to a chat\nconst assignedEmployee = assigner.assignToNextChat();\nconsole.log(\"Assigned Employee:\", assignedEmployee);\n\n\nThe Clients folder in the HeltarChat API collection empowers businesses to seamlessly manage their client base. As a business, you can leverage this sophisticated feature to streamline client operations, maintain up-to-date client data, and enrich your CRM practices.
\nUtilizing the 'Clients' section, you can easily add, update, and manage your clients. When performing client operations, two fields are essential: countryCode and clientWaNumber (WhatsApp Number).
Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/templates","description":"This API provides a list of all the templates and related information about it that you have in your business account. This is helpful to see all the pre-approved templates at your disposal for sending notifications to your clients.
\n","urlObject":{"protocol":"https","path":["v1","templates"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[{"id":"033bfff4-c63e-45d0-9448-b81d435d1c0d","name":"Fetch Template List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"url":"https://api.heltar.com/v1/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"360"},{"key":"ETag","value":"W/\"168-XImai4ySSRcjQii1LiD9t7cMmS8\""},{"key":"Date","value":"Sun, 02 Jul 2023 15:07:26 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully retrieved 1 templates!\",\n \"data\": [\n {\n \"name\": \"hello_world\",\n \"content\": \"Hello World\\nWelcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform’s Cloud API. Thank you for taking the time to test with us.\\nWhatsApp Business API Team\",\n \"numVariables\": 0,\n \"numButtons\": 0\n }\n ]\n}"}],"_postman_id":"b1264566-e13a-4f5d-a89e-9579a472fab2"},{"name":"Fetch Template Details","id":"885a178f-c3b0-4971-8970-ec2aca765d2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/templates/{{templateName}}","description":"This API enables you to fetch details of a specific template using its unique templateName.
Request Params Schema Details
\ntemplateNameThe unique template name whose details needs to be fetched.The Templates folder in the HeltarChat API collection is where businesses can manage their WhatsApp Business Messaging Templates.
\nWhatsApp Business Messaging Templates are specific message formats that businesses can use to send notifications to their clients. They are designed to standardize the messages that businesses send to customers and need to be approved by Meta (formerly Facebook) before use. Templates can include text, images, documents, or a combination thereof. They allow businesses to create structured messages for common use cases, such as appointment reminders, shipping notifications, or customer support.
\n","_postman_id":"6c85638b-a7dd-4c6a-82ff-c43b5663c249"},{"name":"Messages","item":[{"name":"Fetch Messages","id":"f41eb849-c095-4a3f-8b4d-7ceebf6d2ff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.heltar.com/v1/messages/{{clientWaNumber}}","description":"This will fetch all the messages of a particular client.
\n","urlObject":{"protocol":"https","path":["v1","messages","{{clientWaNumber}}"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f41eb849-c095-4a3f-8b4d-7ceebf6d2ff4"},{"name":"Text Message","id":"4e050396-9b56-4b5d-a0f5-43edd63b4826","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"918005756750\",\n \"message\": \"My Name is Heltar.\",\n \"messageType\": \"text\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"Text messages allow you to send plain textual information to your clients. These messages can be sent when the chat is active, providing a quick and easy way to communicate simple information or responses.
\nThese are free form messages that are only activated after the conversation is initiated and the customer has replied to you (24hrs from initiation)
\nSending Normal Test Message
\nThese 3 fields are mandatory for any kind of message you want to send
\nclientWaNumber: This is the WhatsApp number of the client to whom the message will be sent.message: This is the text content of the message.messageType: This defines the type of the message. In this case, it is a \"text\" message.Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"918005756750\",\n \"message\": \"My Name is Heltar.\",\n \"messageType\": \"text\",\n \"contextId\": \"4016ce29-2b58-42d7-bd8c-9eb6f79b4eb5\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"In an active conversation, you can reply to a specific message by providing an extra key in the request: contextId. This key takes in the id (not wamid) of the message you're replying to. For instance: { \"contextId\": \"4016ce29-2b58-42d7-bd8c-9eb6f79b4eb5\"}
Note: This will be a free form message!
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"89613918-ef06-4f98-854a-860a3744f50d"},{"name":"Generate Presigned URL Media Upload","id":"b9c47e05-64cb-4281-9792-afd2cbf20a19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.heltar.com/v1/messages/presigned-url?file_name=file.png&file_type=image/png","description":"This section guides you through the process of generating a presigned URL for file upload and subsequently uploading the file to an Amazon S3 bucket using the Heltar API and a custom uploadFileToS3 function in JavaScript.
The Heltar API allows for the secure and efficient uploading of files to an S3 bucket by generating a presigned URL. This URL is then used to upload the file directly to S3 from the client's browser.
\nGET https://api.heltar.com/v1/messages/presigned-urlfile_name: The name of the file to be uploaded (e.g., 1m8cG8EkpYP0x9JhrDLYnGroup 1.png)file_type: The MIME type of the file (e.g., image/png)signedRequest and url, where signedRequest is the presigned URL for uploading, and url is the URL to access the file after upload.uploadFileToS3 function to upload the file.uploadFileToS3(file, signedUrl)file: The file object to be uploaded.signedUrl: The presigned URL obtained from the Heltar API.const axios = require('axios'); // Axios for HTTP requests\n// Function to upload a file to S3 using a presigned URL \nconst uploadFileToS3 = async (file, signedUrl) => { \n// Error handling for undefined URL \nif (!signedUrl) { \nconsole.error('Signed URL is undefined'); \nreturn { success: false }; \n}\ntry { \n// Uploading the file to S3 \nconst response = await axios.put(signedUrl, file, { \nheaders: { \n'Content-Type': file.type, \n}, \nonUploadProgress: progressEvent => { \n// Optional: Handling upload progress \nconst total = progressEvent.total; \nconst current = progressEvent.loaded; \nif (typeof total === 'number') { \nconst percentage = Math.floor((current / total) \\* 100); \nconsole.log('File uploaded', percentage, progressEvent); \n} \n}, \n});\nconsole.log('File uploaded successfully.');\nreturn {\n success: true,\n status: response.status,\n statusText: response.statusText,\n};\n} catch (error) { \nconsole.error('File upload failed: ', error); \nreturn { success: false }; \n} \n};\n// Example of using the uploadFileToS3 function \n// Assuming response.data.data contains the presigned URL info from the Heltar API \nconst { signedRequest, url } = response.data.data; \nconst file = /\\* File to be uploaded \\*/; \nuploadFileToS3(file, signedRequest).then(uploadStatus => { \nif (uploadStatus.success) { \nconsole.log('Upload successful:', uploadStatus.statusText); \n} else { \nconsole.error('Upload failed'); \n} \n});\n\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"mediaType\": \"document\",\n \"url\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/9DrvaVKN_XVoYHAWl6IUyResume_offcampus.pdf\",\n \"name\": \"Resume_offcampus.pdf\",\n \"size\": 212732,\n \"mimeType\": \"application/pdf\",\n \"messageType\": \"media\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"Media messages allow you to share various types of media content with your clients in an active chat session. This feature supports multiple media types including audio, document, image, sticker, and video. To send a media message, a two-step process is required: first, generate a presigned URL for the media file, and second, send the media message with the necessary details.
\nBefore sending a media message, you must first upload your media file to a designated storage service and obtain a presigned URL. Refer to the separate documentation section titled \"Generating a Presigned URL for File Upload\" for detailed instructions on this process.
\nOnce you have the presigned URL and your file is uploaded, you can proceed to send a media message.
\naudio/mpeg, image/png, video/mp4).Specify the type of media you are sending using the following enum values:
\naudiodocumentimagestickervideoPayload
\nclientWaNumber: This is the WhatsApp number of the client to whom the message will be sent.mediaType: explained aboveurl: This is the URL where the image is hosted. The server will download the image from this URL and send it as a message.name: This is the name of the file to be sent. It doesn't necessarily have to be the same as the actual filename at the URL, but it's typically best to keep them consistent.size: This is the size of the file in bytes. This can be useful for the server to know ahead of time so it can handle the download properly.mimeType: This describes the file format or data type of the media. Here it is set to \"image/jpeg\" as the media file is a JPEG image.messageType: This is similar to the previous payload but this time it's set to \"media\". This indicates that the message being sent is a media file, not just plain text.**NOTE: mime_type IS VERY IMPORTANT WHILE SENDING IT TO UPLOAD, Please use correct mime_type!
\nNote: This will be a free form message!**
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[{"id":"d9a1cd7e-27c2-452a-b691-71796b55c607","name":"Images","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"918005756750\",\n \"mediaType\": \"image\",\n // URL you'll get through presigned url and uploading process\n \"url\": \"https://heltar-chat-s3.s3-ap-south-1.amazonaws.com/hxMIfTDCxqZYv5GXYLHGF_1680961132890.jpeg.jpeg\",\n \"name\": \"1680961132890.jpeg\",\n \"size\": 115798,\n \"mimeType\": \"image/jpeg\",\n \"messageType\": \"media\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Dec 2023 11:59:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"617"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"269-Y0PHMkOryLC4JdbF4k5ZhRr1g4Y\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully scheduled messages!\",\n \"data\": {\n \"success\": {\n \"0\": {\n \"message\": {\n \"wamid\": \"wamid.HBgMOTE4MDA1NzU2NzUwFQIAERgSNDdDQTJCNkQ5ODgzNzA0NEFBAA==\",\n \"clientWaNumber\": \"918005756750\",\n \"size\": 115798,\n \"mimeType\": \"image/jpeg\",\n \"sha256\": \"temp\",\n \"awsLink\": \"https://heltar-chat-s3.s3-ap-south-1.amazonaws.com/hxMIfTDCxqZYv5GXYLHGF_1680961132890.jpeg.jpeg\",\n \"name\": \"1680961132890.jpeg\",\n \"timestamp\": \"2023-12-28T11:59:14.456Z\",\n \"status\": \"waiting\",\n \"context\": null,\n \"phoneNumberId\": \"101209439305951\",\n \"reaction\": null,\n \"advertisementId\": null,\n \"sentByName\": null,\n \"caption\": null,\n \"type\": \"media\"\n },\n \"clientWaNumber\": \"918005756750\"\n }\n },\n \"fail\": {}\n }\n}"},{"id":"3c05b2c5-491c-4639-a6ea-c35475e1d49f","name":"Videos","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"mediaType\": \"video\",\n \"url\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/CR2qt5pLyE_d3hhkHpL9uScreencast%2520from%252028-11-23%252004_55_27%2520PM%2520IST.mp4\",\n \"name\": \"Screencast from 28-11-23 04_55_27 PM IST.mp4\",\n \"size\": 6398380,\n \"mimeType\": \"video/mp4\",\n \"messageType\": \"media\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Dec 2023 12:06:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"683"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"2ab-S0wPbdCvIwpnxkoUUXY/rPhamrw\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully scheduled messages!\",\n \"data\": {\n \"success\": {\n \"0\": {\n \"message\": {\n \"wamid\": \"wamid.HBgMOTE3NzY0ODAwMTQzFQIAERgSMzY3MTc3OUEwM0IxRTg5MjE4AA==\",\n \"clientWaNumber\": \"917764800143\",\n \"size\": 6398380,\n \"mimeType\": \"video/mp4\",\n \"sha256\": \"temp\",\n \"awsLink\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/CR2qt5pLyE_d3hhkHpL9uScreencast%2520from%252028-11-23%252004_55_27%2520PM%2520IST.mp4\",\n \"name\": \"Screencast from 28-11-23 04_55_27 PM IST.mp4\",\n \"timestamp\": \"2023-12-28T12:06:56.408Z\",\n \"status\": \"waiting\",\n \"context\": null,\n \"phoneNumberId\": \"101209439305951\",\n \"reaction\": null,\n \"advertisementId\": null,\n \"sentByName\": null,\n \"caption\": null,\n \"type\": \"media\"\n },\n \"clientWaNumber\": \"917764800143\"\n }\n },\n \"fail\": {}\n }\n}"},{"id":"06e46b9d-0998-4608-93d3-bec720c4af4b","name":"Audio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"mediaType\": \"audio\",\n \"url\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/E1-K6XjEZidTT1_HpMAQafile_example_MP3_700KB.mp3\",\n \"name\": \"file_example_MP3_700KB.mp3\",\n \"size\": 733645,\n \"mimeType\": \"audio/mpeg\",\n \"messageType\": \"media\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Dec 2023 12:12:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"627"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"273-ESQL2sL2lr9vzOV5b2EiM/ZKkn4\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully scheduled messages!\",\n \"data\": {\n \"success\": {\n \"0\": {\n \"message\": {\n \"wamid\": \"wamid.HBgMOTE3NzY0ODAwMTQzFQIAERgSQ0U5NjEzRDEzRUE4OTU4OENBAA==\",\n \"clientWaNumber\": \"917764800143\",\n \"size\": 733645,\n \"mimeType\": \"audio/mpeg\",\n \"sha256\": \"temp\",\n \"awsLink\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/E1-K6XjEZidTT1_HpMAQafile_example_MP3_700KB.mp3\",\n \"name\": \"file_example_MP3_700KB.mp3\",\n \"timestamp\": \"2023-12-28T12:12:00.874Z\",\n \"status\": \"waiting\",\n \"context\": null,\n \"phoneNumberId\": \"101209439305951\",\n \"reaction\": null,\n \"advertisementId\": null,\n \"sentByName\": null,\n \"caption\": null,\n \"type\": \"media\"\n },\n \"clientWaNumber\": \"917764800143\"\n }\n },\n \"fail\": {}\n }\n}"},{"id":"f4a1b322-8b1b-4e2b-a948-44c1086ee5ac","name":"Document","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"mediaType\": \"document\",\n \"url\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/9DrvaVKN_XVoYHAWl6IUyResume_offcampus.pdf\",\n \"name\": \"Resume_offcampus.pdf\",\n \"size\": 212732,\n \"mimeType\": \"application/pdf\",\n \"messageType\": \"media\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 28 Dec 2023 12:14:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"620"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"26c-X3trsBXGNQxtHfcNOHt70Umcr5w\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully scheduled messages!\",\n \"data\": {\n \"success\": {\n \"0\": {\n \"message\": {\n \"wamid\": \"wamid.HBgMOTE3NzY0ODAwMTQzFQIAERgSMjAzNkM1QzBENTNERUJDMkJFAA==\",\n \"clientWaNumber\": \"917764800143\",\n \"size\": 212732,\n \"mimeType\": \"application/pdf\",\n \"sha256\": \"temp\",\n \"awsLink\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/9DrvaVKN_XVoYHAWl6IUyResume_offcampus.pdf\",\n \"name\": \"Resume_offcampus.pdf\",\n \"timestamp\": \"2023-12-28T12:14:02.814Z\",\n \"status\": \"waiting\",\n \"context\": null,\n \"phoneNumberId\": \"101209439305951\",\n \"reaction\": null,\n \"advertisementId\": null,\n \"sentByName\": null,\n \"caption\": null,\n \"type\": \"media\"\n },\n \"clientWaNumber\": \"917764800143\"\n }\n },\n \"fail\": {}\n }\n}"}],"_postman_id":"71c779af-0e49-425c-96d9-109e190d1142"},{"name":"Location Message","id":"2dbb69b5-a912-46de-9e88-164ea65c2228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"messageType\": \"location\",\n \"location\": {\n \"latitude\": 28.4092136,\n \"longitude\": 77.0601843\n },\n \"clientWaNumber\": \"917764800143\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"We need to set the messageType as \"location\" and in location object we have to send the latitude and longitude of the desired location.
\nNote: This will be a free form message!
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2dbb69b5-a912-46de-9e88-164ea65c2228"},{"name":"Contact (sending) Message","id":"df47a2a1-0ad3-4ce4-81b8-88a901dbc33c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"messageType\": \"contacts\",\n \"contacts\": [\n {\n \"name\": {\n \"formatted_name\": \"Vikesh Kumar\",\n \"prefix\": \"917764800143\"\n },\n \"phones\": [\n {\n \"phone\": \"917764800143\",\n \"wa_id\": \"917764800143\"\n }\n ]\n }\n ],\n \"clientWaNumber\": \"917764800143\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"Note: This will be a free form message!
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"df47a2a1-0ad3-4ce4-81b8-88a901dbc33c"},{"name":"Interactive Messages","id":"2a89e21a-00d6-488f-8e67-124be399799a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"It can be text, image, video or document.
\nHow to add header:
\n\"header\": {\n \"type\": \"text\",\n \"text\": \"Your Text\"\n},\n\n\"header\": {\n // type (& key in object) can be image/video/document/sticker (upload URL can be fetched from presigned url\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/OaNxhpEUoSjygeUcIkXnQhc.png\"\n }\n},\n\nThe button type in interactive messages enables businesses to include one or more clickable buttons within the message. These buttons can be used to prompt users to take specific actions, such as replying with a predefined response or navigating to a URL.
\nHere's a breakdown of the structure for sending an interactive message with buttons:
\nclientWaNumber: The WhatsApp number of the client to whom the message will be sent.messageType: The type of the message, in this case, \"interactive.\"interactive: The interactive content of the message.type: The type of interactive content, in this case, \"button.\"body: The body of the interactive content.text: The text displayed on the button.action: The actions associated with the interactive content.buttons: An array of button objects.type: The type of button, in this case, \"reply.\"reply: The reply associated with the button.id: A unique identifier for the button.title: The title displayed on the button.List messages provide a way to present a collection of items or options to the user in an organized manner. They can be used to display a menu, a catalog of products, or any other list of selectable items.
\nHere's a breakdown of the structure for sending a list message:
\nclientWaNumber: The WhatsApp number of the client to whom the message will be sent.messageType: The type of the message, in this case, \"interactive.\"interactive: The interactive content of the message.type: The type of interactive content, in this case, \"list.\"header: The header of the list, containing:type: The type of content in the header, in this case, \"text.\"text: The text displayed in the header.body: The body of the list.text: The text displayed in the body.action: The actions associated with the list.button: A button associated with the list, containing a text label.sections: An array of sections, each containing:title: The title of the section.rows: An array of rows within the section, each containing:id: A unique identifier for the row.title: The title displayed for the row.description (optional): A description for the row.ID for each list item should be unique (regardless of section). We recommend you to nano_id or something similar.
\nInteractive messages with buttons can be used in various scenarios, such as:
\nCustomer Surveys: Prompting customers to provide feedback on a product or service.
\nQuick Replies: Offering predefined responses to common questions or requests.
\nNavigation: Guiding users to different sections of a website or application.
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"You have multiple ways to share products with your customers:
\nCatalog messages are free-form messages that allow you to showcase your product catalog entirely within WhatsApp.
\nCatalog messages display a product thumbnail header image of your choice, custom body text, a fixed text header, a fixed text sub-header, and a View catalog button.
\nWhen a customer taps the View catalog button, your product catalog appears within WhatsApp.
\nYou must have inventory uploaded to Meta in an ecommerce catalog connected to your WhatsApp Business Account.
\nCatalog template messages are template messages containing a button that, when tapped, displays your product catalog within WhatsApp.
\nTo send a catalog template message you need a catalog template. See our Catalog Templates document to learn how to create these templates and how to send them in a template message.
\nYou can send a link to your entire product catalog by assembling a wa.me link and including it in a standard text message. When sending a text message, you can use the optional preview_url set to true to have the message render a set of product catalog thumbnails of any URL in the message body string.
Note that if you disable the catalog, wa.me links and the View Catalog button in catalog link messages will display a Invalid catalog link message when tapped.
\nTo assemble wa.me link, append your business phone number, including country code, to the end of the following string:
\nhttps://wa.me/c/\n\nFor example:
\nhttps://wa.me/c/15555455657\n\nBoth Multi-Product Messages and Single Product Messages are types of interactive messages.
To send a Single-Product Message, assemble an interactive object of type product with the following components:
To send a Multi-Product Message, assemble an interactive object of type product_list with the following components:
If none of the items provided in the API calls above matches a product from your product catalog, an error message is sent and the Multi- or Single-Product Message is not sent to the user.
\nFor Multi-Product Message, at least one item from the products list must match an item from your product catalog. In this case:
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"start_conversation\",\n \"languageCode\": \"en\",\n \"variables\": [],\n \"messageType\": \"template\",\n \"refId\": \"uPFYyZJcKsQLNwDXyyYk2\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"Template messages are pre-defined message formats that can include components such as a header, body, footer, and buttons/links. They are especially useful for sending structured messages like notifications or reminders.
text, image, document, or video. Text headers can be either static or dynamic, with 1 variable.This flexible and varied messaging structure ensures that businesses can effectively communicate with their clients in ways that are most fitting to the context and the nature of the information being shared.
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d17cc715-fa47-4de1-abb9-18e32960c63c"},{"name":"Template with Text Variables in Header and Body","id":"54c1995a-1d83-427e-a7c1-916e693d85b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"update_order\",\n \"languageCode\": \"en\",\n \"variables\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"B1\"\n },\n {\n \"type\": \"text\",\n \"text\": \"B2\"\n },\n {\n \"type\": \"text\",\n \"text\": \"B3\"\n },\n {\n \"type\": \"text\",\n \"text\": \"B4\"\n },\n {\n \"type\": \"text\",\n \"text\": \"B5\"\n },\n {\n \"type\": \"text\",\n \"text\": \"B6\"\n }\n ]\n },\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"H1\"\n }\n ]\n }\n ],\n \"messageType\": \"template\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"The request body is for sending a templated WhatsApp message:
\nclientWaNumber: The recipient's WhatsApp number.
\ntemplateName: Identifies the specific template to use (e.g., \"update_order\").
\nlanguageCode: The language of the template (e.g., \"en\" for English).
\nvariables: Contains two types of variables:
\nBody Variables: An array of text elements (\"B1\", \"B2\", ... \"Bn\") to be inserted into the template's body.
\nHeader Variable: A single text element (\"H1\") for the header.
\nmessageType: Set to \"template\" to indicate the use of a templated message.
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"welcome\",\n \"languageCode\": \"en\",\n \"variables\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/OaNxhpEUoSjygeUcIkXnQhc.png\"\n }\n }\n ]\n }\n ],\n \"messageType\": \"template\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"{\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/OaNxhpEUoSjygeUcIkXnQhc.png\"\n }\n }\n ]\n }\n\nIn the Header variable set the parameters for image, video or document like in the interactive messages.
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"295e2aca-e479-4dbd-b9d9-dc1a3ce58c31"},{"name":"Template with Video Header","id":"937e2eda-2582-498e-88e2-bd1ba5881ccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"welcome_video\",\n \"languageCode\": \"en\",\n \"variables\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"video\": {\n \"link\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/ZGHEkmhcRwmwBdAK_wmGxHeltarChatbot_Covrzy%2520%281%29.mp4\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"B1\"\n }\n ]\n }\n ],\n \"messageType\": \"template\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"Similar to image
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"937e2eda-2582-498e-88e2-bd1ba5881ccc"},{"name":"Template with Document Header","id":"674beb35-9a7c-4f35-aedf-7af0008c9591","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"welcome_pricing_plan\",\n \"languageCode\": \"en\",\n \"variables\": [\n {\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"document\": {\n \"link\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/djp5FOQ7fe4W8eAfylAQiResume_offcampus.pdf\",\n \"filename\": \"Resume_offcampus.pdf\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"B1\"\n }\n ]\n }\n ],\n \"messageType\": \"template\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"Similar to image
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"674beb35-9a7c-4f35-aedf-7af0008c9591"},{"name":"Template with Dynamic URL Button","id":"78af82c9-b74f-4774-89b2-e488ccd23423","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"welcome_tour\",\n\n \"languageCode\": \"en\",\n \"variables\": [\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": 1,\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"your-endpoint\"\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"B1\"\n }\n ]\n }\n ],\n \"messageType\": \"template\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"To comprehensively explain the request body for sending a dynamic URL button in a WhatsApp template message, consider the following:
\n\"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"HeltarChat\"\n },\n // ... other components ...\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call Button Text\",\n \"phone_number\": \"+918005756750\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Website Button Text\",\n \"url\": \"https://google.com/{{1}}\",\n \"example\": [\"xyz\"]\n }\n ]\n }\n]\n\n\n\"variables\": [\n // ... other variables ...\n {\n \"type\": \"button\",\n \"sub_type\": \"url\",\n \"index\": 1,\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"your-endpoint\"\n }\n ]\n }\n]\n\n\nclientWaNumber: Recipient's WhatsApp number.
templateName: Name of the template (\"welcome_tour\").
languageCode: Language of the template (\"en\" for English).
variables: An array that includes the button and body variables.
For the button (index 1), it specifies the type as \"button\", subtype as \"url\", and includes the URL.
\nFor the body, it includes text variables (\"B1\").
\nContent type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"clientWaNumber\": \"917764800143\",\n \"templateName\": \"welcome_tour_2\",\n \"languageCode\": \"en\",\n \"variables\": [\n {\n // Just a document variable in header\n \"type\": \"header\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"document\": {\n \"link\": \"https://heltar-chat-s3.s3.ap-south-1.amazonaws.com/paYSVUvUBCuGC40vBLxjS01-KS20201-psycholinguistics-discourse-intro.pdf\",\n \"filename\": \"01-KS20201-psycholinguistics-discourse-intro.pdf\"\n }\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"B1\"\n }\n ]\n }\n ],\n \"messageType\": \"template\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/messages/send","description":"They are immutable at the time of sending, you have to modify the template to change the quick replies. Maximum of 3 buttons are possible.
\n","urlObject":{"protocol":"https","path":["v1","messages","send"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba3f3dab-3f94-4019-91eb-5c7c0d481f6b"}],"id":"d14039e0-4f87-4150-881d-b30472b6270f","description":"The Messages folder in the HeltarChat API collection enables businesses to handle their WhatsApp communications effectively. It integrates with the WhatsApp Business API, specifically leveraging the Cloud API, to enable seamless message sending and receiving.
\nThe API supports various types of messages, including text, images, documents, and templates approved by Meta (formerly Facebook). It also supports interactive messages, including buttons and list messages.
\nConversations are 24-hour message threads between you and your customers and are the basis for pricing. Conversations can be opened by sending either free-form messages or template messages. See Pricing to see how conversations are opened and closed, and how they factor into our pricing model.
\nYou can open up to 250 marketing, utility, and authentication conversations in total in a rolling 24-hour period, but must complete business verification and display name approval in order to be able to open more than 250.
\nSee Messaging Limits for an explanation of how we automatically scale the amount of marketing, utility, and authentication conversations you can open with customers.
\nFor sending messages, businesses typically use messaging templates, which are pre-approved message formats. However, for conversational messaging (i.e., in response to a customer-initiated conversation within a 24-hour window), businesses can send free-form messages.
\nThe Messages folder in the HeltarChat API collection facilitates businesses to communicate efficiently with their clients through WhatsApp. With support for various message types, you can convey information in a manner best suited for your business requirements.
\nWhatsApp messages through the Cloud API can be of four types: text, media, and template, interactive. Each type has its unique structure and use case.
Enum Used (to be passed in request): text, media, template, interactive
Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/business/attributes","description":"This API enables you to fetch all the attributes assigned to your business's clients. It gives you a list of attributes that you can use to understand and segment your client base better.
\n","urlObject":{"protocol":"https","path":["v1","business","attributes"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[{"id":"2bfc748c-c123-4f86-b758-e57a3d3f7409","name":"Fetch Attributes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"url":"https://api.heltar.com/v1/business/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"130"},{"key":"ETag","value":"W/\"82-nGBObPIMLJQbsIV8tmIYm4kE3Lg\""},{"key":"Date","value":"Sun, 02 Jul 2023 11:33:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully Fetched Attributes\",\n \"data\": [\n \"age\",\n \"gender\",\n \"Name\",\n \"Custom Column 1\",\n \"Custom Column 2\",\n \"Custom Column 3\"\n ]\n}"}],"_postman_id":"0f4e92ea-f45e-4611-a1ae-489c24ebd142"},{"name":"Create Attributes","id":"b3624949-9713-4def-999d-edd4d2389ddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attributes\": [\n {\n \"fieldKey\": \"Height\",\n \"dataType\": \"numerical\"\n }\n ]\n}"},"url":"https://api.heltar.com/v1/business/attributes","urlObject":{"protocol":"https","path":["v1","business","attributes"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3624949-9713-4def-999d-edd4d2389ddd"},{"name":"Update Attributes","id":"f58a217b-b67d-4138-9cf8-a3dbacabe38b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"oldAttribute\": \"Age\",\n \"newAttribute\": {\n \"fieldKey\": \"Age\",\n \"dataType\": \"text\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/business/attributes","urlObject":{"protocol":"https","path":["v1","business","attributes"],"host":["api","heltar","com"],"query":[],"variable":[]}},"response":[{"id":"e573eb82-9aa6-4611-954a-3838b21efa07","name":"Update with Existing Attribute","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"oldAttribute\": \"Chat Type\",\n \"newAttribute\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/business/attributes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"169"},{"key":"ETag","value":"W/\"a9-9C0z8muHNfzZ+6sTgN6qvfh2k9U\""},{"key":"Date","value":"Sun, 02 Jul 2023 13:24:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"errorType\": \"BadRequest\",\n \"errorMessage\": \"Attribute: name already exists! Please delete it first and then update the attribute!\",\n \"errorsValidation\": null,\n \"errorRaw\": null\n}"},{"id":"aefff4bb-95d8-4ea2-b264-9a3688505706","name":"Change Attribute Name","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"oldAttribute\": \"NewAge\",\n \"newAttribute\": {\n \"fieldKey\": \"Age\",\n \"dataType\": \"numerical\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/business/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 16 Jan 2024 06:48:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"680-Cwo7dQ4VIYIPz4LQWHawuxbv1KU\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully Updated Attribute: NewAge to Age\",\n \"data\": [\n {\n \"fieldKey\": \"first_name\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"last_name\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"email\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"contact\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"branch\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"preferred_currency\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"role\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"created_at\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"updated_at\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"order_count\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"highest_degree\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"suggested_skills\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"already_tutor_somewhere_else\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"marks\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"competitive_rank\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"avg_customer_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"customer_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"executive_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"pan_details\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"cv\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"type\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"university_id\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"bank_id\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"start_year_of_study\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"end_year_of_study\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"competitive_rank_proof\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"hours\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"avg_executive_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"Chat_type\",\n \"dataType\": \"dropdown\",\n \"dropdownOptions\": [\n \"AI\",\n \"Human\"\n ]\n },\n {\n \"fieldKey\": \"tags\",\n \"dataType\": \"tags\",\n \"tagOptions\": [\n \"Excellent\",\n \"Best\",\n \"Very Good\",\n \"Good\",\n \"Failed\"\n ]\n },\n {\n \"fieldKey\": \"Name\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"Height\",\n \"dataType\": \"numerical\"\n },\n {\n \"fieldKey\": \"Age\",\n \"dataType\": \"numerical\"\n }\n ]\n}"},{"id":"d71aeb51-4df8-49fe-a6f4-9db1ce5a9e12","name":"Change Attribute Type","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"body":{"mode":"raw","raw":"{\n \"oldAttribute\": \"Age\",\n \"newAttribute\": {\n \"fieldKey\": \"Age\",\n \"dataType\": \"text\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heltar.com/v1/business/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 16 Jan 2024 06:50:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"ETag","value":"W/\"678-SV9D956D5XzRa8XpSFzhVM2KjP4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully Updated Attribute: Age to Age\",\n \"data\": [\n {\n \"fieldKey\": \"first_name\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"last_name\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"email\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"contact\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"branch\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"preferred_currency\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"role\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"created_at\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"updated_at\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"order_count\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"highest_degree\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"suggested_skills\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"already_tutor_somewhere_else\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"marks\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"competitive_rank\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"avg_customer_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"customer_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"executive_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"pan_details\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"cv\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"type\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"university_id\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"bank_id\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"start_year_of_study\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"end_year_of_study\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"competitive_rank_proof\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"hours\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"avg_executive_rating\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"Chat_type\",\n \"dataType\": \"dropdown\",\n \"dropdownOptions\": [\n \"AI\",\n \"Human\"\n ]\n },\n {\n \"fieldKey\": \"tags\",\n \"dataType\": \"tags\",\n \"tagOptions\": [\n \"Excellent\",\n \"Best\",\n \"Very Good\",\n \"Good\",\n \"Failed\"\n ]\n },\n {\n \"fieldKey\": \"Name\",\n \"dataType\": \"text\"\n },\n {\n \"fieldKey\": \"Height\",\n \"dataType\": \"numerical\"\n },\n {\n \"fieldKey\": \"Age\",\n \"dataType\": \"text\"\n }\n ]\n}"}],"_postman_id":"f58a217b-b67d-4138-9cf8-a3dbacabe38b"},{"name":"Delete Attributes","id":"53725124-8004-4b29-b7a8-202d9dda4266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json
\n","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings
\n","type":"text"}],"url":"https://api.heltar.com/v1/business/attributes?attribute=Name","description":"This API enables you to delete an attribute from the business.
\nAll the clients having some value against this attribute will be made null and the attribute will be removed from the business.
\n","urlObject":{"protocol":"https","path":["v1","business","attributes"],"host":["api","heltar","com"],"query":[{"description":{"content":"The attribute to be deleted from the business.
\n","type":"text/plain"},"key":"attribute","value":"Name"}],"variable":[]}},"response":[{"id":"9ed10342-70f3-4875-9d22-3156c06a380b","name":"Delete Attributes","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"Content type will always be application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apiKey}}","description":"HeltarChat API Key: https://app.heltar.com/settings","type":"text"}],"url":{"raw":"https://api.heltar.com/v1/business/attributes?attribute=Name","protocol":"https","host":["api","heltar","com"],"path":["v1","business","attributes"],"query":[{"key":"attribute","value":"Name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"128"},{"key":"ETag","value":"W/\"80-9Q6qTxR0XbSncbbAoltS7yAvHFA\""},{"key":"Date","value":"Sun, 02 Jul 2023 11:33:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully Deleted Attribute: Name\",\n \"data\": [\n \"age\",\n \"gender\",\n \"Custom Column 1\",\n \"Custom Column 2\",\n \"Custom Column 3\"\n ]\n}"}],"_postman_id":"53725124-8004-4b29-b7a8-202d9dda4266"}],"id":"ef01c5db-da7e-48c3-b121-5c7b7d578202","description":"The Attributes folder in the HeltarChat API collection facilitates businesses to manage client-specific attributes.
\nAttributes are essentially tags or labels that businesses assign to their clients to categorize, identify, or annotate them. These attributes could include details like 'Name', 'Age', 'Location', 'Purchase History', etc. They help to individualize the treatment of each client and tailor the interactions to meet their specific needs. This can greatly enhance the customer experience and client relationships.
\nIn the HeltarChat context, these attributes are managed at the business level. This means the attribute array created will be applicable to all the clients under that business. The value of these attributes can be tailored to each client by modifying client details.
\n","_postman_id":"ef01c5db-da7e-48c3-b121-5c7b7d578202"}]}