{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bd290d8f-e374-489d-9302-6579a889b429","name":"MotherBot API v1","description":"# MotherBot REST API — v1\n\nContacts, messages, campaigns, sequences, coupons, deals, products, media, webhooks and plan\nusage for the WhatsApp Business Platform.\n\n## Setup\n\n1. Create a key under **Settings → API Keys** in your MotherBot dashboard.\n2. Set the `apiKey` collection variable — or select the MotherBot environment and set it there.\n3. Leave `baseUrl` as `https://motherbot.io/api/v1` unless you are on a white-label domain.\n\nAuthentication is set on the collection, so every request inherits `Authorization: Bearer {{apiKey}}`.\n\n## Where to start\n\nSend **Usage & Plan** first. It returns every quota, how much of it is gone, and every feature\nflag on the plan — so an integration can size a batch instead of discovering the ceiling halfway\nthrough it, and can tell a `403` it will never get past from a `402` that clears next month.\n\n## Running a folder in order\n\nRequests that create something store the returned id in a collection variable (`contactId`,\n`campaignId`, `couponId`, `sequenceId`, `dealId`, `productId`, `webhookId`), so the requests\nbelow them run without pasting ids by hand.\n\n## Rate limits\n\n| Plan | Limit |\n| --- | --- |\n| Starter | 60 req/min |\n| Growth | 300 req/min |\n| Enterprise | 1,200 req/min |\n\n`POST /messages/bulk` and `POST /campaigns/send` draw on a separate bucket set to a tenth of the\nplan limit, so a broadcast cannot exhaust the allowance ordinary reads depend on. Every response\ncarries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`.\n\n## Errors\n\n```json\n{ \"success\": false, \"error\": \"error_code\", \"message\": \"Human-readable description\", \"details\": {} }\n```\n\n| Code | `error` | Meaning |\n| --- | --- | --- |\n| 400 | `invalid_request` | Missing or malformed parameter |\n| 400 | `invalid_template` | Template exists but is not APPROVED |\n| 400 | `invalid_state` | Resource is in the wrong state for the action |\n| 400 | `no_whatsapp_account` | No connected WhatsApp account found |\n| 401 | `unauthorized` | Missing, invalid, or revoked API key |\n| 402 | `plan_limit_reached` | Quota full — details carry the numbers |\n| 403 | `feature_not_available` | Your plan does not include this feature |\n| 404 | `not_found` | Resource does not exist |\n| 409 | `already_exists` | A resource with that unique id already exists |\n| 413 | `file_too_large` | Upload exceeds the size limit |\n| 415 | `unsupported_media_type` | File type not accepted, or contents don't match it |\n| 429 | `rate_limit_exceeded` | Too many requests |\n| 502 | `upstream_error` | WhatsApp / Meta API returned an error |\n\nA **403 `feature_not_available`** means the feature is not on the plan at all — stop calling the\nendpoint. A **402 `plan_limit_reached`** means it is there but the quota is full, and `details`\ncarries the numbers so you can tell the customer which one ran out.\n\n---\n\nGenerated live from the MotherBot API catalogue — re-import this link to pick up new endpoints.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"46742038","team":8834950,"collectionId":"bd290d8f-e374-489d-9302-6579a889b429","publishedId":"2sBY4SLdcL","public":true,"publicUrl":"https://documenter-api.postman.tech/view/46742038/2sBY4SLdcL","privateUrl":"https://go.postman.co/documentation/46742038-bd290d8f-e374-489d-9302-6579a889b429","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"16A349"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The public REST API for MotherBot (https://motherbot.io) — a Business Automation Platform for messaging, campaigns, CRM and commerce.\n\n**MotherBot API v1** covers 47 endpoints across 15 areas: contacts and segments, single and bulk\nmessage sends, approved templates, campaigns and broadcasts, drip sequences many more..."},{"name":"title","value":"APIs MotherBot - Business Chat CRM"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/5bddf8e3-d32c-407f-b84a-479dbafca7bc/YXBwLWljb24td2hpdGUucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"16A349"}},{"name":"light","logo":"https://content.pstmn.io/5bddf8e3-d32c-407f-b84a-479dbafca7bc/YXBwLWljb24td2hpdGUucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"16A349"}}]}},"version":"8.12.3","publishDate":"2026-07-28T05:27:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"APIs MotherBot - Business Chat CRM","description":"The public REST API for MotherBot (https://motherbot.io) — a Business Automation Platform for messaging, campaigns, CRM and commerce.\n\n**MotherBot API v1** covers 47 endpoints across 15 areas: contacts and segments, single and bulk\nmessage sends, approved templates, campaigns and broadcasts, drip sequences many more..."},"logos":{"logoLight":"https://content.pstmn.io/5bddf8e3-d32c-407f-b84a-479dbafca7bc/YXBwLWljb24td2hpdGUucG5n","logoDark":"https://content.pstmn.io/5bddf8e3-d32c-407f-b84a-479dbafca7bc/YXBwLWljb24td2hpdGUucG5n"}},"statusCode":200},"environments":[{"name":"MotherBot — Production","id":"28b57a8f-5c6e-4cf3-9ed7-7e331e4cf9e3","owner":"46742038","values":[{"key":"baseUrl","value":"https://motherbot.io/api/v1","type":"default","enabled":true},{"key":"apiKey","value":"","type":"secret","enabled":true},{"key":"phoneNumber","value":"","type":"default","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f42298dc1aa6e0a0b900c86f65a772f1eacd878a1d7703beea10ad504a142fef","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"MotherBot — Production","value":"46742038-28b57a8f-5c6e-4cf3-9ed7-7e331e4cf9e3"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBY4SLdcL"}