{ "info": { "_postman_id": "47503739-11eb-4bd1-af97-ec79acb40c44", "name": "LetsBot API Documentation", "description": "\"\"\n\n# **Welcome to the LetsBot API**\n\nWant to take your business messaging to the next level? With LetsBot API, you can take advantage of the world's most popular messaging platform and create powerful applications that help you enhance customer service & communication needs. Get up and running quickly with our tutorials, reference guides and examples and start building amazing solutions today. Unlock the potential of WhatsApp Business with LetsBot API and get ready for a whole new world of business opportunities!\n\nWhatsApp has completely changed the communication landscape - it's used by an astounding 2 billion people, with 60 billion messages flying around each day! Companies also recognize this as a secure and reliable way to quickly deliver notifications and provide exceptional customer service.\n\nIncredibly easy to use and integrate, the RESTful API of this tool opens up a world of opportunities. You can now connect it to various third-party systems, programming languages, CMS, CRMs & CLI tools.\n\nYou don't need to hassle with SDKs or complex software dependencies - you can use the API right away with ease by sending HTTPS requests to the relevant endpoint.\n\n> #### [Note](https://letsbot.stoplight.io/#note)\n> \n> To access our API, you will need a LetsBot account. Already have an account? [Log in](https://letsbot.net/) now. Otherwise, create your account quickly and easily with only a few clicks - [Create an Account](https://letsbot.net/).\n\n**Send your first message today! 😍**\n\n> This guide is being regularly updated, so check back often! If you need more help or spot any mistakes while developing an application, feel free to reach out and we'll be happy to provide assistance.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "6750751" }, "item": [ { "name": "Messages", "item": [ { "name": "Media", "item": [ { "name": "send file message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "description": "url for target file you need to send", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/file", "host": [ "{{base_url}}" ], "path": [ "send", "file" ] }, "description": "You can send file message to phone number. You just send the **URL** of the message you want to send. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **documentMessage** that contain file info (URL, mimetype of the file, file length, etc.) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "9665xxxxxxxx", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "description": "url for target file you need to send", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/file", "host": [ "{{base_url}}" ], "path": [ "send", "file" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:14:02 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:14:02 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "description": "url for target file you need to send", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/send/file", "host": [ "{{base_url}}" ], "path": [ "send", "file" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:13:48 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:13:48 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send Image message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "url for image ", "type": "text" }, { "key": "caption", "value": "test send image", "description": "this caption on image", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/image", "host": [ "{{base_url}}" ], "path": [ "send", "image" ] }, "description": "You can send Image message to phone number. You just send the **URL** of the message you want to send. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **imageMessage** that contain image info (URL, mimetype of the image, caption of the message and more info) , messageTimesamp format and status of the message" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "9665xxxxxxxx", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "url for image ", "type": "text" }, { "key": "caption", "value": "test send image", "description": "this caption on image", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/image", "host": [ "{{base_url}}" ], "path": [ "send", "image" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:56:36 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:56:36 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "url for image ", "type": "text" }, { "key": "caption", "value": "test send image", "description": "this caption on image", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/send/image", "host": [ "{{base_url}}" ], "path": [ "send", "image" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:56:21 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:56:21 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send video message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4", "description": "url for target video you need send", "type": "text" }, { "key": "caption", "value": "test send video caption", "description": "caption on this video", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/video", "host": [ "{{base_url}}" ], "path": [ "send", "video" ] }, "description": "You can send Video message to phone number. You just send the **URL** of the message you want to send. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **videoMessage** that contain video info (URL, mimetype of the video, caption of the message and more info) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "9665xxxxxxxx", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4", "description": "url for target video you need send", "type": "text" }, { "key": "caption", "value": "test send video caption", "description": "caption on this video", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/video", "host": [ "{{base_url}}" ], "path": [ "send", "video" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:08:26 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:08:26 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4", "description": "url for target video you need send", "type": "text", "disabled": true }, { "key": "caption", "value": "test send video caption", "description": "caption on this video", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/video", "host": [ "{{base_url}}" ], "path": [ "send", "video" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:08:47 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:08:47 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send gif message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://c.tenor.com/Iqv4_poJZOYAAAAj/kju-online.gif", "description": "url for target video you need send", "type": "text" }, { "key": "caption", "value": "This is GIF", "description": "caption of gif", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/gif", "host": [ "{{base_url}}" ], "path": [ "send", "gif" ] }, "description": "You can send gif message to phone number. You just send the **URL** of the message you want to send. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **videoMessage** that contain gif info (URL, mimetype of the video, caption of the message and more info) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "9665xxxxxxxx", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://c.tenor.com/Iqv4_poJZOYAAAAj/kju-online.gif", "description": "url for target video you need send", "type": "text" }, { "key": "caption", "value": "This is GIF", "description": "caption of gif", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/gif", "host": [ "{{base_url}}" ], "path": [ "send", "gif" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:11:00 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:11:00 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://c.tenor.com/Iqv4_poJZOYAAAAj/kju-online.gif", "description": "url for target video you need send", "type": "text", "disabled": true }, { "key": "caption", "value": "This is GIF", "description": "caption of gif", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/gif", "host": [ "{{base_url}}" ], "path": [ "send", "gif" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:10:42 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:10:42 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send audio message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "audio", "value": "https://letsbot.net/public/swiftly.mp3", "description": "url for audio file you need to send", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/audio", "host": [ "{{base_url}}" ], "path": [ "send", "audio" ] }, "description": "You can send audio message to phone number. You just send the **URL** of the message you want to send. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **videoMessage** that contain audio info (URL, mimetype of the file, file length, seconds, etc.) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "9665xxxxxxxx", "description": "phone number with country code", "type": "text" }, { "key": "audio", "value": "https://letsbot.net/public/swiftly.mp3", "description": "url for audio file you need to send", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/audio", "host": [ "{{base_url}}" ], "path": [ "send", "audio" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:17:09 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:17:08 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "audio", "value": "https://letsbot.net/public/swiftly.mp3", "description": "url for audio file you need to send", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/send/audio", "host": [ "{{base_url}}" ], "path": [ "send", "audio" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:19:58 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:19:58 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send location message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "lat", "value": "30.0594885", "description": "value of Latitude", "type": "text" }, { "key": "lng", "value": "31.2584644", "description": "value of longitude", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/location", "host": [ "{{base_url}}" ], "path": [ "send", "location" ] }, "description": "You can send location message to phone number. You just send the **lat&lng** of location you want to send. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **locationMessage** that contain location info (degreesLatitude, degreesLongitude) , messageTimesamp format and status of the message. " }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "lat", "value": "30.0594885", "description": "value of Latitude", "type": "text" }, { "key": "lng", "value": "31.2584644", "description": "value of longitude", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/location", "host": [ "{{base_url}}" ], "path": [ "send", "location" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:35:54 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:35:53 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [ { "key": "CHANNELID", "value": "{{CHANNELID}}", "type": "text" }, { "key": "CHANNELTOKEN", "value": "{{CHANNELTOKEN}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "lat", "value": "30.0594885", "description": "value of Latitude", "type": "text", "disabled": true }, { "key": "lng", "value": "31.2584644", "description": "value of longitude", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/send/location", "host": [ "{{base_url}}" ], "path": [ "send", "location" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:36:18 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:36:18 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send ptt (push to talk) message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/swiftly.mp3", "description": "ppt Url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/ptt", "host": [ "{{base_url}}" ], "path": [ "send", "ptt" ] }, "description": "You can send ppt audio message to phone number. You need to send the **URL** of the file. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **audioMessage** that contain audio info (url, mimetype, ppt, mediaKeyTimestamp, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://letsbot.net/public/swiftly.mp3", "description": "ppt Url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/ptt", "host": [ "{{base_url}}" ], "path": [ "send", "ptt" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:51:13 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:51:13 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send contact", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "contact", "value": "{{phone}}", "description": "the phone number of the contact", "type": "text" }, { "key": "name", "value": "Contact Name", "description": "name for contact will send", "type": "text" }, { "key": "description", "value": "Contact info", "description": "//optional , description of the contact", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/contact", "host": [ "{{base_url}}" ], "path": [ "send", "contact" ] }, "description": "You can send contact message to phone number. You just send the **Contact phone** number, the **name** of the contact and **description** (Optional). **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **contactMessage** that contain Contact info (displyName, vcard) , messageTimesamp format and status of the message. " }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "contact", "value": "{{phone}}", "description": "the phone number of the contact", "type": "text" }, { "key": "name", "value": "Eng Mahmoud", "description": "name for contact will send", "type": "text" }, { "key": "description", "value": "Contact info", "description": "//optional , description of the contact", "type": "text" } ] }, "url": { "raw": "{{base_url}}/send/contact", "host": [ "{{base_url}}" ], "path": [ "send", "contact" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:24:57 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:24:57 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "contact", "value": "{{phone}}", "description": "the phone number of the contact", "type": "text", "disabled": true }, { "key": "name", "value": "Eng Mahmoud", "description": "name for contact will send", "type": "text", "disabled": true }, { "key": "description", "value": "Contact info", "description": "//optional , description of the contact", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/send/contact", "host": [ "{{base_url}}" ], "path": [ "send", "contact" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:25:16 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 12:25:16 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons (alias of /button)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/send/buttons", "host": [ "{{base_url}}" ], "path": [ "send", "buttons" ] }, "description": "Send a message with reply buttons. Same behaviour as `POST /button`.\n\n**Required:** `phone`, `body`, `title`, `footer`, `buttons` (array of buttons, each with `id` and `title`).\n\n**Channels:** official WhatsApp Cloud API and QR channels.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{phone}}\",\n \"title\": \"Order #1024\",\n \"body\": \"Do you want to confirm your order?\",\n \"footer\": \"LetsBot\",\n \"buttons\": [\n {\n \"id\": \"confirm\",\n \"title\": \"Confirm\"\n },\n {\n \"id\": \"cancel\",\n \"title\": \"Cancel\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Message", "item": [ { "name": "send text message", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "السلام عليكم", "description": "the text message you want to send", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send", "host": [ "{{base_url}}" ], "path": [ "message", "send" ] }, "description": "You can send message text to phone number. The **Message Id is the id of key of data. remoteJid** is the whatsapp phone account. **text of extendedTextMessage** is the body of the message that sent. **messageTimestamp** is the date of the message in timestamp format." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "test", "description": "the text message you want to send", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send", "host": [ "{{base_url}}" ], "path": [ "message", "send" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:24:34 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:24:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "test", "description": "the text message you want to send", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/message/send", "host": [ "{{base_url}}" ], "path": [ "message", "send" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:31:56 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:31:56 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send sticker", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://img-11.stickers.cloud/packs/add9862f-fa7a-424d-91f9-8e5a1ee7b3f3/webp/6706af79-d59a-42b5-b01c-8af9b0191bcf.webp", "description": "Sticker Url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/sticker", "host": [ "{{base_url}}" ], "path": [ "message", "send", "sticker" ] }, "description": "You can send sticker message to phone number. You need to send the **URL** of the sticker. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **stickerMessage** that contain Sticker info (url, mimetype, mediaKey, mediaKeyTimestamp, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://img-11.stickers.cloud/packs/add9862f-fa7a-424d-91f9-8e5a1ee7b3f3/webp/6706af79-d59a-42b5-b01c-8af9b0191bcf.webp", "description": "Sticker Url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/sticker", "host": [ "{{base_url}}" ], "path": [ "message", "send", "sticker" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 17:16:18 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 17:16:18 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "url", "value": "https://img-11.stickers.cloud/packs/add9862f-fa7a-424d-91f9-8e5a1ee7b3f3/webp/6706af79-d59a-42b5-b01c-8af9b0191bcf.webp", "description": "Sticker Url", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/message/send/sticker", "host": [ "{{base_url}}" ], "path": [ "message", "send", "sticker" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 17:18:03 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 17:18:03 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send reaction", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "reaction", "value": "❤️", "type": "text" }, { "key": "messageId", "value": "BAE5F2C25476F607", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/reaction", "host": [ "{{base_url}}" ], "path": [ "message", "send", "reaction" ] }, "description": "You can send sticker message to phone number. You need to send the **URL** of the sticker. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **reactionMessage** that contain Reaction info (reaction id, remoteJid, senderTimestampMs) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "reaction", "value": "❤️", "type": "text" }, { "key": "messageId", "value": "{{messageId}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/reaction", "host": [ "{{base_url}}" ], "path": [ "message", "send", "reaction" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 17:18:42 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 17:18:42 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "56" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/reaction", "host": [ "{{base_url}}" ], "path": [ "message", "send", "reaction" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:54:07 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:54:07 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send reply", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال رد", "description": "Content Of message", "type": "text" }, { "key": "messageId", "value": "BAE5F2C25476F607", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/reply", "host": [ "{{base_url}}" ], "path": [ "message", "send", "reply" ] }, "description": "You can send reply on message to phone number. You need to send the body of the message and the message Id that you want to reply on it. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **extended TextMessage** that contain Message reply info (text, contextInfo) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال رد", "description": "Content Of message", "type": "text" }, { "key": "messageId", "value": "{{messageId}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/reply", "host": [ "{{base_url}}" ], "path": [ "message", "send", "reply" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:15:50 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:15:50 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال رد", "description": "Content Of message", "type": "text" }, { "key": "messageId", "value": "{{messageId}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/message/send/reply", "host": [ "{{base_url}}" ], "path": [ "message", "send", "reply" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:15:18 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:15:18 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send mention", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" }, { "key": "mention", "value": "{{phone}}", "description": "The phone of person that will be mentioned ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/mention", "host": [ "{{base_url}}" ], "path": [ "message", "send", "mention" ] }, "description": "You can send mention on message to phone number or GroupId. You need to send mention phone number. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **extended TextMessage** that contain Message mention info (mentionedJid, text) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" }, { "key": "mention", "value": "{{phone}}", "description": "The phone of person that will be mentioned ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/mention", "host": [ "{{base_url}}" ], "path": [ "message", "send", "mention" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:25:45 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:25:45 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "56" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "mention", "value": "{{phone}}", "description": "The phone of person that will be mentioned ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/mention", "host": [ "{{base_url}}" ], "path": [ "message", "send", "mention" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:10:24 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:10:24 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send disappearing message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "This is a disappearing message that will disappear after X duration", "description": "Content of message", "type": "text" }, { "key": "duration", "value": "60", "description": "//(Optional)Message disappear after duration time in seconds. Default (7 days)", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/disappearing", "host": [ "{{base_url}}" ], "path": [ "message", "send", "disappearing" ] }, "description": "You can send disappearing message to phone number. You need to send body of the message and the duration of the message**(optional)** to hide after amount of time **in seconds**. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **extendedTextMessage** in message of ephemeralMessage that contain Message info (text, expiration time in seconds) , messageTimesamp format and status of the message. " }, "response": [ { "name": "Success Reponse", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "This is a disappearing message that will disappear after X duration", "description": "Content of message", "type": "text" }, { "key": "duration", "value": "60", "description": "//(Optional)Message disappear after duration time in seconds. Default (7 days)", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/disappearing", "host": [ "{{base_url}}" ], "path": [ "message", "send", "disappearing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:31:39 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:31:39 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/send/disappearing", "host": [ "{{base_url}}" ], "path": [ "message", "send", "disappearing" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:21:40 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:21:39 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send share catalog message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "catalog", "value": "{{phone}}", "description": "Catalog share phone number", "type": "text" }, { "key": "title", "value": "This is title of catalog", "description": "//optional", "type": "text" }, { "key": "body", "value": "This is body of catalog", "description": "//optional", "type": "text" }, { "key": "description", "value": "This is desc of catalog", "description": "//optional", "type": "text" } ] }, "url": { "raw": "{{base_url}}/share/catalog", "host": [ "{{base_url}}" ], "path": [ "share", "catalog" ] }, "description": "You can share catalog message to phone number. You need to the catalog phone number to be share and you can add more additional details(optional) like title, body, and description. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **extendedTextMessage** that contain Message info (text, description, title, image if exist) , messageTimesamp format and status of the message. " }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "catalog", "value": "{{phone}}", "description": "Catalog share phone number", "type": "text" }, { "key": "title", "value": "This is title of catalog", "description": "//optional", "type": "text" }, { "key": "body", "value": "This is body of catalog", "description": "//optional", "type": "text" }, { "key": "description", "value": "This is desc of catalog", "description": "//optional", "type": "text" } ] }, "url": { "raw": "{{base_url}}/share/catalog", "host": [ "{{base_url}}" ], "path": [ "share", "catalog" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:42:15 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:42:15 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Message", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/share/catalog", "host": [ "{{base_url}}" ], "path": [ "share", "catalog" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:30:14 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:30:14 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "get message by Id", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code" }, { "key": "messageID", "value": "BAE5690364E55771", "description": "Message Id " } ] }, "description": "Get message content info with message id in phone chat number. In the data of the response , **The body of the data response** is the message content**. The chatName** is the phone number that receive this message. messageType is the type of the message that sent. **remoteJid** is the phone whatsapp account. **Time** is the time of the message in timestamp format. **TimeFormatted** is the time of the message in Format _ Dayname, Daynumber MonthName Year Hours:Min:Sec ZoneType_. There are different types of response depend on the message type. You can see **Examples** of the response in different types below the request." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:12:49 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 14:12:49 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Success Response (Text)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messageId}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:32:53 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:32:53 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Image Message Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messageImageId}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:39:09 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:39:09 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Video Message Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messageVideoId}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:40:48 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:40:48 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "File Message Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messageFileid}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:42:25 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:42:25 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "GIF Message Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messaageGifid}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:43:29 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:43:29 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Audio Message Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messageAudioid}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:45:48 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:45:48 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Button Text Message Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "{{messageButtonTextid}}", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/id?phone={{phone}}&messageID=BAE5690364E55771", "host": [ "{{base_url}}" ], "path": [ "message", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE5690364E55771" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:47:57 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 11:47:57 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "Fetch messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "limit", "value": "5", "description": "//optional by defualt 25", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/message/fetch", "host": [ "{{base_url}}" ], "path": [ "message", "fetch" ] }, "description": "Fetch the most recent messages of the WhatsApp session (`limit`, default 25). No date filter.\n\n**Channels:** QR (WhatsApp Web) channels only. On an official WhatsApp Cloud API number this request answers **`409`** with `\"error_code\": \"USE_MESSAGES_ARCHIVE\"` and a ready-made `use.example` URL.\n\nTo read stored messages by date — incoming and outgoing, on any channel — use **Message Archive → Get messages by date**." }, "response": [ { "name": "Fetch Messages", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/message/fetch", "host": [ "{{base_url}}" ], "path": [ "message", "fetch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 08:49:32 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" }, { "name": "409 — official number", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/message/fetch", "host": [ "{{base_url}}" ], "path": [ "message", "fetch" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"Status\": false,\n \"error_code\": \"USE_MESSAGES_ARCHIVE\",\n \"Message\": \"GET /api/v1/message/fetch reads a QR (WhatsApp Web) session, which official WhatsApp Cloud API numbers do not have. Read stored messages — incoming and outgoing — with GET /api/v1/messages (date_from, date_to, optional phone, cursor).\",\n \"use\": {\n \"method\": \"GET\",\n \"path\": \"/api/v1/messages\",\n \"example\": \"/api/v1/messages?phone=966512345678&date_from=2026-08-31&date_to=2026-09-30\"\n }\n}" } ] }, { "name": "delete message by Id", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "BAE509D204172AC0", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/delete?phone={{phone}}&messageID=BAE509D204172AC0", "host": [ "{{base_url}}" ], "path": [ "message", "delete" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE509D204172AC0" } ] }, "description": "You can delete message for phone number. You need to send the message id. **Id of the message** in the key of the data of the response. In the data of the response you can see many options of the message (id, body, messageType, fileName if exist, author, chatName, time in timestamp format, status, etc)." }, "response": [ { "name": "Delete Message by Id", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "messageID", "value": "BAE519A31994E64E", "description": "Message Id ", "type": "text" } ] }, "url": { "raw": "{{base_url}}/message/delete?phone={{phone}}&messageID=BAE509D204172AC0", "host": [ "{{base_url}}" ], "path": [ "message", "delete" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "messageID", "value": "BAE509D204172AC0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 21 Feb 2023 14:56:11 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "forward message", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/message/send/forward/message", "host": [ "{{base_url}}" ], "path": [ "message", "send", "forward", "message" ] }, "description": "Forward a stored message to another phone number.\n\n**Required:** `phone` (recipient), `messageId` (the WhatsApp message id of a message stored in your inbox).\n\n**Channels:** QR (WhatsApp Web) channels only. On official WhatsApp Cloud API channels this request is not supported.", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text", "description": "Recipient phone number" }, { "key": "messageId", "value": "3EB0C4F1A2B3D4E5F6", "type": "text", "description": "WhatsApp id of the stored message to forward" } ] } }, "response": [] } ] }, { "name": "Buttons", "item": [ { "name": "send buttons message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "test title", "description": "//optional title for message", "type": "text" }, { "key": "body", "value": "Content Of the Message", "description": "body for message", "type": "text" }, { "key": "footer", "value": "Footer of the button", "description": "//optional footer for message", "type": "text" }, { "key": "buttons[0][id]", "value": "1", "description": "details for buttons", "type": "text" }, { "key": "buttons[0][title]", "value": "button type 1", "description": "title of the button", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net", "type": "text" }, { "key": "buttons[1][id]", "value": "2", "type": "text", "disabled": true }, { "key": "buttons[1][title]", "value": "button type 2", "type": "text", "disabled": true }, { "key": "buttons[1][type]", "value": "2", "type": "text", "disabled": true }, { "key": "buttons[1][extra_data]", "value": "+9665xxxxxxxx", "type": "text", "disabled": true }, { "key": "buttons[2][id]", "value": "2", "type": "text", "disabled": true }, { "key": "buttons[2][title]", "value": "button type 3", "type": "text", "disabled": true }, { "key": "buttons[2][type]", "value": "3", "type": "text", "disabled": true }, { "key": "buttons[2][extra_data]", "value": "id-like-buttons-message", "type": "text", "disabled": true }, { "key": "caption", "value": "test caption", "description": "optional", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button", "host": [ "{{base_url}}" ], "path": [ "button" ] }, "description": "You can send buttons message to phone number. You need to send the **tilte(optional), body, footer(optional), caption(optional) and buttons** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **buttonsMessage** that contain buttons info (contentText, footerText, buttons, etc) , messageTimesamp format and status of the message. " }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "test title", "description": "//optional title for message", "type": "text" }, { "key": "body", "value": "عرض حصري :fire: دبلناها وتستاهلون أكثر🫶 الباقة صارت باقتين مع الاشتراكات السنوية:star-struck::partying_face: تواصل بذكاء مع عملائك و اجعل منشأتك تنبض بالحياة:seedling:", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لاتفوت العرض", "description": "//optional footer for message", "type": "text" }, { "key": "buttons[0][id]", "value": "1", "description": "details for buttons", "type": "text" }, { "key": "buttons[0][title]", "value": "test1", "description": "title of the button", "type": "text" }, { "key": "buttons[1][id]", "value": "2", "type": "text" }, { "key": "buttons[1][title]", "value": "test 2", "type": "text" }, { "key": "caption", "value": "this is caption", "description": "//optional", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button", "host": [ "{{base_url}}" ], "path": [ "button" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:46:34 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:46:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "test title", "description": "//optional title for message", "type": "text" }, { "key": "body", "value": "عرض حصري :fire: دبلناها وتستاهلون أكثر🫶 الباقة صارت باقتين مع الاشتراكات السنوية:star-struck::partying_face: تواصل بذكاء مع عملائك و اجعل منشأتك تنبض بالحياة:seedling:", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لاتفوت العرض", "description": "//optional footer for message", "type": "text" }, { "key": "buttons[0][id]", "value": "1", "description": "details for buttons", "type": "text", "disabled": true }, { "key": "buttons[0][title]", "value": "test1", "description": "title of the button", "type": "text", "disabled": true }, { "key": "buttons[1][id]", "value": "2", "type": "text", "disabled": true }, { "key": "buttons[1][title]", "value": "test 2", "type": "text", "disabled": true }, { "key": "caption", "value": "this is caption", "description": "//optional", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button", "host": [ "{{base_url}}" ], "path": [ "button" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:49:00 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 14:49:00 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send button with image message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "Image caption", "description": "caption for image", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "image", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "Images URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/image", "host": [ "{{base_url}}" ], "path": [ "button", "image" ] }, "description": "You can send buttons with image message to phone number. You need to send the  **caption, footer(optional), images(array) and buttons(array)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **buttonsMessage** that contain buttons info (imageMessage info, contenText, footerText, buttons, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "Image caption", "description": "caption for image", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "image[0]", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "Images URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/image", "host": [ "{{base_url}}" ], "path": [ "button", "image" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:52:31 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:52:31 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "Image caption", "description": "caption for image", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "image[0]", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "Images URL", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/button/image", "host": [ "{{base_url}}" ], "path": [ "button", "image" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:53:59 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:53:59 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons with video message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "video caption", "description": "caption for video", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "video", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4'", "description": "Videos URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/video", "host": [ "{{base_url}}" ], "path": [ "button", "video" ] }, "description": "You can send buttons with video message to phone number. You need to send the **caption, footer(optional), video(array) and buttons(array)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **buttonsMessage** that contain buttons info (videoMessage info, contenText, footerText, buttons, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "video caption", "description": "caption for video", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "video[0]", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4'", "description": "Videos URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/video", "host": [ "{{base_url}}" ], "path": [ "button", "video" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:55:38 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:55:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Message", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "video caption", "description": "caption for video", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "video", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4'", "description": "Videos URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/video", "host": [ "{{base_url}}" ], "path": [ "button", "video" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Mon, 05 Dec 2022 16:18:34 GMT" }, { "key": "Date", "value": "Mon, 05 Dec 2022 16:18:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons with location message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "location scaption", "description": "caption for location", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "lat", "value": "21", "description": "Latitude Location", "type": "text" }, { "key": "lng", "value": "23", "description": "Longtiude Location", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/location", "host": [ "{{base_url}}" ], "path": [ "button", "location" ] }, "description": "You can send buttons with location message to phone number. You need to send the **caption, footer(optional), lat, lng and buttons(array)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **buttonsMessage** that contain buttons info (locationMessage info, contenText, footerText, buttons, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "location scaption", "description": "caption for location", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "lat", "value": "21", "description": "Latitude Location", "type": "text" }, { "key": "lng", "value": "23", "description": "Longtiude Location", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/location", "host": [ "{{base_url}}" ], "path": [ "button", "location" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:56:45 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 18:56:45 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "location scaption", "description": "caption for location", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/location", "host": [ "{{base_url}}" ], "path": [ "button", "location" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Mon, 05 Dec 2022 16:24:52 GMT" }, { "key": "Date", "value": "Mon, 05 Dec 2022 16:24:52 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons with document message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "This is Document", "description": "caption for document", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "document", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "description": "Documents url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/document", "host": [ "{{base_url}}" ], "path": [ "button", "document" ] }, "description": "You can send message templates via whatsapp with this api" }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "This is Document", "description": "caption for document", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "document", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "description": "Documents url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/document", "host": [ "{{base_url}}" ], "path": [ "button", "document" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Mon, 05 Dec 2022 16:05:25 GMT" }, { "key": "Date", "value": "Mon, 05 Dec 2022 16:05:25 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "caption", "value": "This is Document", "description": "caption for document", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "document", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "description": "Documents url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/document", "host": [ "{{base_url}}" ], "path": [ "button", "document" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 28 Feb 2023 10:13:09 GMT" }, { "key": "Server", "value": "Apache" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Methods", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "*" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Set-Cookie", "value": "oats_loob_go_session=MtbfaKBpTQsUd6cz6ZKPWqPYl6wYLo1Si0CIY99A; expires=Tue, 28 Feb 2023 12:13:09 GMT; Max-Age=7200; path=/; httponly; samesite=lax" }, { "key": "Vary", "value": "Authorization" }, { "key": "Connection", "value": "close" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "send carousel (Messenger / Instagram)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/carousel", "host": [ "{{base_url}}" ], "path": [ "carousel" ] }, "description": "Send a card carousel to a Facebook Messenger or Instagram conversation.\n\n**Required:** `recipient` (the Messenger PSID or Instagram IGSID), `cards` (1–10 cards, each with a `title`).\n\n**Optional:** `platform` (`messenger` default, or `instagram`); per card `subtitle`, `image_url`, `url` and up to 3 `buttons`.\n\n**Channels:** Messenger and Instagram channels only; not WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"recipient\": \"1234567890123456\",\n \"platform\": \"messenger\",\n \"cards\": [\n {\n \"title\": \"Epoxy kit 5 kg\",\n \"subtitle\": \"Clear, UV resistant\",\n \"image_url\": \"https://example.com/kit-5.jpg\",\n \"url\": \"https://example.com/kit-5\"\n },\n {\n \"title\": \"Epoxy kit 20 kg\",\n \"subtitle\": \"Best value\",\n \"image_url\": \"https://example.com/kit-20.jpg\",\n \"url\": \"https://example.com/kit-20\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Buttons Templates", "item": [ { "name": "send buttons template message", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "hello title", "description": "title for message", "type": "text" }, { "key": "body", "value": "hello body", "description": "body for message", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "type": "text" }, { "key": "buttons[0][title]", "value": ":star:Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "description": "1,2,3", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.com", "description": "link,number,btn id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/template", "host": [ "{{base_url}}" ], "path": [ "button", "template" ] }, "description": "You can send buttons _**Template**_ message to phone number. You need to send the **title(optional), footer(optional), body and buttons(array , exp format in body)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **templateMessage** that contain buttons info (hydratedButtons, displayText, url index, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "hello title", "description": "title for message", "type": "text" }, { "key": "body", "value": "hello body", "description": "body for message", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "type": "text" }, { "key": "buttons[0][title]", "value": ":star:Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/template", "host": [ "{{base_url}}" ], "path": [ "button", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 31 Dec 2022 13:53:48 GMT" }, { "key": "Date", "value": "Sat, 31 Dec 2022 13:53:48 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons template with image message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "This is title", "description": "//optional", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "image", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "Image URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/image/template", "host": [ "{{base_url}}" ], "path": [ "button", "image", "template" ] }, "description": "You can send buttons _**Template**_ **with image** message to phone number. You need to send the **title(optional), footer(optional), body and buttons(array , exp format in body)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **templateMessage** that contain buttons info (hydratedButtons, displayText, url index, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "hello title", "description": "title for message", "type": "text" }, { "key": "body", "value": "hello body", "description": "body for message", "type": "text" }, { "key": "footer", "value": "test footer", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/image/template", "host": [ "{{base_url}}" ], "path": [ "button", "image", "template" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 11:27:46 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 11:27:46 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "This is title", "description": "//optional", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" }, { "key": "image", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "description": "Image URL", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/image/template", "host": [ "{{base_url}}" ], "path": [ "button", "image", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 13:22:58 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons template with document message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "buttons[1][id]", "value": "5", "type": "text" }, { "key": "buttons[1][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[1][type]", "value": "1", "type": "text" }, { "key": "buttons[1][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "document", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/document/template", "host": [ "{{base_url}}" ], "path": [ "button", "document", "template" ] }, "description": "You can send buttons _**Template**_ **with document** message to phone number. You need to send the **title(optional), footer(optional), body and buttons(array , exp format in body)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **templateMessage** that contain buttons info (hydratedButtons, displayText, url index, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/document/template", "host": [ "{{base_url}}" ], "path": [ "button", "document", "template" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 11:42:31 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 11:42:31 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "buttons[1][id]", "value": "5", "type": "text" }, { "key": "buttons[1][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[1][type]", "value": "1", "type": "text" }, { "key": "buttons[1][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "document", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/f8eb54b3-30c9-43da-a3bd-2f551c55c114.pdf", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/document/template", "host": [ "{{base_url}}" ], "path": [ "button", "document", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 13:23:46 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons template with video messag", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "video", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4", "description": "Video Url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/video/template", "host": [ "{{base_url}}" ], "path": [ "button", "video", "template" ] }, "description": "You can send buttons _**Template**_ **with video** message to phone number. You need to send the **title(optional), footer(optional), body and buttons(array , exp format in body)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **templateMessage** that contain buttons info (hydratedButtons, displayText, url index, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [ { "key": "CHANNELID", "value": "{{CHANNELID}}", "type": "text" }, { "key": "CHANNELTOKEN", "value": "{{CHANNELTOKEN}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/video/template", "host": [ "{{base_url}}" ], "path": [ "button", "video", "template" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:09:42 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:09:42 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "video", "value": "https://letsbot.net/public/uploads/78986064-893d-4f65-895c-edb2875e4038/chats/dc6a152f-1b27-4171-bf38-9c1e75c2fc34.mp4", "description": "Video Url", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/video/template", "host": [ "{{base_url}}" ], "path": [ "button", "video", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 13:24:12 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "send buttons template with location messag", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "lat", "value": "23", "type": "text" }, { "key": "lng", "value": "21", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/location/template", "host": [ "{{base_url}}" ], "path": [ "button", "location", "template" ] }, "description": "You can send buttons _**Template**_ **with location** message to phone number. You need to send the **title(optional), footer(optional), body and buttons(array , exp format in body)** of the message. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see **templateMessage** that contain buttons info (hydratedButtons, displayText, url index, etc) , messageTimesamp format and status of the message." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://final.letsbot.net/login", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/location/template", "host": [ "{{base_url}}" ], "path": [ "button", "location", "template" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:21:25 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:21:25 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "title", "value": "title", "type": "text" }, { "key": "body", "value": "اهلا بك فى ليتس بوت تجربة ارسال ازرار تفاعلية", "description": "body for message", "type": "text" }, { "key": "footer", "value": "لا تفوت العرض", "description": "footer for message // optional", "type": "text" }, { "key": "buttons[0][id]", "value": "4", "description": "details for buttons you need send", "type": "text" }, { "key": "buttons[0][title]", "value": "⭐Star LetsBot on GitHub!", "type": "text" }, { "key": "buttons[0][type]", "value": "1", "type": "text" }, { "key": "buttons[0][extra_data]", "value": "https://example.net/login", "type": "text" }, { "key": "lat", "value": "23", "type": "text" }, { "key": "lng", "value": "21", "type": "text" } ] }, "url": { "raw": "{{base_url}}/button/location/template", "host": [ "{{base_url}}" ], "path": [ "button", "location", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 13:24:38 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Send List Message", "item": [ { "name": "send list message", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "Body of message", "description": "body for message", "type": "text" }, { "key": "title", "value": "Tilte of message", "description": "//optional title for message", "type": "text" }, { "key": "footer", "value": "Footer of message", "description": "footer for message", "type": "text" }, { "key": "buttonText", "value": "Required, text on the button to view the list", "description": "text on the button to view the list", "type": "text" }, { "key": "sections[0][title]", "value": "Section 1 Text", "description": "details for sections", "type": "text" }, { "key": "sections[0][rows][0][title]", "value": "Option 1", "type": "text" }, { "key": "sections[0][rows][0][rowId]", "value": "Option1", "type": "text" }, { "key": "sections[0][rows][0][description]", "value": "This is description", "type": "text" }, { "key": "sections[0][rows][1][title]", "value": "Option 2", "type": "text" }, { "key": "sections[0][rows][1][rowId]", "value": "Option2", "type": "text" } ] }, "url": { "raw": "{{base_url}}/list/message", "host": [ "{{base_url}}" ], "path": [ "list", "message" ] }, "description": "You can send list message select to phone number. You need to send the **body, footer, title(optional), buttonText and sections(array)** of the message. Every section array has two index which is title and rows , for every rows has title, rowid and description(optional).You can see the result of the sections in image below. **Id of the message** in the key of the data of the response. In the **Message of the data of the response** , You can see listMessage that contain list message info (title, description, buttonText, listType, sections, etc) , messageTimesamp format and status of the message. " }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "Body of message", "description": "body for message", "type": "text" }, { "key": "title", "value": "Tilte of message", "description": "//optional title for message", "type": "text" }, { "key": "footer", "value": "Footer of message", "description": "footer for message", "type": "text" }, { "key": "buttonText", "value": "Required, text on the button to view the list", "description": "text on the button to view the list", "type": "text" }, { "key": "sections[0][title]", "value": "Section 1 Text", "description": "details for sections", "type": "text" }, { "key": "sections[0][rows][0][title]", "value": "Option 1", "type": "text" }, { "key": "sections[0][rows][0][rowId]", "value": "Option1", "type": "text" }, { "key": "sections[0][rows][0][description]", "value": "This is description", "type": "text" }, { "key": "sections[0][rows][1][title]", "value": "Option 2", "type": "text" }, { "key": "sections[0][rows][1][rowId]", "value": "Option2", "type": "text" } ] }, "url": { "raw": "{{base_url}}/list/message", "host": [ "{{base_url}}" ], "path": [ "list", "message" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 19:00:18 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 19:00:18 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "body", "value": "Body of message", "description": "body for message", "type": "text" }, { "key": "title", "value": "Tilte of message", "description": "//optional title for message", "type": "text" }, { "key": "footer", "value": "Footer of message", "description": "footer for message", "type": "text" }, { "key": "buttonText", "value": "Required, text on the button to view the list", "description": "text on the button to view the list", "type": "text" }, { "key": "sections[0][title]", "value": "Section 1 Text", "description": "details for sections", "type": "text", "disabled": true }, { "key": "sections[0][rows][0][title]", "value": "Option 1", "type": "text", "disabled": true }, { "key": "sections[0][rows][0][rowId]", "value": "Option1", "type": "text", "disabled": true }, { "key": "sections[0][rows][0][description]", "value": "This is description", "type": "text", "disabled": true }, { "key": "sections[0][rows][1][title]", "value": "Option 2", "type": "text", "disabled": true }, { "key": "sections[0][rows][1][rowId]", "value": "Option2", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/list/message", "host": [ "{{base_url}}" ], "path": [ "list", "message" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sat, 10 Dec 2022 19:07:50 GMT" }, { "key": "Date", "value": "Sat, 10 Dec 2022 19:07:49 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] } ], "description": "In this folder, you can send different types of message in Whatsapp with different options.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "group", "item": [ { "name": "Invite to group", "item": [ { "name": "generate Invite code", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/code", "host": [ "{{base_url}}" ], "path": [ "invite", "code" ] }, "description": "Get invite code by group id. **Data of the response** is the **invitation code**." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/code", "host": [ "{{base_url}}" ], "path": [ "invite", "code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:23:39 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:23:39 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "revoke Invite code", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/revoke/code", "host": [ "{{base_url}}" ], "path": [ "invite", "revoke", "code" ] }, "description": "Revoke Group invite code by group Id. **Data of the response** is the **New** invite code." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [ { "key": "CHANNELID", "value": "{{CHANNELID}}", "type": "text" }, { "key": "CHANNELTOKEN", "value": "{{CHANNELTOKEN}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/revoke/code", "host": [ "{{base_url}}" ], "path": [ "invite", "revoke", "code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:29:46 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:29:46 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "send invite link", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "to", "value": "{{phone}}", "description": "Phone number", "type": "text" }, { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/send/link", "host": [ "{{base_url}}" ], "path": [ "invite", "send", "link" ] }, "description": "Send invite group link to phone number. The **data** response is the **link for invitation**" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "to", "value": "{{phone}}", "description": "Phone number", "type": "text" }, { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/send/link", "host": [ "{{base_url}}" ], "path": [ "invite", "send", "link" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:35:38 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:35:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "proup get Invite Info", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/invite/get/info?code=KXDixa04zE73bgj5LIWhJ7", "host": [ "{{base_url}}" ], "path": [ "invite", "get", "info" ], "query": [ { "key": "code", "value": "KXDixa04zE73bgj5LIWhJ7" } ] }, "description": "Get Group info by **valid** invite Code. **Data of the response** is the group id." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "code", "value": "{{code}}", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/get/info?code=KXDixa04zE73bgj5LIWhJ7", "host": [ "{{base_url}}" ], "path": [ "invite", "get", "info" ], "query": [ { "key": "code", "value": "KXDixa04zE73bgj5LIWhJ7" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:49:49 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:49:49 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response (Invaild Code)", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "code", "value": "InvaildCode", "description": "Invite Code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/invite/get/info?code=KXDixa04zE73bgj5LIWhJ7", "host": [ "{{base_url}}" ], "path": [ "invite", "get", "info" ], "query": [ { "key": "code", "value": "KXDixa04zE73bgj5LIWhJ7" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 14:18:22 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 14:18:22 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Group Participant", "item": [ { "name": "demote group participant", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers to Demote in group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/demote/participant", "host": [ "{{base_url}}" ], "path": [ "group", "demote", "participant" ] }, "description": "You can demote list of phone numbers in the group. The **Jid** of the response is the Whatsapp account of the participant you demoted." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to Demote in group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/demote/participant", "host": [ "{{base_url}}" ], "path": [ "group", "demote", "participant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:05:59 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:05:58 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers to add in group", "type": "text", "disabled": true }, { "key": "phones[1]", "value": "{{phone}}", "type": "text", "disabled": true }, { "key": "phones", "value": "{{phone}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/demote/participant", "host": [ "{{base_url}}" ], "path": [ "group", "demote", "participant" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "add group participant", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to add in group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/add/participant", "host": [ "{{base_url}}" ], "path": [ "group", "add", "participant" ] }, "description": "You can add participants to the group by passing the **group id** (response of create group) and list of phone numbers**(array)** to add. The **Jid** of the response is the Whatsapp account of the participant you added." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to add in group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/add/participant", "host": [ "{{base_url}}" ], "path": [ "group", "add", "participant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:01:10 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:01:10 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers to add in group", "type": "text" }, { "key": "phones[1]", "value": "{{phone}}", "type": "text" }, { "key": "phones", "value": "{{phone}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/add/participant", "host": [ "{{base_url}}" ], "path": [ "group", "add", "participant" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "remove group participant", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to remove from group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/remove/participant", "host": [ "{{base_url}}" ], "path": [ "group", "remove", "participant" ] }, "description": "You can remove list of phone numbers in the group. The **Jid** of the response is the Whatsapp account of the participant you removed." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers to add in group", "type": "text", "disabled": true }, { "key": "phones[1]", "value": "{{phone}}", "type": "text", "disabled": true }, { "key": "phones", "value": "{{phone}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/remove/participant", "host": [ "{{base_url}}" ], "path": [ "group", "remove", "participant" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Success Respoonse", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to remive from group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/remove/participant", "host": [ "{{base_url}}" ], "path": [ "group", "remove", "participant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:56:14 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:56:14 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "promote group participant", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to Promote in group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/promote/participant", "host": [ "{{base_url}}" ], "path": [ "group", "promote", "participant" ] }, "description": "You can promote list of phone numbers in the group. The **Jid** of the response is the Whatsapp account of the participant you promoted." }, "response": [ { "name": "Success Respose", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone2}}", "description": "List of phone numbers to Promote in group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/promote/participant", "host": [ "{{base_url}}" ], "path": [ "group", "promote", "participant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:04:41 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:04:41 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers to add in group", "type": "text", "disabled": true }, { "key": "phones[1]", "value": "{{phone}}", "type": "text", "disabled": true }, { "key": "phones", "value": "{{phone}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/promote/participant", "host": [ "{{base_url}}" ], "path": [ "group", "promote", "participant" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:52:52 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "group settings", "item": [ { "name": "get display picture", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/group/display/picture?jid=120363061829425867@g.us", "host": [ "{{base_url}}" ], "path": [ "group", "display", "picture" ], "query": [ { "key": "jid", "value": "120363061829425867@g.us" } ] }, "description": "get group image by `jid` parameter value must be group id" }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/display/picture?jid=120363061829425867@g.us", "host": [ "{{base_url}}" ], "path": [ "group", "display", "picture" ], "query": [ { "key": "jid", "value": "120363061829425867@g.us" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:36:21 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:36:21 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/group/display/picture?jid=120363061829425867@g.us", "host": [ "{{base_url}}" ], "path": [ "group", "display", "picture" ], "query": [ { "key": "jid", "value": "120363061829425867@g.us" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 13:35:42 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "set display picture", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "type": "text" }, { "key": "jid", "value": "120363061829425867@g.us", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/set/display/picture", "host": [ "{{base_url}}" ], "path": [ "group", "set", "display", "picture" ] }, "description": "put this `jid` key, it will modify the image of the group" }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [ { "key": "CHANNELID", "value": "{{CHANNELID}}", "type": "text" }, { "key": "CHANNELTOKEN", "value": "{{CHANNELTOKEN}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/set/display/picture", "host": [ "{{base_url}}" ], "path": [ "group", "set", "display", "picture" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:36:21 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:36:21 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "type": "text" }, { "key": "jid", "value": "120363061829425867@g.us", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/set/display/picture", "host": [ "{{base_url}}" ], "path": [ "group", "set", "display", "picture" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 27 Feb 2023 13:36:02 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "rename group", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "subject", "value": "Test Group 2", "description": "The name of the group wil be changed", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/rename", "host": [ "{{base_url}}" ], "path": [ "group", "rename" ] }, "description": "You can rename group chat by passing the group id and the new subject of the group." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "subject", "value": "Test Group 2", "description": "The name of the group wil be changed", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/rename", "host": [ "{{base_url}}" ], "path": [ "group", "rename" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:09:25 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:09:25 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "subject", "value": "Test Group 2", "description": "The name of the group wil be changed", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/group/rename", "host": [ "{{base_url}}" ], "path": [ "group", "rename" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:09:48 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:09:48 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "set group description", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "description", "value": "This is test group", "description": "Description of the group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/set/description", "host": [ "{{base_url}}" ], "path": [ "group", "set", "description" ] }, "description": "You can set group description by passing group id and description." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [ { "key": "CHANNELID", "value": "{{CHANNELID}}", "type": "text" }, { "key": "CHANNELTOKEN", "value": "{{CHANNELTOKEN}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "description", "value": "This is test group", "description": "Description of the group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/set/description", "host": [ "{{base_url}}" ], "path": [ "group", "set", "description" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "html", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:49:49 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:49:49 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Content-Type", "value": "text/html; charset=UTF-8" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "description", "value": "This is test group", "description": "Description of the group", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/group/set/description", "host": [ "{{base_url}}" ], "path": [ "group", "set", "description" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:11:47 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:11:47 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "change group settings", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "120363057244685240@g.us", "description": "Group Id", "type": "text" }, { "key": "settings", "value": "not_announcement", "description": "//announcement, not_announcement, locked, unlocked", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/settings", "host": [ "{{base_url}}" ], "path": [ "group", "settings" ] }, "description": "You can change group settings by passing group id and the settings option. There are **exactly 4 options** in the settings. - **unlocked** (This group settings to allow all participants to edit their information). - **announcement** (This group settings to allow only admins to send messages to this group.) - **not_announcement** (This group settings to allow all participants to send messages to this group). - **locked**(This group settings are for admins only to edit its information)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "settings", "value": "unlocked", "description": "//announcement, not_announcement, locked, unlocked", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/settings", "host": [ "{{base_url}}" ], "path": [ "group", "settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:12:23 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:12:23 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Invaild Settings", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "settings", "value": "invaild", "description": "//announcement, not_announcement, locked, unlocked", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/settings", "host": [ "{{base_url}}" ], "path": [ "group", "settings" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:42:54 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:42:54 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" }, { "key": "settings", "value": "announcement ", "description": "//announcement, not_announcement, locked, unlocked", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/group/settings", "host": [ "{{base_url}}" ], "path": [ "group", "settings" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:21:41 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:21:41 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "get group list", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/group/list", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "group", "list" ] }, "description": "Get groups list of your phone number. Data of the response contain : - participants array of numbers. - id of the group. - name of the group. - conversationTimestamp. - etc...." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/group/list", "host": [ "{{base_url}}" ], "path": [ "group", "list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:36:14 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:36:14 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "get group conversation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/group/conversation?jid={{jid1}}", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "group", "conversation" ], "query": [ { "key": "jid", "value": "{{jid1}}" } ] }, "description": "Get group conversation of your phone number by passing **jid** of the phone number. The data of the response contain : - Id of the mesage. - body. - caption. - messageType(text, file, image, etc). - author. - chatName (Phone number). - time in timestamp. - status of the message. - payload.imageMessage.url (if message is image). - body.content. - etc" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "{{jid1}}", "description": "Whatsapp account number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/conversation?jid={{jid1}}", "host": [ "{{base_url}}" ], "path": [ "group", "conversation" ], "query": [ { "key": "jid", "value": "{{jid1}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:42:38 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:42:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "jid", "value": "", "description": "Phone number", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/group/conversation?jid={{jid1}}", "host": [ "{{base_url}}" ], "path": [ "group", "conversation" ], "query": [ { "key": "jid", "value": "{{jid1}}" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:15:12 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 13:15:12 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "get group metadata", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/group/meta/data?jid={{jid}}", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "group", "meta", "data" ], "query": [ { "key": "jid", "value": "{{jid}}" } ] }, "description": "Get Group Meta info of the group. - ID : of the group. - Subject : name of the group. - Subject Owner : owner Whatsapp account. - Subject Time : timestamp of the subject updated. - Size : number of the participants. - Creation : timestamp of the group creation. - Owner Phone : owner account number. - Description : description of the group. - Description Id : id of the description. - Restrict and announce. - Participants info ( id, admin) if not admin the value is null." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{GROUP_TEST}}", "description": "Group Id", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/meta/data?jid={{jid}}", "host": [ "{{base_url}}" ], "path": [ "group", "meta", "data" ], "query": [ { "key": "jid", "value": "{{jid}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:30:10 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:30:10 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "create group", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers", "type": "text" }, { "key": "phones[1]", "value": "{{phone}}", "type": "text" }, { "key": "subject", "value": "Test Group", "description": "The name of the group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/create", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "group", "create" ] }, "description": "You can create group in Whatsapp by passing subject of the group and phone numbers (array). **The id of the data of the response** is the **id** of the group." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phones[0]", "value": "{{phone}}", "description": "List of phone numbers", "type": "text" }, { "key": "phones[1]", "value": "{{phone}}", "type": "text" }, { "key": "subject", "value": "Test Group", "description": "The name of the group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/create", "host": [ "{{base_url}}" ], "path": [ "group", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:58:02 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:58:02 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phones", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "subject", "value": "Test Group", "description": "The name of the group", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/create", "host": [ "{{base_url}}" ], "path": [ "group", "create" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:32:13 GMT" }, { "key": "Date", "value": "Tue, 06 Dec 2022 13:32:13 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "join group", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "code", "value": "{{code}}", "description": "Invite Code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/join", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "group", "join" ] }, "description": "Join Group by **valid** invite Code. **Data of the response** is the group id." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "code", "value": "{{code}}", "description": "Invite Code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/join", "host": [ "{{base_url}}" ], "path": [ "group", "join" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:28:54 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:28:54 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "code", "value": "invalidcode", "description": "Invite Code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/group/join", "host": [ "{{base_url}}" ], "path": [ "group", "join" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:28:36 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 12:28:36 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Chat", "item": [ { "name": "get chat list for phone", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/chat/list", "host": [ "{{base_url}}" ], "path": [ "chat", "list" ], "query": [ { "key": "platform", "value": "all", "description": "Optional, official numbers only. Same as on `contacts`: default is the platform of the channel whose key you use; `all` for every platform.", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional, official numbers only. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional, official numbers only. Pass `next_cursor` from the previous response, unchanged.", "disabled": true } ] }, "description": "List conversations, most recent first.\n\n**Official WhatsApp Cloud API numbers:** served from your LetsBot workspace — every conversation with at least one message, newest `last_message_date` first, with cursor pagination (`limit`, `cursor`, `next_cursor`). Each item: `id` (chat id), `contact_id`, `phone`, `name`, `platform`, `is_group`, `is_archived`, `is_pinned`, `last_message_date` (ISO-8601, UTC).\n\n**QR (WhatsApp Web) numbers:** unchanged — the chats of the WhatsApp session.\n\nTo read the messages themselves use **Message Archive → Get messages by date** (`phone` narrows it to one conversation)." }, "response": [ { "name": "200 — official number", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/chat/list", "host": [ "{{base_url}}" ], "path": [ "chat", "list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"Status\": true,\n \"source\": \"archive\",\n \"channel\": {\n \"id\": 2,\n \"global_id\": \"8f0c2a4e-5b1d-4c3a-9e7f-0a1b2c3d4e5f\",\n \"phone\": \"966500000000\",\n \"platform\": \"whatsapp\",\n \"is_official\": true\n },\n \"data\": [\n {\n \"id\": \"966512345678@s.whatsapp.net\",\n \"contact_id\": 184,\n \"phone\": \"966512345678\",\n \"name\": \"Karim Store\",\n \"platform\": \"whatsapp\",\n \"is_group\": false,\n \"is_archived\": false,\n \"is_pinned\": false,\n \"last_message_date\": \"2026-09-29T09:14:02+00:00\"\n }\n ],\n \"next_cursor\": null\n}" } ] }, { "name": "get chat conversation for phone", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/chat/conversation?phone={{phone2}}&limit=25&cursorId=REDACTED&cursorFromMe=true", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "conversation" ], "query": [ { "key": "phone", "value": "{{phone2}}" }, { "key": "limit", "value": "25" }, { "key": "cursorId", "value": "REDACTED" }, { "key": "cursorFromMe", "value": "true" } ] }, "description": "Get the conversation with one phone number from the WhatsApp session, newest first. Page with `limit`, then pass the last message's id as `cursorId` and its direction as `cursorFromMe`.\n\n**Channels:** QR (WhatsApp Web) channels only. On an official WhatsApp Cloud API number this request answers **`409`** with `\"error_code\": \"USE_MESSAGES_ARCHIVE\"` and a ready-made `use.example` URL — call that instead.\n\nTo read stored messages on any channel, use **Message Archive → Get messages by date** with `phone=`." }, "response": [ { "name": "success response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/chat/conversation?phone={{phone2}}&limit=25&cursorId=REDACTED&cursorFromMe=true", "host": [ "{{base_url}}" ], "path": [ "chat", "conversation" ], "query": [ { "key": "phone", "value": "{{phone2}}" }, { "key": "limit", "value": "25" }, { "key": "cursorId", "value": "REDACTED" }, { "key": "cursorFromMe", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:03:31 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" }, { "name": "409 — official number", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/chat/conversation?phone=966512345678", "host": [ "{{base_url}}" ], "path": [ "chat", "conversation" ], "query": [ { "key": "phone", "value": "966512345678" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"Status\": false,\n \"error_code\": \"USE_MESSAGES_ARCHIVE\",\n \"Message\": \"GET /api/v1/chat/conversation reads a QR (WhatsApp Web) session, which official WhatsApp Cloud API numbers do not have. Read stored messages — incoming and outgoing — with GET /api/v1/messages (date_from, date_to, optional phone, cursor).\",\n \"use\": {\n \"method\": \"GET\",\n \"path\": \"/api/v1/messages\",\n \"example\": \"/api/v1/messages?phone=966512345678&date_from=2026-08-31&date_to=2026-09-30\"\n }\n}" } ] }, { "name": "get contacts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/contacts", "host": [ "{{base_url}}" ], "path": [ "contacts" ], "query": [ { "key": "search", "value": "Karim", "description": "Optional, at least 2 characters. Matches the contact's name, saved name, WhatsApp profile name or number.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. One contact by number (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "updated_since", "value": "2026-09-01", "description": "Optional. Only contacts created or changed since this moment. `YYYY-MM-DD` or an ISO-8601 datetime, read in `timezone`. For an incremental sync, store the newest `updated_at` you received and pass it next time.", "disabled": true }, { "key": "timezone", "value": "UTC", "description": "Optional, default `UTC`. IANA timezone used to read `updated_since`. Returned timestamps are always UTC.", "disabled": true }, { "key": "include_groups", "value": "1", "description": "Optional. `1` also returns WhatsApp groups. By default only people are returned.", "disabled": true }, { "key": "platform", "value": "all", "description": "Optional. Default: the platform of the channel whose key you use (WhatsApp for a WhatsApp number). `messenger`, `instagram`, `telegram`, ... for one platform, or `all`.", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. `null` means there are no more pages.", "disabled": true } ] }, "description": "List the contacts of your workspace.\n\n**Official WhatsApp Cloud API numbers:** served from your LetsBot workspace (the same contacts you see in Live Chat), with search, an incremental-sync filter (`updated_since`) and cursor pagination. The response says `\"source\": \"archive\"` and includes `channel`, the number whose key made the request.\n\n**QR (WhatsApp Web) numbers:** unchanged — the phone's address book as the WhatsApp session reports it (`id` = WhatsApp id, `name`, `notify` = profile name, image when available). The filters below do not apply there.\n\nContacts are **workspace-wide**: one customer is one contact whichever of your numbers they wrote to.\n\n**Each contact (official numbers)**\n- `id` — the WhatsApp chat id (`@s.whatsapp.net`); `contact_id` — the LetsBot contact id.\n- `phone` — the customer's number, or `null` when WhatsApp only gave us a private identity (a customer who hides their number behind a username).\n- `name`, `notify` (WhatsApp profile name), `lb_name` (name saved in LetsBot), `email`, `image`.\n- `platform`, `is_group`, `is_archived`, `is_blocked`.\n- `last_message_date`, `created_at`, `updated_at` — ISO-8601, UTC.\n\n**Pagination:** ordered by `contact_id`. Repeat the request with `cursor=` until `next_cursor` is `null`.\n\n**Errors:** `422` for an invalid parameter or cursor; `401` for a missing or wrong key; `402` when the subscription or API add-on is not active." }, "response": [ { "name": "200 — official number (first page)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/contacts?limit=1", "host": [ "{{base_url}}" ], "path": [ "contacts" ], "query": [ { "key": "limit", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"Status\": true,\n \"source\": \"archive\",\n \"channel\": {\n \"id\": 2,\n \"global_id\": \"8f0c2a4e-5b1d-4c3a-9e7f-0a1b2c3d4e5f\",\n \"phone\": \"966500000000\",\n \"platform\": \"whatsapp\",\n \"is_official\": true\n },\n \"data\": [\n {\n \"id\": \"966512345678@s.whatsapp.net\",\n \"contact_id\": 184,\n \"phone\": \"966512345678\",\n \"name\": \"Karim Store\",\n \"notify\": \"Karim\",\n \"lb_name\": \"Karim Store\",\n \"email\": null,\n \"image\": null,\n \"platform\": \"whatsapp\",\n \"is_group\": false,\n \"is_archived\": false,\n \"is_blocked\": false,\n \"last_message_date\": \"2026-09-29T09:14:02+00:00\",\n \"created_at\": \"2026-05-02T11:40:00+00:00\",\n \"updated_at\": \"2026-09-29T09:14:02+00:00\"\n }\n ],\n \"next_cursor\": \"eyJpIjoxODR9\"\n}" } ] }, { "name": "set typing", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{phone}}", "description": "phone number or chat id", "type": "text" }, { "key": "chat", "value": "{{GROUP_TEST}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/typing", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "typing" ] }, "description": "You can show you are typing to the phone number or chat by passing in the chat form-data." }, "response": [ { "name": "Success Respose", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{phone}}", "description": "phone number or chat id", "type": "text" }, { "key": "chat", "value": "{{GROUP_TEST}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/typing", "host": [ "{{base_url}}" ], "path": [ "chat", "typing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:11:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:11:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "set recording", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{phone}}", "description": "phone number or group id", "type": "text" }, { "key": "chat", "value": "{{GROUP_TEST}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/recording", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "recording" ] }, "description": "You can set you are recording by passing phone number or group id." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "chat", "value": "{{phone}}", "description": "phone number or group id", "type": "text" }, { "key": "chat", "value": "{{GROUP_TEST}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/recording", "host": [ "{{base_url}}" ], "path": [ "chat", "recording" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:26:07 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:26:07 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "read chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/read", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "read" ] }, "description": "You can read chat messages to phone number. Before After" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/read", "host": [ "{{base_url}}" ], "path": [ "chat", "read" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:17:38 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:17:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "unread chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/unread", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "unread" ] }, "description": "You can un read phone chat number." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/unread", "host": [ "{{base_url}}" ], "path": [ "chat", "unread" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:18:13 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:18:13 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "archive chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/archive", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "archive" ] }, "description": "You can archive chat phone number." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/archive", "host": [ "{{base_url}}" ], "path": [ "chat", "archive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:57:00 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:56:59 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "unarchive chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" }, { "key": "", "value": "", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/unarchive", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "unarchive" ] }, "description": "You can un archive chat phone number." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" }, { "key": "", "value": "", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/unarchive", "host": [ "{{base_url}}" ], "path": [ "chat", "unarchive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:20:17 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:20:17 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "mute chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" }, { "key": "duration", "value": "60", "description": "Duration of mute chat in seconds", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/mute", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "mute" ] }, "description": "You can mute chat phone number with duration time in **seconds.**" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" }, { "key": "duration", "value": "60", "description": "Duration of mute chat in seconds", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/mute", "host": [ "{{base_url}}" ], "path": [ "chat", "mute" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:21:56 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:21:56 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/mute", "host": [ "{{base_url}}" ], "path": [ "chat", "mute" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 12:00:43 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 12:00:43 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "unmute chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/unmute", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "unmute" ] }, "description": "You can un mute phone chat number." }, "response": [ { "name": "success response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/unmute", "host": [ "{{base_url}}" ], "path": [ "chat", "unmute" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:06:36 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "pin chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number or Group id", "type": "text" }, { "key": "phone", "value": "{{GROUP_TEST}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/pin", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "pin" ] }, "description": "You can pin phone chat number or group chat(passing group id)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number or Group id", "type": "text" }, { "key": "phone", "value": "{{GROUP_TEST}}", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/chat/pin", "host": [ "{{base_url}}" ], "path": [ "chat", "pin" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:23:38 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:23:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "unpin chat", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number or Group id", "type": "text" }, { "key": "phone", "value": "{{GROUP_TEST}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/unpin", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "chat", "unpin" ] }, "description": "You can un pin phone chat number or group chat(passing group id)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number or Group id", "type": "text" }, { "key": "phone", "value": "{{GROUP_TEST}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/chat/unpin", "host": [ "{{base_url}}" ], "path": [ "chat", "unpin" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:25:25 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 11:25:25 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "check phone on WhatsApp", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/check/phone", "host": [ "{{base_url}}" ], "path": [ "check", "phone" ] }, "description": "Check whether a phone number has a WhatsApp account.\n\n**Required:** `phone` (international format, digits).\n\n**Channels:** QR (WhatsApp Web) channels only. On official WhatsApp Cloud API channels this request is not supported.", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text", "description": "Phone number to check" } ] } }, "response": [] } ] }, { "name": "Users", "item": [ { "name": "presence user", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/presence", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "user", "presence" ] }, "description": "Get user presence status." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/presence", "host": [ "{{base_url}}" ], "path": [ "user", "presence" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:02:30 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:02:30 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/user/presence", "host": [ "{{base_url}}" ], "path": [ "user", "presence" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:32:59 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "56" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "disply picture by user", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/display/picture?phone={{phone}}", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "user", "display", "picture" ], "query": [ { "key": "phone", "value": "{{phone}}" } ] }, "description": "Display user picture by phone number. **Data of the response is the picture link.**" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/display/picture?phone={{phone}}", "host": [ "{{base_url}}" ], "path": [ "user", "display", "picture" ], "query": [ { "key": "phone", "value": "{{phone}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:27:08 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:27:08 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/user/display/picture?phone={{phone}}", "host": [ "{{base_url}}" ], "path": [ "user", "display", "picture" ], "query": [ { "key": "phone", "value": "{{phone}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:33:30 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "block number", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/block", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "user", "block" ] }, "description": "Block phone number by passing the number in form-data." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/block", "host": [ "{{base_url}}" ], "path": [ "user", "block" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:27:32 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:27:32 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "unblock number", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/unblock", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "user", "unblock" ] }, "description": "un block phone number by passing the number in form-data." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/unblock", "host": [ "{{base_url}}" ], "path": [ "user", "unblock" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:28:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:28:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "user business profile", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/business", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "user", "business" ] }, "description": "You can get info of user business profile by passing phone number. The data of the response contain : - wid Whatsapp phone account. - description of the business. - website business. - category of the business. - business working hours if exist. - address of the business. - email of the business. - etc." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/business", "host": [ "{{base_url}}" ], "path": [ "user", "business" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:31:40 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:31:40 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/business", "host": [ "{{base_url}}" ], "path": [ "user", "business" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:35:18 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "set profile name", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" }, { "key": "name", "value": "Profile Name", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/set/name", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "user", "set", "name" ] }, "description": "You can set profile name of phone number." }, "response": [ { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "", "value": "", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/user/set/name", "host": [ "{{base_url}}" ], "path": [ "user", "set", "name" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:16:36 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:16:36 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone2}}", "description": "phone number with country code", "type": "text" }, { "key": "name", "value": "Profile Name", "type": "text" } ] }, "url": { "raw": "{{base_url}}/user/set/name", "host": [ "{{base_url}}" ], "path": [ "user", "set", "name" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:32:56 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:32:56 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "get user status", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/user/status", "host": [ "{{base_url}}" ], "path": [ "user", "status" ] }, "description": "Get the WhatsApp \"about\" text of a phone number.\n\n**Required:** `phone`.\n\n**Channels:** QR (WhatsApp Web) channels only. On official WhatsApp Cloud API channels this request is not supported.", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text", "description": "Phone number" } ] } }, "response": [] }, { "name": "set my status", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/user/set/status", "host": [ "{{base_url}}" ], "path": [ "user", "set", "status" ] }, "description": "Set the WhatsApp \"about\" text of your connected number.\n\n**Required:** `status`.\n\n**Channels:** QR (WhatsApp Web) channels only. On official WhatsApp Cloud API channels this request is not supported.", "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "Available 9:00–18:00", "type": "text", "description": "New about text" } ] } }, "response": [] }, { "name": "set my display picture", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/user/set/display/picture", "host": [ "{{base_url}}" ], "path": [ "user", "set", "display", "picture" ] }, "description": "Set the profile picture of your connected number.\n\n**Required:** `phone`, `image` (a public image URL).\n\n**Channels:** QR (WhatsApp Web) channels only. On official WhatsApp Cloud API channels this request is not supported.", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text", "description": "Your connected number" }, { "key": "image", "value": "https://example.com/logo.jpg", "type": "text", "description": "Public URL of the image" } ] } }, "response": [] } ] }, { "name": "Live Chat", "description": "Contacts, labels and team assignment in the LetsBot inbox. These read and write your LetsBot data and work on every channel type.", "item": [ { "name": "get contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/live_chat/contact?phone={{phone}}", "host": [ "{{base_url}}" ], "path": [ "live_chat", "contact" ], "query": [ { "key": "phone", "value": "{{phone}}", "description": "Contact phone number" } ] }, "description": "Get a contact with its labels and assigned team members. If the phone number is not a contact yet, it is created.\n\n**Required:** `phone`.\n\n**Response:** `data` = `{id, phone, labels[], moderators[]}`.\n\nValidation errors return HTTP 422 `{\"message\": \"error\", \"data\": \"\"}`." }, "response": [] }, { "name": "list team members", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/live_chat/moderators", "host": [ "{{base_url}}" ], "path": [ "live_chat", "moderators" ] }, "description": "List the team members who can be assigned to conversations.\n\n**Response:** `data[]` = `{id, name, email, phone, image}`." }, "response": [] }, { "name": "assign team member to contact", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/live_chat/set-moderator", "host": [ "{{base_url}}" ], "path": [ "live_chat", "set-moderator" ] }, "description": "Assign a team member to a contact. Existing assignments are kept.\n\n**Required:** `phone`, `moderator_id` (an `id` from *list team members*).\n\nValidation errors return HTTP 422 `{\"message\": \"error\", \"data\": \"\"}`.", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text", "description": "Contact phone number" }, { "key": "moderator_id", "value": "3", "type": "text", "description": "Team member id" } ] } }, "response": [] }, { "name": "list labels", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/live_chat/labels", "host": [ "{{base_url}}" ], "path": [ "live_chat", "labels" ] }, "description": "List contact labels.\n\n**Response:** `data[]` = `{id, name, name_translations, color}`." }, "response": [] }, { "name": "add label to contact", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/live_chat/set-label", "host": [ "{{base_url}}" ], "path": [ "live_chat", "set-label" ] }, "description": "Add a label to a contact. Existing labels are kept.\n\n**Required:** `phone`, `label_id` (an `id` from *list labels*).\n\nValidation errors return HTTP 422 `{\"message\": \"error\", \"data\": \"\"}`.", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "type": "text", "description": "Contact phone number" }, { "key": "label_id", "value": "5", "type": "text", "description": "Label id" } ] } }, "response": [] } ] }, { "name": "Instances", "item": [ { "name": "status", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "https://letsbot.net/resources/Gallery/221595264200_servers.png", "type": "text", "disabled": true } ] }, "url": { "raw": "{{base_url}}/instance/status", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "instance", "status" ] }, "description": "You can set status of your phone number by passing status field." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "Test Status", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/status", "host": [ "{{base_url}}" ], "path": [ "instance", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:38:06 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:38:05 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/instance/status", "host": [ "{{base_url}}" ], "path": [ "instance", "status" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:27:38 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:27:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "set status", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "343434", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/status", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "instance", "set", "status" ] }, "description": "You can set status of your phone number by passing status field." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "Test Status", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/status", "host": [ "{{base_url}}" ], "path": [ "instance", "set", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:38:06 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:38:05 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/instance/set/status", "host": [ "{{base_url}}" ], "path": [ "instance", "set", "status" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:27:38 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:27:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "set Settings", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "markOnlineOnConnect", "value": "1", "description": "//1 for true, 0 for false", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/settings", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "instance", "set", "settings" ] }, "description": "Set setting of the phone when mark online on connect to be true or false(1 or 0)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "markOnlineOnConnect", "value": "1", "description": "//1 for true, 0 for false", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/settings", "host": [ "{{base_url}}" ], "path": [ "instance", "set", "settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:39:36 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:39:36 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "", "value": "", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/settings", "host": [ "{{base_url}}" ], "path": [ "instance", "set", "settings" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:30:20 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:30:20 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "set presence", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "presence", "value": "available", "description": "unavailable,available,composing,recording,paused", "type": "text" }, { "key": "mixed", "value": "{{phone}}", "description": "put phone or group jid", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/presence", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "instance", "set", "presence" ] }, "description": "if you want to set presence you may should to use `mixed` parameter to set by phone or group jid mixed=xxxxxxx@g.us OR mixed=966xxxxxxx" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "markOnlineOnConnect", "value": "1", "description": "//1 for true, 0 for false", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/presence", "host": [ "{{base_url}}" ], "path": [ "instance", "set", "presence" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:39:36 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:39:36 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "", "value": "", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/set/presence", "host": [ "{{base_url}}" ], "path": [ "instance", "set", "presence" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:30:20 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:30:20 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] }, { "name": "pending query broadcast", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "broadcast", "value": "test", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/query/broadcast", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "instance", "query", "broadcast" ] }, "description": "Set setting of the phone when mark online on connect to be true or false(1 or 0)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "markOnlineOnConnect", "value": "1", "description": "//1 for true, 0 for false", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/query/broadcast", "host": [ "{{base_url}}" ], "path": [ "instance", "query", "broadcast" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:39:36 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:39:36 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "Failed Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "", "value": "", "type": "text" } ] }, "url": { "raw": "{{base_url}}/instance/query/broadcast", "host": [ "{{base_url}}" ], "path": [ "instance", "query", "broadcast" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:30:20 GMT" }, { "key": "Date", "value": "Fri, 09 Dec 2022 15:30:20 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "product", "item": [ { "name": "get products", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "product" ] }, "description": "Get products of phone number. products of the data from response is the details for all products. Details like: - id of the product. - iamgeUrls. - reviewStauts from whatsapp exp(APPROVED(. - avaiability. - name. - description. - price. - currency - isHidden(Boolean). - etc" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product", "host": [ "{{base_url}}" ], "path": [ "product" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product", "host": [ "{{base_url}}" ], "path": [ "product" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:53:56 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "get products by id", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{base_url}}/product/id?phone={{phone}}&productId=6198355910228429", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "product", "id" ], "query": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code" }, { "key": "productId", "value": "6198355910228429" } ] }, "description": "Get products of phone number. products of the data from response is the details for all products. Details like: - id of the product. - iamgeUrls. - reviewStauts from whatsapp exp(APPROVED(. - avaiability. - name. - description. - price. - currency - isHidden(Boolean). - etc" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/id?phone={{phone}}&productId=6198355910228429", "host": [ "{{base_url}}" ], "path": [ "product", "id" ], "query": [ { "key": "phone", "value": "{{phone}}" }, { "key": "productId", "value": "6198355910228429" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/product/id?phone={{phone}}&productId=6198355910228429", "host": [ "{{base_url}}" ], "path": [ "product", "id" ], "query": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code" }, { "key": "productId", "value": "6198355910228429" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 13:54:58 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "create products", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "name", "value": "product name", "type": "text" }, { "key": "description", "value": "product description", "type": "text" }, { "key": "price", "value": "1000", "type": "text" }, { "key": "currency", "value": "EGP", "type": "text" }, { "key": "isHidden", "value": "0", "type": "text" }, { "key": "images[0][url]", "value": "https://letsbot.net/public/uploads/8fe87007-20f4-4730-96e9-f6a9bc806dbc/groupMessages/60/soca-company-112923571820220811041023AM.jpg", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/create", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "product", "create" ] }, "description": "Get products of phone number. products of the data from response is the details for all products. Details like: - id of the product. - iamgeUrls. - reviewStauts from whatsapp exp(APPROVED(. - avaiability. - name. - description. - price. - currency - isHidden(Boolean). - etc" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/create", "host": [ "{{base_url}}" ], "path": [ "product", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "name", "value": "product name", "type": "text" }, { "key": "description", "value": "product description", "type": "text" }, { "key": "price", "value": "3460", "type": "text" }, { "key": "currency", "value": "EGP", "type": "text" }, { "key": "isHidden", "value": "0", "type": "text" }, { "key": "images[0][url]", "value": "https://letsbot.net/public/uploads/8fe87007-20f4-4730-96e9-f6a9bc806dbc/groupMessages/60/soca-company-112923571820220811041023AM.jpg", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/create", "host": [ "{{base_url}}" ], "path": [ "product", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:03:41 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "57" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "get order", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "orderID", "value": "456", "type": "text" }, { "key": "orderToken", "value": "", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/get/order", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "product", "get", "order" ] }, "description": "Get products of phone number. products of the data from response is the details for all products. Details like: - id of the product. - iamgeUrls. - reviewStauts from whatsapp exp(APPROVED(. - avaiability. - name. - description. - price. - currency - isHidden(Boolean). - etc" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/get/order", "host": [ "{{base_url}}" ], "path": [ "product", "get", "order" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" }, { "key": "orderID", "value": "456", "type": "text" }, { "key": "orderToken", "value": "", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/get/order", "host": [ "{{base_url}}" ], "path": [ "product", "get", "order" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:03:58 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "56" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "get collections", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/get/collections", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "product", "get", "collections" ] }, "description": "Get products of phone number. products of the data from response is the details for all products. Details like: - id of the product. - iamgeUrls. - reviewStauts from whatsapp exp(APPROVED(. - avaiability. - name. - description. - price. - currency - isHidden(Boolean). - etc" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "{{phone}}", "description": "phone number with country code", "type": "text" } ] }, "url": { "raw": "{{base_url}}/product/get/collections", "host": [ "{{base_url}}" ], "path": [ "product", "get", "collections" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Host", "value": "localhost:8000" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Date", "value": "Sun, 11 Dec 2022 13:35:04 GMT" }, { "key": "Connection", "value": "close" }, { "key": "X-Powered-By", "value": "PHP/8.1.4" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Access-Control-Allow-Origin", "value": "*" } ], "cookie": [], "body": "" } ] } ] }, { "name": "QR", "item": [ { "name": "qr", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/qr", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "qr" ] }, "description": "here you can query check your QRCode" }, "response": [ { "name": "success response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/qr", "host": [ "{{base_url}}" ], "path": [ "qr" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:05:03 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Sessions", "item": [ { "name": "find session", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/session/find", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "session", "find" ] }, "description": "in this query you can find your session" }, "response": [ { "name": "success response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/session/find", "host": [ "{{base_url}}" ], "path": [ "session", "find" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:07:11 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/session/find", "host": [ "{{base_url}}" ], "path": [ "session", "find" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:07:11 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] }, { "name": "session status", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/session/status", "protocol": "https", "host": [ "letsbot", "net" ], "path": [ "api", "v1", "session", "status" ] }, "description": "use this link to check your session is authenticated" }, "response": [ { "name": "success response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/session/status", "host": [ "{{base_url}}" ], "path": [ "session", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:07:57 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "58" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" }, { "name": "failed response", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/session/status", "host": [ "{{base_url}}" ], "path": [ "session", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Sun, 26 Feb 2023 14:08:57 GMT" }, { "key": "Server", "value": "Apache/2.4.46 (Unix) mod_fastcgi/mod_fastcgi-SNAP-0910052141 OpenSSL/1.0.2u mod_wsgi/3.5 Python/2.7.13" }, { "key": "X-Powered-By", "value": "PHP/8.1.0" }, { "key": "Cache-Control", "value": "no-cache, private" }, { "key": "X-RateLimit-Limit", "value": "60" }, { "key": "X-RateLimit-Remaining", "value": "59" }, { "key": "Keep-Alive", "value": "timeout=5, max=100" }, { "key": "Connection", "value": "Keep-Alive" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Templates (Official API)", "description": "WhatsApp Template Messages API endpoints. These endpoints allow sending pre-approved WhatsApp template messages through the official Meta WhatsApp Business API.\n\n**Important Notes:**\n- Templates must be pre-approved in WhatsApp Business Manager before sending\n- Only works with official WhatsApp Business API channels\n- Supports all template types: text, image, document, video, and location headers", "item": [ { "name": "Send Template Message (Full Featured)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{phone}}\",\n \"template_name\": \"added_to_course\",\n \"template_language\": \"ar\",\n \"components\": {\n \"header\": {\n \"type\": \"text\",\n \"parameters\": [\n {\"type\": \"text\", \"text\": \"تأكيد التسجيل\"}\n ]\n },\n \"body\": [\n \"أحمد\",\n \"دورة البرمجة المتقدمة\"\n ],\n \"buttons\": [\n {\n \"index\": 0,\n \"sub_type\": \"url\",\n \"parameters\": [{\"type\": \"text\", \"text\": \"app/course/123\"}]\n },\n {\n \"index\": 1,\n \"sub_type\": \"url\",\n \"parameters\": [{\"type\": \"text\", \"text\": \"store/app/456\"}]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/template/send", "host": [ "{{base_url}}" ], "path": [ "template", "send" ] }, "description": "Send any WhatsApp template message with full component support.\n\n**Supports:**\n- Header: text, image, document, video, location\n- Body: text parameters (variables)\n- Buttons: URL buttons, Quick Reply buttons\n\n**Example for `added_to_course` template:**\n- Header with confirmation title\n- Body with customer name and course name\n- URL buttons for iOS and Android app download" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"966500000000\",\n \"template_name\": \"added_to_course\",\n \"template_language\": \"ar\",\n \"components\": {\n \"body\": [\"أحمد\", \"دورة البرمجة\"]\n }\n}" }, "url": { "raw": "{{base_url}}/template/send", "host": [ "{{base_url}}" ], "path": [ "template", "send" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"message\": \"The message has been successfully sent.\",\n \"data\": {\n \"key\": {\n \"remoteJid\": \"966500000000@s.whatsapp.net\",\n \"fromMe\": true,\n \"id\": \"wamid.HBgLMTIzNDU2Nzg5MBUTQ\"\n },\n \"messageTimestamp\": 1706900000,\n \"status\": \"PENDING\"\n }\n}" } ] }, { "name": "Send Simple Template (Body Only)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{phone}}\",\n \"template_name\": \"order_confirmation\",\n \"template_language\": \"ar\",\n \"components\": {\n \"body\": [\n \"أحمد\",\n \"ORD-12345\",\n \"150 ريال\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/template/simple", "host": [ "{{base_url}}" ], "path": [ "template", "simple" ] }, "description": "Send a simple template message with only body parameters.\n\nIdeal for templates that only contain text variables in the body section, such as order confirmations, appointment reminders, etc." }, "response": [] }, { "name": "Send Template with Image Header", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{phone}}\",\n \"template_name\": \"product_promotion\",\n \"template_language\": \"ar\",\n \"components\": {\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://example.com/product-image.jpg\"\n }\n },\n \"body\": [\n \"خصم 50%\",\n \"المنتج الجديد\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/template/image", "host": [ "{{base_url}}" ], "path": [ "template", "image" ] }, "description": "Send a template message with an image header.\n\nPerfect for promotional templates, product announcements, or any template that includes a visual image at the top." }, "response": [] }, { "name": "Send Template with Document Header", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{phone}}\",\n \"template_name\": \"invoice_template\",\n \"template_language\": \"ar\",\n \"components\": {\n \"header\": {\n \"type\": \"document\",\n \"document\": {\n \"link\": \"https://example.com/invoice.pdf\",\n \"filename\": \"فاتورة_12345.pdf\"\n }\n },\n \"body\": [\n \"ORD-12345\",\n \"500 ريال\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/template/document", "host": [ "{{base_url}}" ], "path": [ "template", "document" ] }, "description": "Send a template message with a document/PDF header.\n\nIdeal for sending invoices, contracts, receipts, or any template that includes a downloadable document." }, "response": [] }, { "name": "Send Template with Video Header", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"{{phone}}\",\n \"template_name\": \"course_preview\",\n \"template_language\": \"ar\",\n \"components\": {\n \"header\": {\n \"type\": \"video\",\n \"video\": {\n \"link\": \"https://example.com/course-preview.mp4\"\n }\n },\n \"body\": [\n \"دورة البرمجة\",\n \"30 يوم\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/template/video", "host": [ "{{base_url}}" ], "path": [ "template", "video" ] }, "description": "Send a template message with a video header.\n\nPerfect for course previews, product demonstrations, or any template that includes a video at the top." }, "response": [] } ] }, { "name": "Message Archive (read by date)", "description": "Read stored WhatsApp conversations by date, in both directions. Works for official (Cloud API) and QR channels. Outgoing replies can also be received in real time with a `message_notification` webhook (panel → API → Webhooks), which covers new messages only.", "item": [ { "name": "Get messages by date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/messages?date_from=2026-09-09&date_to=2026-09-09&timezone=Europe/Kyiv&from_me=1", "host": [ "{{base_url}}" ], "path": [ "messages" ], "query": [ { "key": "date_from", "value": "2026-09-09", "description": "Required. Start of the range. `YYYY-MM-DD` covers the whole day; a full ISO-8601 datetime (e.g. `2026-09-09T08:00:00+03:00`) is an exact, inclusive bound." }, { "key": "date_to", "value": "2026-09-09", "description": "Required. End of the range. `YYYY-MM-DD` covers the whole day (`date_from=date_to` is one full day); a full ISO-8601 datetime is an exact, inclusive bound. Must not be before `date_from`." }, { "key": "timezone", "value": "Europe/Kyiv", "description": "Optional, default `UTC`. IANA timezone used to read bare dates and to format every `message_date` (always returned with its offset)." }, { "key": "from_me", "value": "1", "description": "Optional. `1`/`true` = outgoing only, `0`/`false` = incoming only. Omit for both directions." }, { "key": "sent_by", "value": "live_chat", "description": "Optional. Only messages from this source: `live_chat`, `bot`, `api`, `mcp`, `send_bulk`, `zapier`, `salla`, `zid`, `woocommerce`, `shopify`, `hubspot`, `pipedrive`, `stripe`, `magento`, `agent`, `drip`, `cart`, `system`, `ai`. `ai` (an AI assistant reply) is written only for workspaces that enabled the AI/rule split; elsewhere AI replies are `bot`, so filter on both to get every bot reply.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. Only messages with this customer (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "channel_id", "value": "12", "description": "Optional. Only messages on this workspace channel — the `channel.id` a message or a webhook reports (one of your numbers). `422` when no channel with this id exists in the workspace.", "disabled": true }, { "key": "business_phone", "value": "966501234567", "description": "Optional. Only messages on your WhatsApp number with these digits, international format (`+`, spaces and dashes are ignored). `422` when none of the workspace's WhatsApp numbers matches. Sent together with `channel_id`, both must name the same number.", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. A `null` `next_cursor` means there are no more pages.", "disabled": true } ] }, "description": "Read the message archive by date — **incoming and outgoing**, including replies your team types in Live Chat.\n\n**Authentication:** `Authorization: Bearer {{lb_api_key}}` (the collection's bearer auth). The key is in the panel → API → Authentication data (visible to the account owner). Requires an active subscription with the API Access add-on (or an active trial). This is **not** the Zapier key (`lbz_...`).\n\n**Every number:** this endpoint reads the whole workspace, so one key returns the messages of **all** your numbers and channels. To read **one** number, add `channel_id` (the `channel.id` a message or webhook reports) or `business_phone` (that number's digits). WhatsApp messages record their number from 2026-09-30; older messages record it only where it could be attributed without guessing (a workspace with a single WhatsApp number), and a message that records no number is not returned under these filters.\n\n**Pagination:** results are ordered oldest first by `message_date`, then `id`. When `next_cursor` is not `null`, repeat the same request adding `cursor=` until it is `null`. Rows that share a timestamp are never skipped or repeated across pages.\n\n**Each message**\n- `from_me` — `true` for messages you sent, `false` for messages from the customer.\n- `sent_by` — where an outgoing message came from (`live_chat`, `bot`, `api`, ...); `null` for incoming.\n- `agent` — `{id, name}` of the team member who typed the message; `null` for automated and incoming messages. Use this, not `sent_by`, to identify human replies.\n- `contact` — `{id, phone, chat_id, name}` of the customer, or `null`.\n- `type` — `text`, `image`, `video`, `audio`, `file`, `template_text`, ...\n- `status` / `status_text` — the last status we recorded for the message (Pending, Sent, Delivered, Viewed, FAILED). It is not proof of delivery on every channel.\n- `message_date` — ISO-8601 with offset, in the requested `timezone`.\n- `channel_platform` — `whatsapp`, `messenger`, `instagram`, `email`, ...\n- `channel` — `{id, global_id, phone, platform, is_official}` of the workspace channel the message belongs to, when the message records it; `null` otherwise (never guessed). WhatsApp messages record their number from 2026-09-30.\n- `referral` — for an incoming message that started from a **Click-to-WhatsApp ad**, the ad it came from: `{source_type, ad_id, source_url, headline, body, media_type, media_url, ctwa_clid}`. `source_type` is always `ad`; `ad_id` is Meta's ad id (Meta calls it `source_id`); `media_type` is `image` or `video` and `media_url` its image, video or thumbnail URL; `ctwa_clid` is Meta's click id, for the Conversions API. Any field Meta did not send is `null`. `referral` is `null` for every other message, including everything you sent. Available on past messages too. Count leads per ad by grouping incoming messages on `referral.ad_id`.\n\nInternal notes, reactions, system lines and deleted messages are not returned.\n\n**Response-time analytics:** pair each incoming message with the next outgoing message for the same `contact.phone` whose `agent` is not `null`.\n\n**Errors:** `422` with `{\"Status\": false, \"Message\": \"...\"}` for invalid parameters (including a `channel_id` or `business_phone` that matches none of your channels, or the two naming different numbers); `401` for a missing or wrong key; `402` when the subscription or API add-on is not active.\n\n**Example**\n```\ncurl -G \"https://letsbot.net/api/v1/messages\" \\\n -H \"Authorization: Bearer YOUR_LB_API_KEY\" \\\n -H \"Accept: application/json\" \\\n --data-urlencode \"date_from=2026-09-09\" \\\n --data-urlencode \"date_to=2026-09-09\" \\\n --data-urlencode \"from_me=1\" \\\n --data-urlencode \"timezone=Europe/Kyiv\"\n```" }, "response": [ { "name": "200 — outgoing Live Chat replies for one day (Kyiv time)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/messages?date_from=2026-09-09&date_to=2026-09-09&timezone=Europe/Kyiv&from_me=1", "host": [ "{{base_url}}" ], "path": [ "messages" ], "query": [ { "key": "date_from", "value": "2026-09-09", "description": "Required. Start of the range. `YYYY-MM-DD` covers the whole day; a full ISO-8601 datetime (e.g. `2026-09-09T08:00:00+03:00`) is an exact, inclusive bound." }, { "key": "date_to", "value": "2026-09-09", "description": "Required. End of the range. `YYYY-MM-DD` covers the whole day (`date_from=date_to` is one full day); a full ISO-8601 datetime is an exact, inclusive bound. Must not be before `date_from`." }, { "key": "timezone", "value": "Europe/Kyiv", "description": "Optional, default `UTC`. IANA timezone used to read bare dates and to format every `message_date` (always returned with its offset)." }, { "key": "from_me", "value": "1", "description": "Optional. `1`/`true` = outgoing only, `0`/`false` = incoming only. Omit for both directions." }, { "key": "sent_by", "value": "live_chat", "description": "Optional. Only messages from this source: `live_chat`, `bot`, `api`, `mcp`, `send_bulk`, `zapier`, `salla`, `zid`, `woocommerce`, `shopify`, `hubspot`, `pipedrive`, `stripe`, `magento`, `agent`, `drip`, `cart`, `system`, `ai`. `ai` (an AI assistant reply) is written only for workspaces that enabled the AI/rule split; elsewhere AI replies are `bot`, so filter on both to get every bot reply.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. Only messages with this customer (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. A `null` `next_cursor` means there are no more pages.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Status\": true,\n \"timezone\": \"Europe/Kyiv\",\n \"data\": [\n {\n \"id\": 4812,\n \"message_id\": \"wamid.HBgMMzgwOTM1MDAwMDAxFQIAERgSN0Y0QjM2QjI5RjA1MDFEQjQ4AA==\",\n \"from_me\": true,\n \"sent_by\": \"live_chat\",\n \"agent\": {\n \"id\": 3,\n \"name\": \"Olena (Sales)\"\n },\n \"contact\": {\n \"id\": 127,\n \"phone\": \"380935000001\",\n \"chat_id\": \"380935000001@s.whatsapp.net\",\n \"name\": \"Customer name\"\n },\n \"group_id\": null,\n \"type\": \"text\",\n \"body\": \"Good afternoon! The 20 kg epoxy kit ships tomorrow.\",\n \"caption\": null,\n \"attachment\": null,\n \"status\": 3,\n \"status_text\": \"Viewed\",\n \"message_date\": \"2026-09-09T12:45:49+03:00\",\n \"channel_platform\": \"whatsapp\",\n \"channel\": null,\n \"referral\": null\n },\n {\n \"id\": 4815,\n \"message_id\": \"wamid.HBgMMzgwOTM1MDAwMDAxFQIAERgSQzE5RDA4NjM0MzhFRkY3M0Q1AA==\",\n \"from_me\": true,\n \"sent_by\": \"live_chat\",\n \"agent\": {\n \"id\": 3,\n \"name\": \"Olena (Sales)\"\n },\n \"contact\": {\n \"id\": 127,\n \"phone\": \"380935000001\",\n \"chat_id\": \"380935000001@s.whatsapp.net\",\n \"name\": \"Customer name\"\n },\n \"group_id\": null,\n \"type\": \"image\",\n \"body\": null,\n \"caption\": \"Colour sample\",\n \"attachment\": {\n \"url\": \"https://example.com/media/sample.jpg\",\n \"mimetype\": \"image/jpeg\"\n },\n \"status\": 2,\n \"status_text\": \"Delivered\",\n \"message_date\": \"2026-09-09T13:14:51+03:00\",\n \"channel_platform\": \"whatsapp\",\n \"channel\": null,\n \"referral\": null\n },\n {\n \"id\": 4816,\n \"message_id\": \"wamid.HBgMMzgwOTM1MDAwMDAyFQIAEhggQTFCMkMzRDRFNUY2QTdCOEM5RDBFMUYyQTNCNEM1RDYA\",\n \"from_me\": false,\n \"sent_by\": null,\n \"agent\": null,\n \"contact\": {\n \"id\": 128,\n \"phone\": \"966512345678\",\n \"chat_id\": \"966512345678@s.whatsapp.net\",\n \"name\": \"New lead\"\n },\n \"group_id\": null,\n \"type\": \"text\",\n \"body\": \"Hello! Is this kit still available?\",\n \"caption\": null,\n \"attachment\": null,\n \"status\": 2,\n \"status_text\": \"Delivered\",\n \"message_date\": \"2026-09-09T13:20:07+03:00\",\n \"channel_platform\": \"whatsapp\",\n \"channel\": null,\n \"referral\": {\n \"source_type\": \"ad\",\n \"ad_id\": \"120212345678900123\",\n \"source_url\": \"https://fb.me/3abcDEF\",\n \"headline\": \"Epoxy kit 20 kg\",\n \"body\": \"Message us on WhatsApp\",\n \"media_type\": \"image\",\n \"media_url\": \"https://scontent.xx.fbcdn.net/ad-image.jpg\",\n \"ctwa_clid\": \"ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO2E4Nx0\"\n }\n }\n ],\n \"next_cursor\": \"eyJkIjoiMjAyNi0wOS0wOSAxMzoyMDowNyIsImkiOjQ4MTZ9\"\n}" }, { "name": "422 — date_to before date_from", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/messages?date_from=2026-09-09&date_to=2026-09-08&timezone=Europe/Kyiv&from_me=1", "host": [ "{{base_url}}" ], "path": [ "messages" ], "query": [ { "key": "date_from", "value": "2026-09-09", "description": "Required. Start of the range. `YYYY-MM-DD` covers the whole day; a full ISO-8601 datetime (e.g. `2026-09-09T08:00:00+03:00`) is an exact, inclusive bound." }, { "key": "date_to", "value": "2026-09-08", "description": "Required. End of the range. `YYYY-MM-DD` covers the whole day (`date_from=date_to` is one full day); a full ISO-8601 datetime is an exact, inclusive bound. Must not be before `date_from`." }, { "key": "timezone", "value": "Europe/Kyiv", "description": "Optional, default `UTC`. IANA timezone used to read bare dates and to format every `message_date` (always returned with its offset)." }, { "key": "from_me", "value": "1", "description": "Optional. `1`/`true` = outgoing only, `0`/`false` = incoming only. Omit for both directions." }, { "key": "sent_by", "value": "live_chat", "description": "Optional. Only messages from this source: `live_chat`, `bot`, `api`, `mcp`, `send_bulk`, `zapier`, `salla`, `zid`, `woocommerce`, `shopify`, `hubspot`, `pipedrive`, `stripe`, `magento`, `agent`, `drip`, `cart`, `system`, `ai`. `ai` (an AI assistant reply) is written only for workspaces that enabled the AI/rule split; elsewhere AI replies are `bot`, so filter on both to get every bot reply.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. Only messages with this customer (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. A `null` `next_cursor` means there are no more pages.", "disabled": true } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Status\": false,\n \"Message\": \"The date to must not be before the date from.\",\n \"errors\": {}\n}" }, { "name": "422 — date_from missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/messages?date_to=2026-09-09&timezone=Europe/Kyiv&from_me=1", "host": [ "{{base_url}}" ], "path": [ "messages" ], "query": [ { "key": "date_from", "value": "2026-09-09", "description": "Required. Start of the range. `YYYY-MM-DD` covers the whole day; a full ISO-8601 datetime (e.g. `2026-09-09T08:00:00+03:00`) is an exact, inclusive bound.", "disabled": true }, { "key": "date_to", "value": "2026-09-09", "description": "Required. End of the range. `YYYY-MM-DD` covers the whole day (`date_from=date_to` is one full day); a full ISO-8601 datetime is an exact, inclusive bound. Must not be before `date_from`." }, { "key": "timezone", "value": "Europe/Kyiv", "description": "Optional, default `UTC`. IANA timezone used to read bare dates and to format every `message_date` (always returned with its offset)." }, { "key": "from_me", "value": "1", "description": "Optional. `1`/`true` = outgoing only, `0`/`false` = incoming only. Omit for both directions." }, { "key": "sent_by", "value": "live_chat", "description": "Optional. Only messages from this source: `live_chat`, `bot`, `api`, `mcp`, `send_bulk`, `zapier`, `salla`, `zid`, `woocommerce`, `shopify`, `hubspot`, `pipedrive`, `stripe`, `magento`, `agent`, `drip`, `cart`, `system`, `ai`. `ai` (an AI assistant reply) is written only for workspaces that enabled the AI/rule split; elsewhere AI replies are `bot`, so filter on both to get every bot reply.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. Only messages with this customer (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. A `null` `next_cursor` means there are no more pages.", "disabled": true } ] } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Status\": false,\n \"Message\": \"The date from field is required.\",\n \"errors\": {\n \"date_from\": [\n \"The date from field is required.\"\n ]\n }\n}" }, { "name": "401 — wrong or missing lb_api_key", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/messages?date_from=2026-09-09&date_to=2026-09-09&timezone=Europe/Kyiv&from_me=1", "host": [ "{{base_url}}" ], "path": [ "messages" ], "query": [ { "key": "date_from", "value": "2026-09-09", "description": "Required. Start of the range. `YYYY-MM-DD` covers the whole day; a full ISO-8601 datetime (e.g. `2026-09-09T08:00:00+03:00`) is an exact, inclusive bound." }, { "key": "date_to", "value": "2026-09-09", "description": "Required. End of the range. `YYYY-MM-DD` covers the whole day (`date_from=date_to` is one full day); a full ISO-8601 datetime is an exact, inclusive bound. Must not be before `date_from`." }, { "key": "timezone", "value": "Europe/Kyiv", "description": "Optional, default `UTC`. IANA timezone used to read bare dates and to format every `message_date` (always returned with its offset)." }, { "key": "from_me", "value": "1", "description": "Optional. `1`/`true` = outgoing only, `0`/`false` = incoming only. Omit for both directions." }, { "key": "sent_by", "value": "live_chat", "description": "Optional. Only messages from this source: `live_chat`, `bot`, `api`, `mcp`, `send_bulk`, `zapier`, `salla`, `zid`, `woocommerce`, `shopify`, `hubspot`, `pipedrive`, `stripe`, `magento`, `agent`, `drip`, `cart`, `system`, `ai`. `ai` (an AI assistant reply) is written only for workspaces that enabled the AI/rule split; elsewhere AI replies are `bot`, so filter on both to get every bot reply.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. Only messages with this customer (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. A `null` `next_cursor` means there are no more pages.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Status\": false,\n \"Message\": \"lb_api_key Incorrect\"\n}" }, { "name": "402 — API add-on not active", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{base_url}}/messages?date_from=2026-09-09&date_to=2026-09-09&timezone=Europe/Kyiv&from_me=1", "host": [ "{{base_url}}" ], "path": [ "messages" ], "query": [ { "key": "date_from", "value": "2026-09-09", "description": "Required. Start of the range. `YYYY-MM-DD` covers the whole day; a full ISO-8601 datetime (e.g. `2026-09-09T08:00:00+03:00`) is an exact, inclusive bound." }, { "key": "date_to", "value": "2026-09-09", "description": "Required. End of the range. `YYYY-MM-DD` covers the whole day (`date_from=date_to` is one full day); a full ISO-8601 datetime is an exact, inclusive bound. Must not be before `date_from`." }, { "key": "timezone", "value": "Europe/Kyiv", "description": "Optional, default `UTC`. IANA timezone used to read bare dates and to format every `message_date` (always returned with its offset)." }, { "key": "from_me", "value": "1", "description": "Optional. `1`/`true` = outgoing only, `0`/`false` = incoming only. Omit for both directions." }, { "key": "sent_by", "value": "live_chat", "description": "Optional. Only messages from this source: `live_chat`, `bot`, `api`, `mcp`, `send_bulk`, `zapier`, `salla`, `zid`, `woocommerce`, `shopify`, `hubspot`, `pipedrive`, `stripe`, `magento`, `agent`, `drip`, `cart`, `system`, `ai`. `ai` (an AI assistant reply) is written only for workspaces that enabled the AI/rule split; elsewhere AI replies are `bot`, so filter on both to get every bot reply.", "disabled": true }, { "key": "phone", "value": "{{phone}}", "description": "Optional. Only messages with this customer (international format, digits; a leading `+` is accepted).", "disabled": true }, { "key": "limit", "value": "50", "description": "Optional. Page size, default 50, maximum 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Optional. Pass `next_cursor` from the previous response, unchanged, to get the next page. A `null` `next_cursor` means there are no more pages.", "disabled": true } ] } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Status\": false,\n \"Message\": \"API access is not included in your current subscription. Please upgrade your plan or add the API addon.\",\n \"error_code\": \"API_ADDON_REQUIRED\"\n}" } ] } ] }, { "name": "Webhooks (event payloads)", "item": [], "description": "LetsBot calls your URL when something happens in your workspace. Add a webhook in the panel → **API → Webhooks** and choose its events. Webhooks are **workspace-wide**: one webhook receives the events of every number and channel of the workspace.\n\nEvery delivery is a `POST` with the JSON body `{\"event\": \"\", \"data\": {...}}` and a `Signature` header (HMAC-SHA256 of the body with your webhook's signing secret). Events: `message_notification`, `ack_notification`, `chat_notification`, `label_notifications`, `contact_notifications`, `order_notifications`.\n\n**Which of my numbers?** `message_notification` (incoming messages, messages you send from LetsBot, and replies typed in the WhatsApp Business App on a Coexistence number) and `ack_notification` (delivery / read receipts) carry a `channel` object:\n\n```\n\"channel\": {\n \"id\": 2,\n \"global_id\": \"8f0c2a4e-5b1d-4c3a-9e7f-0a1b2c3d4e5f\",\n \"phone\": \"966500000000\",\n \"platform\": \"whatsapp\",\n \"is_official\": true\n}\n```\n\n- `phone` — your business number, digits only (`null` for Messenger / Instagram and other non-phone channels).\n- `global_id` — the stable id of the channel; `id` — the channel id shown in the panel.\n- `is_official` — `true` on the official WhatsApp Cloud API, `false` on a QR (WhatsApp Web) number.\n- `channel` is `null` when the event does not identify its channel. It is never guessed.\n\n**Which ad brought this lead?** `message_notification` also carries `referral`. It is the Click-to-WhatsApp ad an incoming message came from, in the same shape as `referral` on `GET /messages`:\n\n```\n\"referral\": {\n \"source_type\": \"ad\",\n \"ad_id\": \"120212345678900123\",\n \"source_url\": \"https://fb.me/3abcDEF\",\n \"headline\": \"Epoxy kit 20 kg\",\n \"body\": \"Message us on WhatsApp\",\n \"media_type\": \"image\",\n \"media_url\": \"https://scontent.xx.fbcdn.net/ad-image.jpg\",\n \"ctwa_clid\": \"ARAkLkA8...\"\n}\n```\n\n`referral` is `null` on every message that did not come from an ad, including messages you send. Meta attaches it to the first message of a conversation started from the ad.\n\n`channel` was **added** on 2026-09-30 and `referral` on 2026-10-01; every other key of these payloads is unchanged. Ignore keys you do not know, so future additions never break your parser." }, { "name": "CRM", "description": "The CRM API reads and writes your LetsBot CRM: contacts, companies, deals and pipelines, tasks, activities, quotes and products, plus REST-hook webhooks for Zapier, Make and n8n. It is available once the workspace uses the CRM; until then every CRM path answers `404`.\n\n**Base URL:** your workspace's own domain, `https://{workspace}.letsbot.net/api/v1/crm` (the `crm_base_url` variable of this collection). It is not `https://letsbot.net/api/v1`.\n\n**Authentication — the `crm` scope.** Send a workspace API key in the `X-Zapier-Api-Key` header (the `crm_api_key` variable; this folder sets the header for you). Create the key in the panel under **Integrations → Zapier → API keys** and tick the **`crm`** scope. The scope must be listed explicitly: a key with no scopes (\"full access\") and legacy OAuth tokens are refused with `403` and `code: missing_scope`. The channel `lb_api_key` (Bearer) used by the other sections does not work here. A key acts for the whole workspace and sees every CRM record, whatever the team permissions are.\n\n**Responses.** Success: `{\"success\": true, \"data\": ..., \"meta\"?: {current_page, last_page, per_page, total}}`. Errors: `{\"success\": false, \"error\": \"\", \"code\": \"\", \"errors\"?: {field: [messages]}}` with `code` one of `not_found` (404), `missing_scope` (403), `validation_failed` (422), `already_exists` / `conflict` (409). A missing or unknown key answers `401`. `error` follows `Accept-Language` (`en`, `ar`, `es`, `pt`).\n\n**Rate limit:** 120 requests per minute per key (`429` with `Retry-After` when exceeded); subscribing webhooks is also limited to 30 per minute.\n\n**Webhooks and signature.** Subscribe with `POST /hooks` (or add a webhook in the panel under **CRM → API & webhooks**). Every delivery is a `POST` of `{\"id\", \"event\", \"object\", \"record_id\", \"occurred_at\", \"data\", \"changes\"?, \"previous\"?}` where `data` is the record in the same shape its GET returns, with these headers:\n\n- `X-LetsBot-Signature: t=,v1=`, where `v1` = HMAC-SHA256 of `.` with the subscription's signing secret (`whsec_…`, shown once).\n- `X-LetsBot-Event` — the event name, e.g. `deal.won`.\n- `X-LetsBot-Delivery` — the event id (also `id` in the body); use it to drop duplicates.\n\nTo verify: split the header on `,`, compute `hmac_sha256(secret, t + \".\" + rawBody)`, compare it with `v1` in constant time, and reject a `t` older than 5 minutes. Answer `2xx` to acknowledge. Failed deliveries are retried after 1 min, 5 min, 30 min, 2 h and 6 h; after 5 deliveries in a row fail the subscription is switched off, and an `HTTP 410` answer switches it off at once.\n\nEvents: `contact.created`, `contact.updated`, `contact.deleted`, `company.created`, `company.updated`, `company.deleted`, `deal.created`, `deal.updated`, `deal.deleted`, `deal.stage_changed`, `deal.won`, `deal.lost`, `task.created`, `task.completed`, `ticket.created`, `quote.sent`, `quote.viewed`, `quote.accepted`.", "item": [ { "name": "Contacts", "item": [ { "name": "List contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "Contacts through the CRM lists engine: search, filters, saved views, sort and pages. Scope: `crm`.\n\n**Response:** `data[]` = contacts, `meta` = `{current_page, last_page, per_page, total}`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle\": {\n \"id\": 2,\n \"name\": \"Lead\"\n },\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"company\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\"\n },\n \"tags\": [\n \"vip\"\n ],\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n },\n \"last_activity_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/contacts/42\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Key without the crm scope", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"This API key cannot use the CRM API. In LetsBot open Integrations → Zapier → API keys and create a key with the \\\"crm\\\" scope ticked.\",\n \"code\": \"missing_scope\"\n}" } ] }, { "name": "Contact fields, filters and sorts", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/schema", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", "schema" ] }, "description": "The lists-engine catalogue for contact lists: every field with its type, whether it can be filtered or sorted, its filter operators and options (for example the `lifecycle` stage ids). Scope: `crm`." }, "response": [ { "name": "Schema", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/schema", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", "schema" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"fields\": [\n {\n \"key\": \"name\",\n \"label\": \"Name\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"email\",\n \"label\": \"Email\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": false,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"lifecycle\",\n \"label\": \"Lifecycle stage\",\n \"type\": \"select\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"is\",\n \"is_not\"\n ],\n \"options\": [\n {\n \"value\": 1,\n \"label\": \"Subscriber\"\n },\n {\n \"value\": 2,\n \"label\": \"Lead\"\n },\n {\n \"value\": 3,\n \"label\": \"Customer\"\n }\n ]\n }\n ],\n \"sorts\": [\n \"name\",\n \"created_at\",\n \"last_activity_at\"\n ],\n \"default_sort\": {\n \"key\": \"last_activity_at\",\n \"dir\": \"desc\"\n }\n }\n}" } ] }, { "name": "Find contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/search", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", "search" ], "query": [ { "key": "phone", "value": "+966500000000", "description": "Phone in any format.", "disabled": true }, { "key": "email", "value": "ahmed@example.com", "description": "Exact e-mail.", "disabled": true }, { "key": "q", "value": "Ahmed", "description": "Free text.", "disabled": true } ] }, "description": "Exact lookup by `phone` (any format) or `email`, or free text `q`. Send one of the three. Up to 25 matches, newest first. Scope: `crm`." }, "response": [ { "name": "Matches", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/search", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", "search" ], "query": [ { "key": "phone", "value": "+966500000000", "description": "Phone in any format.", "disabled": true }, { "key": "email", "value": "ahmed@example.com", "description": "Exact e-mail.", "disabled": true }, { "key": "q", "value": "Ahmed", "description": "Free text.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle\": {\n \"id\": 2,\n \"name\": \"Lead\"\n },\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"company\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\"\n },\n \"tags\": [\n \"vip\"\n ],\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n },\n \"last_activity_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/contacts/42\"\n }\n ]\n}" } ] }, { "name": "Create a contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"+966500000000\",\n \"name\": \"Ahmed Ali\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle_stage_id\": 2,\n \"company_id\": 7,\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ] }, "description": "Creates a contact (WhatsApp customer) by phone. Scope: `crm`.\n\n**Required:** `phone` (international format). **Optional:** `name`, `email`, `city`, `country`, `owner_user_id`, `lifecycle_stage_id` (see …/schema), `company_id`, `custom_fields` (keyed by field key).\n\nA phone that already exists answers `409` with `code: already_exists` and that contact in `data`." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ] }, "body": { "mode": "raw", "raw": "{\n \"phone\": \"+966500000000\",\n \"name\": \"Ahmed Ali\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle_stage_id\": 2,\n \"company_id\": 7,\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle\": {\n \"id\": 2,\n \"name\": \"Lead\"\n },\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"company\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\"\n },\n \"tags\": [\n \"vip\"\n ],\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n },\n \"last_activity_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/contacts/42\"\n }\n}" }, { "name": "Phone already exists", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ] }, "body": { "mode": "raw", "raw": "{\n \"phone\": \"+966500000000\",\n \"name\": \"Ahmed Ali\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle_stage_id\": 2,\n \"company_id\": 7,\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A contact with this phone already exists.\",\n \"code\": \"already_exists\",\n \"data\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle\": {\n \"id\": 2,\n \"name\": \"Lead\"\n },\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"company\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\"\n },\n \"tags\": [\n \"vip\"\n ],\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n },\n \"last_activity_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/contacts/42\"\n }\n}" }, { "name": "Validation failed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "contacts" ] }, "body": { "mode": "raw", "raw": "{\n \"phone\": \"+966500000000\",\n \"name\": \"Ahmed Ali\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle_stage_id\": 2,\n \"company_id\": 7,\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"The phone field is required.\",\n \"code\": \"validation_failed\",\n \"errors\": {\n \"phone\": [\n \"The phone field is required.\"\n ]\n }\n}" } ] }, { "name": "Get a contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/:id", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] }, "description": "One contact. Scope: `crm`." }, "response": [ { "name": "Contact", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/:id", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle\": {\n \"id\": 2,\n \"name\": \"Lead\"\n },\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"company\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\"\n },\n \"tags\": [\n \"vip\"\n ],\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n },\n \"last_activity_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/contacts/42\"\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/contacts/:id", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] }, { "name": "Update a contact", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Ali\",\n \"lifecycle_stage_id\": 3,\n \"owner_user_id\": 3\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/contacts/:id", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] }, "description": "Only the fields sent change; same validation and audit as the panel. Same fields as *Create a contact* except `phone`. Scope: `crm`." }, "response": [ { "name": "Updated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/contacts/:id", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Ali\",\n \"lifecycle_stage_id\": 3,\n \"owner_user_id\": 3\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"email\": \"ahmed@example.com\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lifecycle\": {\n \"id\": 3,\n \"name\": \"Customer\"\n },\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"company\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\"\n },\n \"tags\": [\n \"vip\"\n ],\n \"custom_fields\": {\n \"source_campaign\": \"spring_sale\"\n },\n \"last_activity_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/contacts/42\"\n }\n}" } ] }, { "name": "Add a note to a contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"title\": \"Delivery request\",\n \"pinned\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/contacts/:id/notes", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id", "notes" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] }, "description": "Logs a note on the contact's CRM timeline. Scope: `crm`.\n\n**Body:** `body` (required, up to 10,000 characters), `title`, `occurred_at` (ISO 8601, default now), `pinned`." }, "response": [ { "name": "Note", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/contacts/:id/notes", "host": [ "{{crm_base_url}}" ], "path": [ "contacts", ":id", "notes" ], "variable": [ { "key": "id", "value": "42", "description": "The contact id." } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"title\": \"Delivery request\",\n \"pinned\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 88,\n \"subject_type\": \"contact\",\n \"subject_id\": 42,\n \"type\": \"note\",\n \"title\": \"Delivery request\",\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"details\": {},\n \"actor_user_id\": null,\n \"source\": \"api\",\n \"pinned\": false,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n}" } ] } ] }, { "name": "Companies", "item": [ { "name": "List companies", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies", "host": [ "{{crm_base_url}}" ], "path": [ "companies" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "Companies through the CRM lists engine (same query parameters as *List contacts*). Scope: `crm`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies", "host": [ "{{crm_base_url}}" ], "path": [ "companies" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"size_range\": \"11-50\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 1,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" } ] }, { "name": "Company fields, filters and sorts", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/schema", "host": [ "{{crm_base_url}}" ], "path": [ "companies", "schema" ] }, "description": "The lists-engine catalogue for company lists. Scope: `crm`." }, "response": [ { "name": "Schema", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/schema", "host": [ "{{crm_base_url}}" ], "path": [ "companies", "schema" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"fields\": [\n {\n \"key\": \"name\",\n \"label\": \"Name\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"email\",\n \"label\": \"Email\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": false,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"lifecycle\",\n \"label\": \"Lifecycle stage\",\n \"type\": \"select\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"is\",\n \"is_not\"\n ],\n \"options\": [\n {\n \"value\": 1,\n \"label\": \"Subscriber\"\n },\n {\n \"value\": 2,\n \"label\": \"Lead\"\n },\n {\n \"value\": 3,\n \"label\": \"Customer\"\n }\n ]\n }\n ],\n \"sorts\": [\n \"name\",\n \"created_at\",\n \"last_activity_at\"\n ],\n \"default_sort\": {\n \"key\": \"last_activity_at\",\n \"dir\": \"desc\"\n }\n }\n}" } ] }, { "name": "Find companies", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/search", "host": [ "{{crm_base_url}}" ], "path": [ "companies", "search" ], "query": [ { "key": "domain", "value": "example.com", "description": "Exact domain.", "disabled": true }, { "key": "name", "value": "Example Trading Co.", "description": "Exact name.", "disabled": true }, { "key": "q", "value": "Example", "description": "Free text.", "disabled": true } ] }, "description": "Exact lookup by `domain` or `name`, or free text `q`. Send one of the three. Up to 25 matches. Scope: `crm`." }, "response": [ { "name": "Matches", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/search", "host": [ "{{crm_base_url}}" ], "path": [ "companies", "search" ], "query": [ { "key": "domain", "value": "example.com", "description": "Exact domain.", "disabled": true }, { "key": "name", "value": "Example Trading Co.", "description": "Exact name.", "disabled": true }, { "key": "q", "value": "Example", "description": "Free text.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"size_range\": \"11-50\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 1,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\"\n }\n ]\n}" } ] }, { "name": "Create a company", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"phone\": \"+966512345678\",\n \"email\": \"info@example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/companies", "host": [ "{{crm_base_url}}" ], "path": [ "companies" ] }, "description": "Creates a company (account). Scope: `crm`.\n\n**Required:** `name`. **Optional:** `domain`, `industry`, `size_range`, `phone`, `email`, `website`, `country` (ISO 3166 alpha-2), `city`, `address`, `owner_user_id`, `lifecycle`." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/companies", "host": [ "{{crm_base_url}}" ], "path": [ "companies" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"phone\": \"+966512345678\",\n \"email\": \"info@example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"size_range\": \"11-50\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 0,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\",\n \"contacts\": [],\n \"deals_count\": 0,\n \"tickets_count\": 0\n }\n}" } ] }, { "name": "Get a company", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "description": "One company with its linked contacts. Scope: `crm`." }, "response": [ { "name": "Company", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"size_range\": \"11-50\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 1,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\",\n \"contacts\": [\n {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"role\": \"Purchasing manager\",\n \"is_primary\": true\n }\n ],\n \"deals_count\": 2,\n \"tickets_count\": 0\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] }, { "name": "Update a company", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"industry\": \"Wholesale\",\n \"size_range\": \"51-200\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "description": "Only the fields sent change. Scope: `crm`." }, "response": [ { "name": "Updated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "body": { "mode": "raw", "raw": "{\n \"industry\": \"Wholesale\",\n \"size_range\": \"51-200\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Wholesale\",\n \"size_range\": \"51-200\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 1,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\",\n \"contacts\": [\n {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"role\": \"Purchasing manager\",\n \"is_primary\": true\n }\n ],\n \"deals_count\": 2,\n \"tickets_count\": 0\n }\n}" } ] }, { "name": "Delete a company", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "description": "Soft-deletes the company (it can be restored in the panel). Scope: `crm`." }, "response": [ { "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 7,\n \"deleted\": true\n }\n}" } ] }, { "name": "Link a contact to a company", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_id\": 42,\n \"role\": \"Purchasing manager\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/companies/:id/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id", "contacts" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "description": "Associates a contact with the company, optionally as its primary contact. Scope: `crm`.\n\n**Required:** `contact_id`. **Optional:** `role` (up to 100 characters), `is_primary`." }, "response": [ { "name": "Linked", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/companies/:id/contacts", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id", "contacts" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "body": { "mode": "raw", "raw": "{\n \"contact_id\": 42,\n \"role\": \"Purchasing manager\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"size_range\": \"11-50\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 1,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\",\n \"contacts\": [\n {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\",\n \"role\": \"Purchasing manager\",\n \"is_primary\": true\n }\n ],\n \"deals_count\": 2,\n \"tickets_count\": 0\n }\n}" } ] }, { "name": "Unlink a contact from a company", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id/contacts/:contactId", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id", "contacts", ":contactId" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." }, { "key": "contactId", "value": "42", "description": "The contact id." } ] }, "description": "Removes the association; the contact itself stays. Scope: `crm`." }, "response": [ { "name": "Unlinked", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/companies/:id/contacts/:contactId", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id", "contacts", ":contactId" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." }, { "key": "contactId", "value": "42", "description": "The contact id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 7,\n \"name\": \"Example Trading Co.\",\n \"domain\": \"example.com\",\n \"industry\": \"Retail\",\n \"size_range\": \"11-50\",\n \"phone\": \"966512345678\",\n \"email\": \"info@example.com\",\n \"website\": \"https://example.com\",\n \"country\": \"SA\",\n \"city\": \"Riyadh\",\n \"address\": \"King Fahd Road\",\n \"lifecycle\": \"customer\",\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contacts_count\": 0,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-01T12:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/companies/7\",\n \"contacts\": [],\n \"deals_count\": 2,\n \"tickets_count\": 0\n }\n}" } ] }, { "name": "Add a note to a company", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"title\": \"Delivery request\",\n \"pinned\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/companies/:id/notes", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id", "notes" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "description": "Logs a note on the company's CRM timeline. Scope: `crm`.\n\n**Body:** `body` (required, up to 10,000 characters), `title`, `occurred_at` (ISO 8601, default now), `pinned`." }, "response": [ { "name": "Note", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/companies/:id/notes", "host": [ "{{crm_base_url}}" ], "path": [ "companies", ":id", "notes" ], "variable": [ { "key": "id", "value": "7", "description": "The company id." } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"title\": \"Delivery request\",\n \"pinned\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 88,\n \"subject_type\": \"company\",\n \"subject_id\": 7,\n \"type\": \"note\",\n \"title\": \"Delivery request\",\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"details\": {},\n \"actor_user_id\": null,\n \"source\": \"api\",\n \"pinned\": false,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n}" } ] } ] }, { "name": "Deals", "item": [ { "name": "List pipelines and stages", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/pipelines", "host": [ "{{crm_base_url}}" ], "path": [ "pipelines" ] }, "description": "Every sales pipeline with its stages. A stage's `kind` is `open`, `won` or `lost`. Scope: `crm`." }, "response": [ { "name": "Pipelines", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/pipelines", "host": [ "{{crm_base_url}}" ], "path": [ "pipelines" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Sales\",\n \"currency\": \"SAR\",\n \"is_default\": true,\n \"stages\": [\n {\n \"id\": 11,\n \"name\": \"New\",\n \"kind\": \"open\",\n \"position\": 1,\n \"probability\": 10\n },\n {\n \"id\": 12,\n \"name\": \"Proposal sent\",\n \"kind\": \"open\",\n \"position\": 2,\n \"probability\": 50\n },\n {\n \"id\": 13,\n \"name\": \"Won\",\n \"kind\": \"won\",\n \"position\": 3,\n \"probability\": 100\n },\n {\n \"id\": 14,\n \"name\": \"Lost\",\n \"kind\": \"lost\",\n \"position\": 4,\n \"probability\": 0\n }\n ]\n }\n ]\n}" } ] }, { "name": "List deals", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals", "host": [ "{{crm_base_url}}" ], "path": [ "deals" ], "query": [ { "key": "pipeline_id", "value": "1", "description": "Pipeline id.", "disabled": true }, { "key": "stage_id", "value": "12", "description": "Stage id.", "disabled": true }, { "key": "status", "value": "open", "description": "`open`, `won` or `lost`.", "disabled": true }, { "key": "owner_user_id", "value": "3", "description": "Owner (team member) id.", "disabled": true }, { "key": "contact_id", "value": "42", "description": "Contact id.", "disabled": true }, { "key": "company_id", "value": "7", "description": "Company id.", "disabled": true }, { "key": "q", "value": "epoxy", "description": "Free text.", "disabled": true }, { "key": "sort", "value": "updated_at", "description": "Sort key.", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "updated_since", "value": "2026-10-01T00:00:00Z", "description": "Only deals updated at or after this time (ISO 8601) — for incremental sync.", "disabled": true }, { "key": "created_since", "value": "2026-10-01T00:00:00Z", "description": "Only deals created at or after this time (ISO 8601).", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "Deals, newest activity first by default. Scope: `crm`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals", "host": [ "{{crm_base_url}}" ], "path": [ "deals" ], "query": [ { "key": "pipeline_id", "value": "1", "description": "Pipeline id.", "disabled": true }, { "key": "stage_id", "value": "12", "description": "Stage id.", "disabled": true }, { "key": "status", "value": "open", "description": "`open`, `won` or `lost`.", "disabled": true }, { "key": "owner_user_id", "value": "3", "description": "Owner (team member) id.", "disabled": true }, { "key": "contact_id", "value": "42", "description": "Contact id.", "disabled": true }, { "key": "company_id", "value": "7", "description": "Company id.", "disabled": true }, { "key": "q", "value": "epoxy", "description": "Free text.", "disabled": true }, { "key": "sort", "value": "updated_at", "description": "Sort key.", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "updated_since", "value": "2026-10-01T00:00:00Z", "description": "Only deals updated at or after this time (ISO 8601) — for incremental sync.", "disabled": true }, { "key": "created_since", "value": "2026-10-01T00:00:00Z", "description": "Only deals created at or after this time (ISO 8601).", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 12,\n \"name\": \"Proposal sent\"\n },\n \"status\": \"open\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": null,\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" } ] }, { "name": "List lost reasons", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/lost-reasons", "host": [ "{{crm_base_url}}" ], "path": [ "deals", "lost-reasons" ] }, "description": "The active lost reasons. Marking a deal lost needs one. Scope: `crm`." }, "response": [ { "name": "Reasons", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/lost-reasons", "host": [ "{{crm_base_url}}" ], "path": [ "deals", "lost-reasons" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"No budget\"\n },\n {\n \"id\": 2,\n \"name\": \"Chose a competitor\"\n }\n ]\n}" } ] }, { "name": "Find deals", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/search", "host": [ "{{crm_base_url}}" ], "path": [ "deals", "search" ], "query": [ { "key": "title", "value": "Epoxy kit order — 40 units", "description": "Exact title.", "disabled": true }, { "key": "q", "value": "epoxy", "description": "Free text.", "disabled": true }, { "key": "contact_id", "value": "42", "description": "Contact id.", "disabled": true } ] }, "description": "By exact `title`, free text `q` or `contact_id`. Send one of the three. Up to 25 matches. Scope: `crm`." }, "response": [ { "name": "Matches", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/search", "host": [ "{{crm_base_url}}" ], "path": [ "deals", "search" ], "query": [ { "key": "title", "value": "Epoxy kit order — 40 units", "description": "Exact title.", "disabled": true }, { "key": "q", "value": "epoxy", "description": "Free text.", "disabled": true }, { "key": "contact_id", "value": "42", "description": "Contact id.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 12,\n \"name\": \"Proposal sent\"\n },\n \"status\": \"open\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": null,\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n ]\n}" } ] }, { "name": "Create a deal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Epoxy kit order — 40 units\",\n \"pipeline_id\": 1,\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"contact_id\": 42,\n \"company_id\": 7,\n \"expected_close_date\": \"2026-10-31\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/deals", "host": [ "{{crm_base_url}}" ], "path": [ "deals" ] }, "description": "Creates a deal. Without `stage_id` it starts in the first open stage of `pipeline_id` (the default pipeline when omitted). Scope: `crm`.\n\n**Required:** `title`. **Optional:** `pipeline_id`, `stage_id` (see *List pipelines and stages*), `amount`, `currency` (3 letters), `contact_id`, `company_id`, `owner_user_id`, `expected_close_date` (YYYY-MM-DD)." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/deals", "host": [ "{{crm_base_url}}" ], "path": [ "deals" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Epoxy kit order — 40 units\",\n \"pipeline_id\": 1,\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"contact_id\": 42,\n \"company_id\": 7,\n \"expected_close_date\": \"2026-10-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 11,\n \"name\": \"New\"\n },\n \"status\": \"open\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": null,\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n}" }, { "name": "Validation failed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/deals", "host": [ "{{crm_base_url}}" ], "path": [ "deals" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Epoxy kit order — 40 units\",\n \"pipeline_id\": 1,\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"contact_id\": 42,\n \"company_id\": 7,\n \"expected_close_date\": \"2026-10-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"The title field is required.\",\n \"code\": \"validation_failed\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}" } ] }, { "name": "Get a deal", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "One deal. Scope: `crm`." }, "response": [ { "name": "Deal", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 12,\n \"name\": \"Proposal sent\"\n },\n \"status\": \"open\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": null,\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] }, { "name": "Update a deal", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 13500,\n \"expected_close_date\": \"2026-11-05\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "Only the fields sent change (`title`, `pipeline_id`, `stage_id` (see *List pipelines and stages*), `amount`, `currency` (3 letters), `contact_id`, `company_id`, `owner_user_id`, `expected_close_date` (YYYY-MM-DD)). A `stage_id` of a won or lost stage wins or loses the deal; lost also needs `lost_reason_id` (and optionally `lost_note`). Scope: `crm`." }, "response": [ { "name": "Updated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 13500,\n \"expected_close_date\": \"2026-11-05\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 13500,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 12,\n \"name\": \"Proposal sent\"\n },\n \"status\": \"open\",\n \"expected_close_date\": \"2026-11-05\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": null,\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n}" } ] }, { "name": "Delete a deal", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "Soft-deletes the deal. Scope: `crm`." }, "response": [ { "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"deleted\": true\n }\n}" } ] }, { "name": "Move a deal to a stage", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"stage_id\": 12\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/deals/:id/stage", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "stage" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "Moves the deal to another stage of its own pipeline. Fires `deal.stage_changed` (and `deal.won` / `deal.lost` for a won or lost stage). Scope: `crm`.\n\n**Required:** `stage_id`. **Lost stage:** also `lost_reason_id`, optional `lost_note`." }, "response": [ { "name": "Moved", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/deals/:id/stage", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "stage" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "body": { "mode": "raw", "raw": "{\n \"stage_id\": 12\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 12,\n \"name\": \"Proposal sent\"\n },\n \"status\": \"open\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": null,\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n}" } ] }, { "name": "Mark a deal won", "request": { "method": "POST", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id/won", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "won" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "Moves the deal to its pipeline's won stage. Scope: `crm`." }, "response": [ { "name": "Won", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{crm_base_url}}/deals/:id/won", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "won" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 13,\n \"name\": \"Won\"\n },\n \"status\": \"won\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": \"2026-10-08T09:30:00+03:00\",\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n}" } ] }, { "name": "Mark a deal lost", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lost_reason_id\": 2,\n \"note\": \"Chose a cheaper supplier.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/deals/:id/lost", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "lost" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "Moves the deal to its pipeline's lost stage. Scope: `crm`.\n\n**Required:** `lost_reason_id` (see *List lost reasons*). **Optional:** `note` (up to 500 characters)." }, "response": [ { "name": "Lost", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/deals/:id/lost", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "lost" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "body": { "mode": "raw", "raw": "{\n \"lost_reason_id\": 2,\n \"note\": \"Chose a cheaper supplier.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 14,\n \"name\": \"Lost\"\n },\n \"status\": \"lost\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": 2,\n \"lost_note\": \"Chose a cheaper supplier.\",\n \"won_at\": null,\n \"lost_at\": \"2026-10-08T09:30:00+03:00\",\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n }\n}" } ] }, { "name": "Add a note to a deal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"title\": \"Delivery request\",\n \"pinned\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/deals/:id/notes", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "notes" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "description": "Logs a note on the deal's CRM timeline. Scope: `crm`.\n\n**Body:** `body` (required, up to 10,000 characters), `title`, `occurred_at` (ISO 8601, default now), `pinned`." }, "response": [ { "name": "Note", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/deals/:id/notes", "host": [ "{{crm_base_url}}" ], "path": [ "deals", ":id", "notes" ], "variable": [ { "key": "id", "value": "15", "description": "The deal id." } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"title\": \"Delivery request\",\n \"pinned\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 88,\n \"subject_type\": \"deal\",\n \"subject_id\": 15,\n \"type\": \"note\",\n \"title\": \"Delivery request\",\n \"body\": \"Customer asked for a delivery date before the end of the month.\",\n \"details\": {},\n \"actor_user_id\": null,\n \"source\": \"api\",\n \"pinned\": false,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n}" } ] } ] }, { "name": "Tasks", "item": [ { "name": "List tasks", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/tasks", "host": [ "{{crm_base_url}}" ], "path": [ "tasks" ], "query": [ { "key": "status", "value": "todo", "description": "`todo`, `in_progress` or `done`.", "disabled": true }, { "key": "assignee_user_id", "value": "3", "description": "Assignee (team member) id.", "disabled": true }, { "key": "contact_id", "value": "42", "description": "Contact id.", "disabled": true }, { "key": "deal_id", "value": "15", "description": "Deal id.", "disabled": true }, { "key": "due_before", "value": "2026-10-15T00:00:00Z", "description": "Due before this time (ISO 8601).", "disabled": true }, { "key": "due_after", "value": "2026-10-01T00:00:00Z", "description": "Due after this time (ISO 8601).", "disabled": true }, { "key": "q", "value": "call", "description": "Free text.", "disabled": true }, { "key": "sort", "value": "due_at", "description": "Sort key.", "disabled": true }, { "key": "dir", "value": "asc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "updated_since", "value": "2026-10-01T00:00:00Z", "description": "Only tasks updated at or after this time.", "disabled": true }, { "key": "created_since", "value": "2026-10-01T00:00:00Z", "description": "Only tasks created at or after this time.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "Tasks, newest activity first by default. Scope: `crm`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/tasks", "host": [ "{{crm_base_url}}" ], "path": [ "tasks" ], "query": [ { "key": "status", "value": "todo", "description": "`todo`, `in_progress` or `done`.", "disabled": true }, { "key": "assignee_user_id", "value": "3", "description": "Assignee (team member) id.", "disabled": true }, { "key": "contact_id", "value": "42", "description": "Contact id.", "disabled": true }, { "key": "deal_id", "value": "15", "description": "Deal id.", "disabled": true }, { "key": "due_before", "value": "2026-10-15T00:00:00Z", "description": "Due before this time (ISO 8601).", "disabled": true }, { "key": "due_after", "value": "2026-10-01T00:00:00Z", "description": "Due after this time (ISO 8601).", "disabled": true }, { "key": "q", "value": "call", "description": "Free text.", "disabled": true }, { "key": "sort", "value": "due_at", "description": "Sort key.", "disabled": true }, { "key": "dir", "value": "asc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "updated_since", "value": "2026-10-01T00:00:00Z", "description": "Only tasks updated at or after this time.", "disabled": true }, { "key": "created_since", "value": "2026-10-01T00:00:00Z", "description": "Only tasks created at or after this time.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 31,\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"status\": \"todo\",\n \"priority\": \"high\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"overdue\": false,\n \"assignee\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"deal\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\"\n },\n \"recurrence\": null,\n \"completed_at\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/tasks?task=31\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" } ] }, { "name": "Create a task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"priority\": \"high\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"assignee_user_id\": 3,\n \"contact_id\": 42,\n \"deal_id\": 15\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/tasks", "host": [ "{{crm_base_url}}" ], "path": [ "tasks" ] }, "description": "Creates a task. Scope: `crm`.\n\n**Required:** `title`. **Optional:** `description`, `status` (`todo`, `in_progress`, `done`), `priority` (`low`, `normal`, `high`, `urgent`), `due_at`, `remind_at` (ISO 8601), `assignee_user_id`, `contact_id`, `deal_id`, `recurrence` (`daily`, `weekly`, `monthly`; needs `due_at`)." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/tasks", "host": [ "{{crm_base_url}}" ], "path": [ "tasks" ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"priority\": \"high\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"assignee_user_id\": 3,\n \"contact_id\": 42,\n \"deal_id\": 15\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 31,\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"status\": \"todo\",\n \"priority\": \"high\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"overdue\": false,\n \"assignee\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"deal\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\"\n },\n \"recurrence\": null,\n \"completed_at\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/tasks?task=31\"\n }\n}" } ] }, { "name": "Get a task", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] }, "description": "One task. Scope: `crm`." }, "response": [ { "name": "Task", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 31,\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"status\": \"todo\",\n \"priority\": \"high\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"overdue\": false,\n \"assignee\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"deal\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\"\n },\n \"recurrence\": null,\n \"completed_at\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/tasks?task=31\"\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] }, { "name": "Update a task", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"in_progress\",\n \"priority\": \"urgent\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] }, "description": "Only the fields sent change (`title`, `description`, `status` (`todo`, `in_progress`, `done`), `priority` (`low`, `normal`, `high`, `urgent`), `due_at`, `remind_at` (ISO 8601), `assignee_user_id`, `contact_id`, `deal_id`, `recurrence` (`daily`, `weekly`, `monthly`; needs `due_at`)). Scope: `crm`." }, "response": [ { "name": "Updated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"in_progress\",\n \"priority\": \"urgent\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 31,\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"status\": \"in_progress\",\n \"priority\": \"urgent\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"overdue\": false,\n \"assignee\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"deal\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\"\n },\n \"recurrence\": null,\n \"completed_at\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/tasks?task=31\"\n }\n}" } ] }, { "name": "Delete a task", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] }, "description": "Deletes the task. Scope: `crm`." }, "response": [ { "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 31,\n \"deleted\": true\n }\n}" } ] }, { "name": "Complete a task", "request": { "method": "POST", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id/complete", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id", "complete" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] }, "description": "Marks the task done and fires `task.completed`. Scope: `crm`." }, "response": [ { "name": "Completed", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{crm_base_url}}/tasks/:id/complete", "host": [ "{{crm_base_url}}" ], "path": [ "tasks", ":id", "complete" ], "variable": [ { "key": "id", "value": "31", "description": "The task id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 31,\n \"title\": \"Call back about the quote\",\n \"description\": \"Confirm delivery date.\",\n \"status\": \"done\",\n \"priority\": \"high\",\n \"due_at\": \"2026-10-10T11:00:00+03:00\",\n \"remind_at\": \"2026-10-10T10:30:00+03:00\",\n \"overdue\": false,\n \"assignee\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"deal\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\"\n },\n \"recurrence\": null,\n \"completed_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/tasks?task=31\"\n }\n}" } ] } ] }, { "name": "Activities", "item": [ { "name": "List activities", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/activities", "host": [ "{{crm_base_url}}" ], "path": [ "activities" ], "query": [ { "key": "subject_type", "value": "contact", "description": "`contact`, `company` or `deal`.", "disabled": true }, { "key": "subject_id", "value": "42", "description": "The subject's id (with `subject_type`).", "disabled": true }, { "key": "type", "value": "note", "description": "Activity type, e.g. `note`, `call`, `meeting`.", "disabled": true }, { "key": "updated_since", "value": "2026-10-01T00:00:00Z", "description": "Only entries updated at or after this time.", "disabled": true }, { "key": "created_since", "value": "2026-10-01T00:00:00Z", "description": "Only entries created at or after this time.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "Timeline entries of contacts, companies and deals, newest first. Scope: `crm`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/activities", "host": [ "{{crm_base_url}}" ], "path": [ "activities" ], "query": [ { "key": "subject_type", "value": "contact", "description": "`contact`, `company` or `deal`.", "disabled": true }, { "key": "subject_id", "value": "42", "description": "The subject's id (with `subject_type`).", "disabled": true }, { "key": "type", "value": "note", "description": "Activity type, e.g. `note`, `call`, `meeting`.", "disabled": true }, { "key": "updated_since", "value": "2026-10-01T00:00:00Z", "description": "Only entries updated at or after this time.", "disabled": true }, { "key": "created_since", "value": "2026-10-01T00:00:00Z", "description": "Only entries created at or after this time.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 88,\n \"subject_type\": \"contact\",\n \"subject_id\": 42,\n \"type\": \"note\",\n \"title\": \"Requirements\",\n \"body\": \"Needs delivery before the end of the month.\",\n \"details\": {},\n \"actor_user_id\": null,\n \"source\": \"api\",\n \"pinned\": false,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" } ] }, { "name": "Log an activity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject_type\": \"contact\",\n \"subject_id\": 42,\n \"type\": \"call\",\n \"title\": \"Follow-up call\",\n \"body\": \"Agreed on the delivery date.\",\n \"direction\": \"outbound\",\n \"outcome\": \"connected\",\n \"duration_minutes\": 6\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/activities", "host": [ "{{crm_base_url}}" ], "path": [ "activities" ] }, "description": "Logs a note, call or meeting on a contact, company or deal. Scope: `crm`.\n\n**Required:** `subject_type` (`contact`, `company`, `deal`), `subject_id`, `type` (`note`, `call`, `meeting`). `body` is required for a note; `direction` (`inbound`, `outbound`) for a call. **Optional:** `title`, `occurred_at`, `pinned`, `outcome` (`connected`, `no_answer`, `busy`, `voicemail`, `wrong_number`), `duration_minutes`, `location`." }, "response": [ { "name": "Logged", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/activities", "host": [ "{{crm_base_url}}" ], "path": [ "activities" ] }, "body": { "mode": "raw", "raw": "{\n \"subject_type\": \"contact\",\n \"subject_id\": 42,\n \"type\": \"call\",\n \"title\": \"Follow-up call\",\n \"body\": \"Agreed on the delivery date.\",\n \"direction\": \"outbound\",\n \"outcome\": \"connected\",\n \"duration_minutes\": 6\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 89,\n \"subject_type\": \"contact\",\n \"subject_id\": 42,\n \"type\": \"call\",\n \"title\": \"Follow-up call\",\n \"body\": \"Agreed on the delivery date.\",\n \"details\": {\n \"direction\": \"outbound\",\n \"outcome\": \"connected\",\n \"duration_minutes\": 6\n },\n \"actor_user_id\": null,\n \"source\": \"api\",\n \"pinned\": false,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n}" } ] }, { "name": "Get an activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/activities/:id", "host": [ "{{crm_base_url}}" ], "path": [ "activities", ":id" ], "variable": [ { "key": "id", "value": "88", "description": "The activity id." } ] }, "description": "One timeline entry. Scope: `crm`." }, "response": [ { "name": "Activity", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/activities/:id", "host": [ "{{crm_base_url}}" ], "path": [ "activities", ":id" ], "variable": [ { "key": "id", "value": "88", "description": "The activity id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 88,\n \"subject_type\": \"contact\",\n \"subject_id\": 42,\n \"type\": \"note\",\n \"title\": \"Requirements\",\n \"body\": \"Needs delivery before the end of the month.\",\n \"details\": {},\n \"actor_user_id\": null,\n \"source\": \"api\",\n \"pinned\": false,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/activities/:id", "host": [ "{{crm_base_url}}" ], "path": [ "activities", ":id" ], "variable": [ { "key": "id", "value": "88", "description": "The activity id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] } ] }, { "name": "Quotes", "item": [ { "name": "List quotes", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes", "host": [ "{{crm_base_url}}" ], "path": [ "quotes" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "Quotes through the CRM lists engine (same query parameters as *List contacts*). Scope: `crm`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes", "host": [ "{{crm_base_url}}" ], "path": [ "quotes" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 5,\n \"number\": \"Q-2026-0005\",\n \"status\": \"draft\",\n \"currency\": \"SAR\",\n \"subtotal\": 12000,\n \"discount_total\": 600,\n \"tax_total\": 1710,\n \"total\": 13110,\n \"issue_date\": \"2026-10-08\",\n \"valid_until\": \"2026-10-22\",\n \"deal_id\": 15,\n \"contact_id\": 42,\n \"company_id\": 7,\n \"owner_user_id\": 3,\n \"locale\": \"en\",\n \"terms\": \"Payment within 14 days.\",\n \"notes\": null,\n \"buyer\": {\n \"name\": \"Example Trading Co.\",\n \"email\": \"info@example.com\"\n },\n \"items\": [\n {\n \"id\": 9,\n \"product_id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"description\": null,\n \"qty\": 40,\n \"unit_price\": 300,\n \"discount_pct\": 5,\n \"tax_pct\": 15,\n \"total\": 13110\n }\n ],\n \"view_count\": 0,\n \"sent_at\": null,\n \"sent_via\": null,\n \"first_viewed_at\": null,\n \"last_viewed_at\": null,\n \"accepted_at\": null,\n \"declined_at\": null,\n \"public_url\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/quotes/5\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" } ] }, { "name": "Quote fields, filters and sorts", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/schema", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", "schema" ] }, "description": "The lists-engine catalogue for quote lists. Scope: `crm`." }, "response": [ { "name": "Schema", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/schema", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", "schema" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"fields\": [\n {\n \"key\": \"name\",\n \"label\": \"Name\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"email\",\n \"label\": \"Email\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": false,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"lifecycle\",\n \"label\": \"Lifecycle stage\",\n \"type\": \"select\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"is\",\n \"is_not\"\n ],\n \"options\": [\n {\n \"value\": 1,\n \"label\": \"Subscriber\"\n },\n {\n \"value\": 2,\n \"label\": \"Lead\"\n },\n {\n \"value\": 3,\n \"label\": \"Customer\"\n }\n ]\n }\n ],\n \"sorts\": [\n \"name\",\n \"created_at\",\n \"last_activity_at\"\n ],\n \"default_sort\": {\n \"key\": \"last_activity_at\",\n \"dir\": \"desc\"\n }\n }\n}" } ] }, { "name": "Draft a quote", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deal_id\": 15,\n \"contact_id\": 42,\n \"company_id\": 7,\n \"currency\": \"SAR\",\n \"locale\": \"en\",\n \"valid_until\": \"2026-10-22\",\n \"terms\": \"Payment within 14 days.\",\n \"items\": [\n {\n \"product_id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"qty\": 40,\n \"unit_price\": 300,\n \"discount_pct\": 5,\n \"tax_pct\": 15\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/quotes", "host": [ "{{crm_base_url}}" ], "path": [ "quotes" ] }, "description": "Creates a draft quote. Sending it to the customer happens in the panel. Scope: `crm`.\n\n**Fields:** `deal_id`, `contact_id`, `company_id`, `currency`, `locale` (`ar`, `en`), `valid_until` (YYYY-MM-DD), `terms`, `notes`, `items[]` = `{product_id, name, description, qty, unit_price, discount_pct, tax_pct}`." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/quotes", "host": [ "{{crm_base_url}}" ], "path": [ "quotes" ] }, "body": { "mode": "raw", "raw": "{\n \"deal_id\": 15,\n \"contact_id\": 42,\n \"company_id\": 7,\n \"currency\": \"SAR\",\n \"locale\": \"en\",\n \"valid_until\": \"2026-10-22\",\n \"terms\": \"Payment within 14 days.\",\n \"items\": [\n {\n \"product_id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"qty\": 40,\n \"unit_price\": 300,\n \"discount_pct\": 5,\n \"tax_pct\": 15\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 5,\n \"number\": \"Q-2026-0005\",\n \"status\": \"draft\",\n \"currency\": \"SAR\",\n \"subtotal\": 12000,\n \"discount_total\": 600,\n \"tax_total\": 1710,\n \"total\": 13110,\n \"issue_date\": \"2026-10-08\",\n \"valid_until\": \"2026-10-22\",\n \"deal_id\": 15,\n \"contact_id\": 42,\n \"company_id\": 7,\n \"owner_user_id\": 3,\n \"locale\": \"en\",\n \"terms\": \"Payment within 14 days.\",\n \"notes\": null,\n \"buyer\": {\n \"name\": \"Example Trading Co.\",\n \"email\": \"info@example.com\"\n },\n \"items\": [\n {\n \"id\": 9,\n \"product_id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"description\": null,\n \"qty\": 40,\n \"unit_price\": 300,\n \"discount_pct\": 5,\n \"tax_pct\": 15,\n \"total\": 13110\n }\n ],\n \"view_count\": 0,\n \"sent_at\": null,\n \"sent_via\": null,\n \"first_viewed_at\": null,\n \"last_viewed_at\": null,\n \"accepted_at\": null,\n \"declined_at\": null,\n \"public_url\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/quotes/5\"\n }\n}" } ] }, { "name": "Get a quote", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] }, "description": "One quote with its items. Scope: `crm`." }, "response": [ { "name": "Quote", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 5,\n \"number\": \"Q-2026-0005\",\n \"status\": \"draft\",\n \"currency\": \"SAR\",\n \"subtotal\": 12000,\n \"discount_total\": 600,\n \"tax_total\": 1710,\n \"total\": 13110,\n \"issue_date\": \"2026-10-08\",\n \"valid_until\": \"2026-10-22\",\n \"deal_id\": 15,\n \"contact_id\": 42,\n \"company_id\": 7,\n \"owner_user_id\": 3,\n \"locale\": \"en\",\n \"terms\": \"Payment within 14 days.\",\n \"notes\": null,\n \"buyer\": {\n \"name\": \"Example Trading Co.\",\n \"email\": \"info@example.com\"\n },\n \"items\": [\n {\n \"id\": 9,\n \"product_id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"description\": null,\n \"qty\": 40,\n \"unit_price\": 300,\n \"discount_pct\": 5,\n \"tax_pct\": 15,\n \"total\": 13110\n }\n ],\n \"view_count\": 0,\n \"sent_at\": null,\n \"sent_via\": null,\n \"first_viewed_at\": null,\n \"last_viewed_at\": null,\n \"accepted_at\": null,\n \"declined_at\": null,\n \"public_url\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/quotes/5\"\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] }, { "name": "Update a quote", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"valid_until\": \"2026-10-29\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] }, "description": "Draft quotes only; same fields as *Draft a quote*. Scope: `crm`." }, "response": [ { "name": "Updated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] }, "body": { "mode": "raw", "raw": "{\n \"valid_until\": \"2026-10-29\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 5,\n \"number\": \"Q-2026-0005\",\n \"status\": \"draft\",\n \"currency\": \"SAR\",\n \"subtotal\": 12000,\n \"discount_total\": 600,\n \"tax_total\": 1710,\n \"total\": 13110,\n \"issue_date\": \"2026-10-08\",\n \"valid_until\": \"2026-10-29\",\n \"deal_id\": 15,\n \"contact_id\": 42,\n \"company_id\": 7,\n \"owner_user_id\": 3,\n \"locale\": \"en\",\n \"terms\": \"Payment within 14 days.\",\n \"notes\": null,\n \"buyer\": {\n \"name\": \"Example Trading Co.\",\n \"email\": \"info@example.com\"\n },\n \"items\": [\n {\n \"id\": 9,\n \"product_id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"description\": null,\n \"qty\": 40,\n \"unit_price\": 300,\n \"discount_pct\": 5,\n \"tax_pct\": 15,\n \"total\": 13110\n }\n ],\n \"view_count\": 0,\n \"sent_at\": null,\n \"sent_via\": null,\n \"first_viewed_at\": null,\n \"last_viewed_at\": null,\n \"accepted_at\": null,\n \"declined_at\": null,\n \"public_url\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/quotes/5\"\n }\n}" } ] }, { "name": "Delete a draft quote", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] }, "description": "Deletes a draft quote. A quote that was already sent answers `409` with `code: conflict`. Scope: `crm`." }, "response": [ { "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 5,\n \"deleted\": true\n }\n}" }, { "name": "Quote already sent", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/quotes/:id", "host": [ "{{crm_base_url}}" ], "path": [ "quotes", ":id" ], "variable": [ { "key": "id", "value": "5", "description": "The quote id." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Only draft quotes can be deleted.\",\n \"code\": \"conflict\"\n}" } ] } ] }, { "name": "Products", "item": [ { "name": "List products", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products", "host": [ "{{crm_base_url}}" ], "path": [ "products" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] }, "description": "The product catalogue through the CRM lists engine (same query parameters as *List contacts*). Scope: `crm`." }, "response": [ { "name": "One page", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products", "host": [ "{{crm_base_url}}" ], "path": [ "products" ], "query": [ { "key": "q", "value": "ahmed", "description": "Free-text search.", "disabled": true }, { "key": "filters", "value": "{\"match\":\"and\",\"conditions\":[{\"field\":\"email\",\"op\":\"is_not_empty\"}]}", "description": "Lists-engine filter as JSON. The …/schema endpoint lists the fields and operators.", "disabled": true }, { "key": "view", "value": "all", "description": "A saved view id (its filters and sort apply), or `all`.", "disabled": true }, { "key": "sort", "value": "created_at", "description": "Sort key (see `sorts` in …/schema).", "disabled": true }, { "key": "dir", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number.", "disabled": true }, { "key": "per_page", "value": "25", "description": "Rows per page, up to 100.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"sku\": \"EPX-20\",\n \"price\": 300,\n \"currency\": \"SAR\",\n \"tax_pct\": 15,\n \"is_active\": true,\n \"description\": \"Two-part floor epoxy.\",\n \"image_url\": \"https://example.com/images/epoxy-kit.jpg\",\n \"source\": \"manual\",\n \"created_at\": \"2026-09-20T09:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/products/21\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" } ] }, { "name": "Product fields, filters and sorts", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products/schema", "host": [ "{{crm_base_url}}" ], "path": [ "products", "schema" ] }, "description": "The lists-engine catalogue for product lists. Scope: `crm`." }, "response": [ { "name": "Schema", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products/schema", "host": [ "{{crm_base_url}}" ], "path": [ "products", "schema" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"fields\": [\n {\n \"key\": \"name\",\n \"label\": \"Name\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"email\",\n \"label\": \"Email\",\n \"type\": \"text\",\n \"filterable\": true,\n \"sortable\": false,\n \"operators\": [\n \"contains\",\n \"is\",\n \"is_empty\",\n \"is_not_empty\"\n ],\n \"options\": []\n },\n {\n \"key\": \"lifecycle\",\n \"label\": \"Lifecycle stage\",\n \"type\": \"select\",\n \"filterable\": true,\n \"sortable\": true,\n \"operators\": [\n \"is\",\n \"is_not\"\n ],\n \"options\": [\n {\n \"value\": 1,\n \"label\": \"Subscriber\"\n },\n {\n \"value\": 2,\n \"label\": \"Lead\"\n },\n {\n \"value\": 3,\n \"label\": \"Customer\"\n }\n ]\n }\n ],\n \"sorts\": [\n \"name\",\n \"created_at\",\n \"last_activity_at\"\n ],\n \"default_sort\": {\n \"key\": \"last_activity_at\",\n \"dir\": \"desc\"\n }\n }\n}" } ] }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Epoxy kit 20 kg\",\n \"sku\": \"EPX-20\",\n \"price\": 300,\n \"currency\": \"SAR\",\n \"tax_pct\": 15,\n \"is_active\": true,\n \"description\": \"Two-part floor epoxy.\",\n \"image_url\": \"https://example.com/images/epoxy-kit.jpg\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/products", "host": [ "{{crm_base_url}}" ], "path": [ "products" ] }, "description": "Adds a product to the catalogue. Scope: `crm`.\n\n**Required:** `name`, `price`, `currency` (3 letters). **Optional:** `sku`, `tax_pct` (0–100), `is_active`, `description`, `image_url`." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/products", "host": [ "{{crm_base_url}}" ], "path": [ "products" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Epoxy kit 20 kg\",\n \"sku\": \"EPX-20\",\n \"price\": 300,\n \"currency\": \"SAR\",\n \"tax_pct\": 15,\n \"is_active\": true,\n \"description\": \"Two-part floor epoxy.\",\n \"image_url\": \"https://example.com/images/epoxy-kit.jpg\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"sku\": \"EPX-20\",\n \"price\": 300,\n \"currency\": \"SAR\",\n \"tax_pct\": 15,\n \"is_active\": true,\n \"description\": \"Two-part floor epoxy.\",\n \"image_url\": \"https://example.com/images/epoxy-kit.jpg\",\n \"source\": \"manual\",\n \"created_at\": \"2026-09-20T09:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/products/21\"\n }\n}" } ] }, { "name": "Get a product", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] }, "description": "One product. Scope: `crm`." }, "response": [ { "name": "Product", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"sku\": \"EPX-20\",\n \"price\": 300,\n \"currency\": \"SAR\",\n \"tax_pct\": 15,\n \"is_active\": true,\n \"description\": \"Two-part floor epoxy.\",\n \"image_url\": \"https://example.com/images/epoxy-kit.jpg\",\n \"source\": \"manual\",\n \"created_at\": \"2026-09-20T09:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/products/21\"\n }\n}" }, { "name": "Not found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"Not found.\",\n \"code\": \"not_found\"\n}" } ] }, { "name": "Update a product", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"price\": 320\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] }, "description": "Only the fields sent change (`name`, `price`, `currency`, `sku`, `tax_pct` (0–100), `is_active`, `description`, `image_url`). Scope: `crm`." }, "response": [ { "name": "Updated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] }, "body": { "mode": "raw", "raw": "{\n \"price\": 320\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 21,\n \"name\": \"Epoxy kit 20 kg\",\n \"sku\": \"EPX-20\",\n \"price\": 320,\n \"currency\": \"SAR\",\n \"tax_pct\": 15,\n \"is_active\": true,\n \"description\": \"Two-part floor epoxy.\",\n \"image_url\": \"https://example.com/images/epoxy-kit.jpg\",\n \"source\": \"manual\",\n \"created_at\": \"2026-09-20T09:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/crm/products/21\"\n }\n}" } ] }, { "name": "Delete a product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] }, "description": "Removes the product from the catalogue; existing quotes keep their lines. Scope: `crm`." }, "response": [ { "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/products/:id", "host": [ "{{crm_base_url}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "21", "description": "The product id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 21,\n \"deleted\": true\n }\n}" } ] } ] }, { "name": "Webhooks (REST hooks)", "item": [ { "name": "List API webhook subscriptions", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/hooks", "host": [ "{{crm_base_url}}" ], "path": [ "hooks" ] }, "description": "Subscriptions created through the API. Subscriptions made in the panel are managed there. Secrets are never returned again. Scope: `crm`." }, "response": [ { "name": "Subscriptions", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/hooks", "host": [ "{{crm_base_url}}" ], "path": [ "hooks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": 4,\n \"url\": \"https://hooks.example.com/letsbot/crm\",\n \"events\": [\n \"deal.won\",\n \"deal.lost\"\n ],\n \"source\": \"api\",\n \"description\": \"Sync won deals to the ERP\",\n \"is_active\": true,\n \"disabled_reason\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\"\n }\n ]\n}" } ] }, { "name": "List webhook events", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/hooks/events", "host": [ "{{crm_base_url}}" ], "path": [ "hooks", "events" ] }, "description": "The event catalogue: every event name with its object. Scope: `crm`." }, "response": [ { "name": "Events", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/hooks/events", "host": [ "{{crm_base_url}}" ], "path": [ "hooks", "events" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"event\": \"contact.created\",\n \"object\": \"contact\"\n },\n {\n \"event\": \"contact.updated\",\n \"object\": \"contact\"\n },\n {\n \"event\": \"contact.deleted\",\n \"object\": \"contact\"\n },\n {\n \"event\": \"company.created\",\n \"object\": \"company\"\n },\n {\n \"event\": \"company.updated\",\n \"object\": \"company\"\n },\n {\n \"event\": \"company.deleted\",\n \"object\": \"company\"\n },\n {\n \"event\": \"deal.created\",\n \"object\": \"deal\"\n },\n {\n \"event\": \"deal.updated\",\n \"object\": \"deal\"\n },\n {\n \"event\": \"deal.deleted\",\n \"object\": \"deal\"\n },\n {\n \"event\": \"deal.stage_changed\",\n \"object\": \"deal\"\n },\n {\n \"event\": \"deal.won\",\n \"object\": \"deal\"\n },\n {\n \"event\": \"deal.lost\",\n \"object\": \"deal\"\n },\n {\n \"event\": \"task.created\",\n \"object\": \"task\"\n },\n {\n \"event\": \"task.completed\",\n \"object\": \"task\"\n },\n {\n \"event\": \"ticket.created\",\n \"object\": \"ticket\"\n },\n {\n \"event\": \"quote.sent\",\n \"object\": \"quote\"\n },\n {\n \"event\": \"quote.viewed\",\n \"object\": \"quote\"\n },\n {\n \"event\": \"quote.accepted\",\n \"object\": \"quote\"\n }\n ]\n}" } ] }, { "name": "Sample webhook payload", "request": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/hooks/sample?event=deal.won", "host": [ "{{crm_base_url}}" ], "path": [ "hooks", "sample" ], "query": [ { "key": "event", "value": "deal.won", "description": "The event name (see *List webhook events*)." } ] }, "description": "One sample event built from the newest record of that object (an empty list when there is none) — for trigger setup screens in Zapier, Make or n8n. Scope: `crm`." }, "response": [ { "name": "Sample", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{crm_base_url}}/hooks/sample?event=deal.won", "host": [ "{{crm_base_url}}" ], "path": [ "hooks", "sample" ], "query": [ { "key": "event", "value": "deal.won", "description": "The event name (see *List webhook events*)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"9b1f3c2e-7a4d-4e8b-9c1a-2f3e4d5c6b7a\",\n \"event\": \"deal.won\",\n \"object\": \"deal\",\n \"record_id\": 15,\n \"occurred_at\": \"2026-10-08T09:30:00+03:00\",\n \"data\": {\n \"id\": 15,\n \"title\": \"Epoxy kit order — 40 units\",\n \"amount\": 12000,\n \"currency\": \"SAR\",\n \"pipeline_id\": 1,\n \"stage\": {\n \"id\": 13,\n \"name\": \"Won\"\n },\n \"status\": \"won\",\n \"expected_close_date\": \"2026-10-31\",\n \"contact\": {\n \"id\": 42,\n \"name\": \"Ahmed Ali\",\n \"phone\": \"966500000000\"\n },\n \"company_id\": 7,\n \"owner\": {\n \"id\": 3,\n \"name\": \"Sara Ahmed\"\n },\n \"lost_reason_id\": null,\n \"lost_note\": null,\n \"won_at\": \"2026-10-08T09:30:00+03:00\",\n \"lost_at\": null,\n \"custom_fields\": {},\n \"created_at\": \"2026-10-02T10:00:00+03:00\",\n \"updated_at\": \"2026-10-08T09:30:00+03:00\",\n \"url\": \"https://your-workspace.letsbot.net/panel/v2/deals?deal=15&pipeline=1\"\n },\n \"previous\": {\n \"stage_id\": 12,\n \"status\": \"open\"\n }\n }\n ]\n}" } ] }, { "name": "Subscribe a webhook (REST hook)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target_url\": \"https://hooks.example.com/letsbot/crm\",\n \"events\": [\n \"deal.won\",\n \"deal.lost\"\n ],\n \"source\": \"api\",\n \"description\": \"Sync won deals to the ERP\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{crm_base_url}}/hooks", "host": [ "{{crm_base_url}}" ], "path": [ "hooks" ] }, "description": "Zapier / Make / n8n REST-hook subscribe. Scope: `crm`.\n\n**Fields:** `target_url` (or `url`), `event` (or `events[]`), optional `source` (`zapier`, `make`, `n8n`, `api`) and `description`. Up to 50 subscriptions per workspace; at most 30 subscribe calls per minute per key.\n\nThe answer carries the signing `secret` **once** — store it. Deliveries are signed with `X-LetsBot-Signature` (see the CRM section above)." }, "response": [ { "name": "Subscribed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/hooks", "host": [ "{{crm_base_url}}" ], "path": [ "hooks" ] }, "body": { "mode": "raw", "raw": "{\n \"target_url\": \"https://hooks.example.com/letsbot/crm\",\n \"events\": [\n \"deal.won\",\n \"deal.lost\"\n ],\n \"source\": \"api\",\n \"description\": \"Sync won deals to the ERP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"url\": \"https://hooks.example.com/letsbot/crm\",\n \"events\": [\n \"deal.won\",\n \"deal.lost\"\n ],\n \"source\": \"api\",\n \"description\": \"Sync won deals to the ERP\",\n \"is_active\": true,\n \"disabled_reason\": null,\n \"created_at\": \"2026-10-08T09:30:00+03:00\",\n \"secret\": \"whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n }\n}" }, { "name": "URL not https", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{crm_base_url}}/hooks", "host": [ "{{crm_base_url}}" ], "path": [ "hooks" ] }, "body": { "mode": "raw", "raw": "{\n \"target_url\": \"https://hooks.example.com/letsbot/crm\",\n \"events\": [\n \"deal.won\",\n \"deal.lost\"\n ],\n \"source\": \"api\",\n \"description\": \"Sync won deals to the ERP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"The URL must start with https://.\",\n \"code\": \"validation_failed\",\n \"errors\": {\n \"url\": [\n \"The URL must start with https://.\"\n ]\n }\n}" } ] }, { "name": "Unsubscribe a webhook (REST hook)", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/hooks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "hooks", ":id" ], "variable": [ { "key": "id", "value": "4", "description": "The subscription id." } ] }, "description": "Deletes a subscription made through the API. Scope: `crm`." }, "response": [ { "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{crm_base_url}}/hooks/:id", "host": [ "{{crm_base_url}}" ], "path": [ "hooks", ":id" ], "variable": [ { "key": "id", "value": "4", "description": "The subscription id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"deleted\": true\n }\n}" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{crm_api_key}}", "type": "string" }, { "key": "key", "value": "X-Zapier-Api-Key", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{lb_api_key}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "base_url", "value": "https://letsbot.net/api/v1", "type": "string" }, { "key": "phone", "value": "9665xxxxxxxx", "type": "string" }, { "key": "lb_api_key", "value": "", "type": "string" }, { "key": "crm_base_url", "value": "https://your-workspace.letsbot.net/api/v1/crm", "type": "string" }, { "key": "crm_api_key", "value": "", "type": "string" } ] }