{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8133345d-d2da-4c74-ac10-ff85665645d3","name":"Sendiee API (v2.0) — Synced","description":"# Sendiee API (v2.0)\n\nOfficial Sendiee REST API. Sendiee is an official Meta Business Partner; messaging is powered by Meta's WhatsApp Cloud API.\n\n- **Base URL:** `https://api.sendiee.com`\n- **Version:** `v2.0` (all paths prefixed with `/v2.0/`)\n- **Auth:** Bearer token — `Authorization: Bearer <API_KEY>` (Dashboard -> API & Webhooks)\n- **Content-Type:** `application/json`\n- **Docs:** https://docs.sendiee.com\n\n## Response Envelope\n\n**Success:** `{ \"success\": true, \"message\": \"...\", \"data\": { ... } }`\n\n**Error:** `{ \"success\": false, \"code\": \"ERROR_CODE\", \"message\": \"Human-readable description\" }`\n\n## Rate Limits\n\nTwo rolling limits enforced per organisation. Exceeding either returns `429 Too Many Requests` — check the `Retry-After` header.\n\n| Limit | Free | Growth | Pro | Business |\n|-------|------|--------|-----|----------|\n| Per second (`api_rate_limit_per_sec`) | 5 | 10 | 20 | 60 |\n| Per day (`api_rate_limit_per_day`) | 100 | 1,000 | 20,000 | 50,000 |\n\nError codes: `RATE_LIMIT_EXCEEDED_PER_SECOND`, `RATE_LIMIT_EXCEEDED_PER_DAY`. WhatsApp messaging is also subject to **Meta's tier limits** (Tier 1 = 250 unique customers / 24h, increases automatically).\n\n## Error Codes Reference\n\n### Authentication & Organisation\n| Code | HTTP | Description |\n|------|------|-------------|\n| `API_KEY_MISSING` | 401 | No API key in the Authorization header |\n| `INVALID_API_KEY` | 401 | API key does not exist or is revoked |\n| `INSUFFICIENT_SCOPE` | 403 | Key lacks the required scope (see `required_scope`) |\n| `ORG_INACTIVE` | 403 | Organisation account is inactive |\n| `DOMAIN_NOT_WHITELISTED` | 403 | Request origin domain not in allowed list |\n| `ORG_ID_REQUIRED` | 400 | Org ID could not be resolved from API key |\n\n### Plan Enforcement\n| Code | HTTP | Description |\n|------|------|-------------|\n| `LIMIT_EXCEEDED` | 403 | Numeric plan limit reached. Includes `limitKey`, `current`, `limit` |\n| `PLAN_LIMIT_EXCEEDED` | 403 | Lead-segmentation count limit reached (categories / follow-ups / insights) |\n| `PLAN_FEATURE_DISABLED` | 403 | Feature toggle not included in the current plan |\n| `FEATURE_NOT_ENABLED` | 403 | Feature not available on current plan |\n\n### WhatsApp & Messaging\n| Code | HTTP | Description |\n|------|------|-------------|\n| `BRAND_NUMBER_MISSING` | 400 | `brandNumber` not provided |\n| `WABA_NOT_FOUND` | 404 | No active WhatsApp account for given `brandNumber` |\n| `MISSING_RECIPIENT` | 400 | `to` field is required |\n| `INVALID_PHONE_NUMBER` | 400 | Phone number failed validation |\n| `MISSING_TEMPLATE` | 400 | Neither `templateId` nor `templateName` provided |\n| `TEMPLATE_NOT_FOUND` | 404 | Template not found or not APPROVED |\n| `PARAMETER_VALIDATION_ERROR` | 400 | Template parameter count mismatch |\n| `INVALID_SCHEDULE_TIME` | 400 | Scheduled time is in the past |\n| `META_API_ERROR` | 502 | Error returned by Meta's WhatsApp Cloud API |\n| `MESSAGE_NOT_FOUND` | 404 | Message ID not found in this org |\n| `SCHEDULE_NOT_CANCELLABLE` | 400 | Message already sent/processing — cannot cancel |\n\n### Contacts, Fields & Tags\n| Code | HTTP | Description |\n|------|------|-------------|\n| `MISSING_PHONE` | 400 | `phone` field is required |\n| `CONTACT_NOT_FOUND` | 404 | No contact found for the given identifier |\n| `CONTACT_ALREADY_EXISTS` | 409 | Contact with this phone already exists |\n| `INVALID_FIELD_TYPE` | 400 | `fieldType` not text/number/date/boolean/dropdown |\n| `MISSING_DROPDOWN_OPTIONS` | 400 | `options` required for `dropdown` type |\n| `CUSTOM_FIELD_NOT_FOUND` | 404 | Custom field not found |\n| `CUSTOM_FIELD_ALREADY_EXISTS` | 409 | Custom field key already exists |\n| `MISSING_TAG_NAME` | 400 | Tag `name` is required |\n| `TAG_NOT_FOUND` | 404 | Tag not found |\n| `TAG_ALREADY_EXISTS` | 409 | Tag name already exists |\n\n### Templates\n| Code | HTTP | Description |\n|------|------|-------------|\n| `TEMPLATE_VALIDATION_FAILED` | 422 | Local pre-Meta validation failed; see `details[]` |\n| `TEMPLATE_RATE_LIMITED` | 429 | Template-create cap hit (2/min, 30/day) |\n| `WABA_NOT_REVIEWED` | 409 | WABA not in APPROVED review status |\n| `META_REJECTED` | 502 | Meta returned an error; see `details` |\n| `MEDIA_UPLOAD_FAILED` | 502 | Failed to download/upload header media |\n| `INVALID_TEMPLATE_ID` | 400 | `id` is neither a 24-hex ObjectId nor a numeric templateId |\n\n### Campaigns\n| Code | HTTP | Description |\n|------|------|-------------|\n| `CAMPAIGN_EMPTY_AUDIENCE` | 400 | Resolved audience contains 0 contacts |\n| `CAMPAIGN_VARIABLES_INVALID` | 422 | Variables don't match template requirements |\n| `CAMPAIGN_TEMPLATE_NOT_APPROVED` | 409 | Template exists but is not APPROVED |\n| `CAMPAIGN_NOT_FOUND` | 404 | Campaign missing or belongs to another org |\n| `CAMPAIGN_NOT_CANCELLABLE` | 409 | Campaign already completed/failed/cancelled |\n\n### Assistants\n| Code | HTTP | Description |\n|------|------|-------------|\n| `ASSISTANT_VALIDATION_FAILED` | 422 | Payload failed local validation; see `details[]` |\n| `MODEL_INVALID_FOR_PROVIDER` | 422 | `model` not in the chosen provider's catalog |\n| `ASSISTANT_NOT_FOUND` | 404 | modelId doesn't exist in your org |\n| `VERSION_NOT_RESTORABLE` | 400 | Version is a toggle/channel_update/restore |\n\n### Tools\n| Code | HTTP | Description |\n|------|------|-------------|\n| `TOOL_VALIDATION_FAILED` | 422 | Validation failed; see `details[]` with `example` |\n| `TOOL_NAME_EXISTS` | 409 | Duplicate tool name |\n| `TOOL_TYPE_IMMUTABLE` | 400 | `toolType` cannot be changed after creation |\n\n### Lead Segmentation\n| Code | HTTP | Description |\n|------|------|-------------|\n| `CATEGORY_EXISTS` | 409 | A lead category with this name already exists |\n| `CATEGORY_NOT_FOUND` | 404 | Lead category not found |\n| `CATEGORY_IN_USE` | 409 | Contacts still use this category — pass `reassignTo` |\n| `INSIGHT_EXISTS` | 409 | An insight (audience segment) with this key already exists |\n| `INSIGHT_NOT_FOUND` | 404 | Insight not found |\n\n### Generic\n| Code | HTTP | Description |\n|------|------|-------------|\n| `INTERNAL_SERVER_ERROR` | 500 | Unexpected server-side error |\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"36785064","team":16502686,"collectionId":"8133345d-d2da-4c74-ac10-ff85665645d3","publishedId":"2sBXwsMq9e","public":true,"publicUrl":"https://documenter-api.postman.tech/view/36785064/2sBXwsMq9e","privateUrl":"https://go.postman.co/documentation/36785064-8133345d-d2da-4c74-ac10-ff85665645d3","customColor":{"top-bar":"fdfcf9","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Official Sendiee REST API docs. Send WhatsApp templates, manage contacts, run campaigns, and automate AI assistants. Run in Postman or try it live."},{"name":"title","value":"Sendiee API Reference – WhatsApp, Contacts &amp; Campaigns"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"fdfcf9","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.14","publishDate":"2026-06-13T01:07:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Sendiee API Reference – WhatsApp, Contacts &amp; Campaigns","description":"Official Sendiee REST API docs. Send WhatsApp templates, manage contacts, run campaigns, and automate AI assistants. Run in Postman or try it live."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/257baf75d61715a49bc5eab68fdaf865b19e52bd0c590e4694afe7d10d0cd137","favicon":"https://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/v1781310002/team/ab223c1d6e0e1cf4efb058ac020611f7"},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXwsMq9e"}