{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for this API key"
}
}
Segments
Add contacts to a segment
Adds contacts to a static segment. A dynamic segment answers 400 —
its membership comes from its filter.
Up to 1000 contact ids per request. added counts the rows actually
created, so ids that were already members and ids belonging to another
workspace both count as zero — compare it with requested.
Your workspace API key, created in Settings → Developer → API keys, sent as
Authorization: Bearer <key>. New keys start with watx_live_; keys
issued before the rename start with converse360_live_ and still work.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Watx","description":"Documentation for Watx: one inbox for WhatsApp, Instagram and website chat, with a CRM, automations, flows, forms, AI agents, integrations and a public API.","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/watx/RbII_Y84cOqYh7_M/logo/light.svg?fit=max\u0026auto=format\u0026n=RbII_Y84cOqYh7_M\u0026q=85\u0026s=9f016a244568da620d7a646c56e7889f","dark":"https://mintcdn.com/watx/RbII_Y84cOqYh7_M/logo/dark.svg?fit=max\u0026auto=format\u0026n=RbII_Y84cOqYh7_M\u0026q=85\u0026s=0bb6c63111efdfd7ef7a399e6887ab21","href":"https://app.watx.in"},"favicon":{"light":"https://mintcdn.com/watx/BcZx4nq4blikJB48/images/watx-mark-light.png?fit=max\u0026auto=format\u0026n=BcZx4nq4blikJB48\u0026q=85\u0026s=5cb4a28aa55834fb3a854e26ba4b8b50","dark":"https://mintcdn.com/watx/BcZx4nq4blikJB48/images/watx-mark-dark.png?fit=max\u0026auto=format\u0026n=BcZx4nq4blikJB48\u0026q=85\u0026s=9d042920d09f1124ec9cced5a27f3486"},"navbar":{"links":[{"icon":"paper-plane","href":"/api/postman","label":"Postman collection"},{"href":"mailto:support@watx.in","label":"Support"}],"primary":{"type":"button","label":"Open Watx","href":"https://app.watx.in"}},"footer":{"links":[{"header":"Product","items":[{"label":"Open Watx","href":"https://app.watx.in"},{"label":"Pricing","href":"https://app.watx.in/pricing"}]},{"header":"Help","items":[{"label":"Support","href":"mailto:support@watx.in"}]}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"watx","hasAudioNarration":false,"actualSubdomain":"watx","customDomains":["docs.watx.in"],"gitSource":{"type":"github","owner":"sivakrishnacode","repo":"watx-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad4bb0a5ec9dc5442eb45c9","collectionId":"915b525b-9f30-403d-be81-db443151af68","liveDeploymentHistoryId":"6ad4bb0a5ec9dc5442eb45c9","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ad4bb0a5ec9dc5442eb45c9","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Guides","count":80},{"language":"default","tag":"API reference","count":29},{"language":"default","tag":"Channels","count":28},{"language":"default","tag":"Integrations","count":17},{"language":"default","tag":"WhatsApp","count":15},{"language":"default","tag":"AI agents","count":10},{"language":"default","tag":"Automations","count":10},{"language":"default","tag":"Forms","count":8},{"language":"default","tag":"Instagram","count":8},{"language":"default","tag":"Segments","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/segments/add-contacts-to-a-segment","slug":"/api-reference/segments/add-contacts-to-a-segment","pageMetadata":{"title":"Add contacts to a segment","description":"Adds contacts to a **static** segment. A dynamic segment answers `400` —\nits membership comes from its filter.\n\nUp to 1000 contact ids per request. `added` counts the rows actually\ncreated, so ids that were already members and ids belonging to another\nworkspace both count as zero — compare it with `requested`.\n\nRequires the `contacts:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /segments/{id}/contacts","href":"/api-reference/segments/add-contacts-to-a-segment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Adds contacts to a \", _jsx(_components.strong, {\n children: \"static\"\n }), \" segment. A dynamic segment answers \", _jsx(_components.code, {\n children: \"400\"\n }), \" —\\nits membership comes from its filter.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Up to 1000 contact ids per request. \", _jsx(_components.code, {\n children: \"added\"\n }), \" counts the rows actually\\ncreated, so ids that were already members and ids belonging to another\\nworkspace both count as zero — compare it with \", _jsx(_components.code, {\n children: \"requested\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"contacts:write\"\n }), \" scope.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add contacts to a segment","description":"Adds contacts to a **static** segment. A dynamic segment answers `400` —\nits membership comes from its filter.\n\nUp to 1000 contact ids per request. `added` counts the rows actually\ncreated, so ids that were already members and ids belonging to another\nworkspace both count as zero — compare it with `requested`.\n\nRequires the `contacts:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /segments/{id}/contacts","href":"/api-reference/segments/add-contacts-to-a-segment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"addSegmentContacts","tags":["Segments"],"summary":"Add contacts to a segment","description":"Adds contacts to a **static** segment. A dynamic segment answers `400` —\nits membership comes from its filter.\n\nUp to 1000 contact ids per request. `added` counts the rows actually\ncreated, so ids that were already members and ids belonging to another\nworkspace both count as zero — compare it with `requested`.\n\nRequires the `contacts:write` scope.\n","x-required-scope":"contacts:write","requestBody":"b0cb4e02-cd6b-4853-bec2-3278a56a5b83","responses":{"201":"2cc4f999-c852-4739-833e-e092d1752bfc","400":"d85a1967-5adc-405f-8550-8516dfb5e0a5","401":"6c424c35-47ed-434d-a0c1-576be7633c52","403":"53d85b31-4fb9-4fd5-9f6d-11c4c766aba0","404":"0c094c10-1ab3-471b-bdec-0fd96e653a13","429":"37f446d3-ed84-4040-a220-311edc74295a"},"method":"post","type":"path","servers":["aad385d4-3f88-431f-bb44-1cd2895693b4"],"security":["c3ff3544-094c-4808-a459-57f829ae83c9"],"path":"/segments/{id}/contacts","baseUrlOptions":["https://api.watx.in/v1"],"title":"Add contacts to a segment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"629ae485-8fb7-4e7e-b18d-c1a7153362af":{"name":"id","in":"path","required":true,"description":"The segment id.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The segment id.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contact_ids"],"properties":{"contact_ids":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","format":"uuid","uniqueKey":"contact_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":true,"uniqueKey":"contact_ids","typeLabel":"string\u003cuuid>[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"contact_ids":["7e2d9c01-55b4-4a3d-9c8e-0f1a2b3c4d5e","1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]},"examples":{"Example":{"title":"Example","value":{"contact_ids":["7e2d9c01-55b4-4a3d-9c8e-0f1a2b3c4d5e","1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"2cc4f999-c852-4739-833e-e092d1752bfc":{"description":"How many of the requested contacts were added.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"segment_id":{"type":"string","format":"uuid","uniqueKey":"data.segment_id","typeLabel":"string\u003cuuid>"},"requested":{"type":"integer","uniqueKey":"data.requested","typeLabel":"integer"},"added":{"type":"integer","uniqueKey":"data.added","typeLabel":"integer"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"segment_id":"8c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f","requested":2,"added":1}},"examples":{"Example":{"title":"Example","value":{"data":{"segment_id":"8c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f","requested":2,"added":1}}}},"exampleType":"examples"}},"exampleType":"examples"},"d85a1967-5adc-405f-8550-8516dfb5e0a5":{"description":"An empty or oversized `contact_ids`, or a dynamic segment.\n","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"bad_request","message":"Cannot add contacts to a dynamic segment; its membership comes from its filter"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"bad_request","message":"Cannot add contacts to a dynamic segment; its membership comes from its filter"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6c424c35-47ed-434d-a0c1-576be7633c52":{"description":"The key is missing, malformed, unknown, revoked or expired. All four\nanswer the same way.\n","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Missing or invalid API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing or invalid API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"53d85b31-4fb9-4fd5-9f6d-11c4c766aba0":{"description":"The key is valid but was not granted the scope this operation requires.","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"This API key is missing the 'messages:send' scope"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"This API key is missing the 'messages:send' scope"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0c094c10-1ab3-471b-bdec-0fd96e653a13":{"description":"No such resource in this workspace. A resource belonging to another\nworkspace answers the same way.\n","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Contact not found"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Contact not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"37f446d3-ed84-4040-a220-311edc74295a":{"description":"More than 120 requests in a minute for this key. `Retry-After` says how\nmany seconds to wait.\n","headers":{"Retry-After":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limited","message":"Rate limit exceeded for this API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Rate limit exceeded for this API key"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c3ff3544-094c-4808-a459-57f829ae83c9":{"apiKey":{"type":"http","scheme":"bearer","description":"Your workspace API key, created in **Settings → Developer → API keys**, sent as\n`Authorization: Bearer \u003ckey>`. New keys start with `watx_live_`; keys\nissued before the rename start with `converse360_live_` and still work.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"aad385d4-3f88-431f-bb44-1cd2895693b4":{"url":"https://api.watx.in/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your workspace API key, created in **Settings → Developer → API keys**, sent as\n`Authorization: Bearer \u003ckey>`. New keys start with `watx_live_`; keys\nissued before the rename start with `converse360_live_` and still work.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your workspace API key, created in **Settings → Developer → API keys**, sent as\n`Authorization: Bearer \u003ckey>`. New keys start with `watx_live_`; keys\nissued before the rename start with `converse360_live_` and still work.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"watx","siteName":"Watx","title":"Add contacts to a segment - Watx","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-18T10:39:27.930Z","originalFileLocation":"api-reference/segments/add-contacts-to-a-segment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Adds contacts to a static segment. A dynamic segment answers 400 — its membership comes from its filter. Up to 1000 contact ids per request. added counts the rows actually created, so ids that were already members and ids belonging to another workspace both count as zero — compare it with requested. Requires the contacts:write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Watx\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add contacts to a segment - Watx\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds contacts to a static segment. A dynamic segment answers 400 — its membership comes from its filter. Up to 1000 contact ids per request. added counts the rows actually created, so ids that were already members and ids belonging to another workspace both count as zero — compare it with requested. Requires the contacts:write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Watx\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://watx.mintlify.app/_mintlify/api/og/v2?division=Segments\u0026amp;title=Add+contacts+to+a+segment\u0026amp;description=Adds+contacts+to+a+**static**+segment.+A+dynamic+segment+answers+%60400%60+%E2%80%94%0Aits+membership+comes+from+its+filter.%0A%0AUp+to+1000+contact+ids+per+request.+%60added%60+coun\u0026amp;theme=4702c6122007e2df47c96f3b\u0026amp;signature=5cd61fdb0703bb57bdc47925802d4a26db725f339ed41e184e4f6ea978ff1a18\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add contacts to a segment - Watx\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds contacts to a static segment. A dynamic segment answers 400 — its membership comes from its filter. Up to 1000 contact ids per request. added counts the rows actually created, so ids that were already members and ids belonging to another workspace both count as zero — compare it with requested. Requires the contacts:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://watx.mintlify.app/_mintlify/api/og/v2?division=Segments\u0026amp;title=Add+contacts+to+a+segment\u0026amp;description=Adds+contacts+to+a+**static**+segment.+A+dynamic+segment+answers+%60400%60+%E2%80%94%0Aits+membership+comes+from+its+filter.%0A%0AUp+to+1000+contact+ids+per+request.+%60added%60+coun\u0026amp;theme=4702c6122007e2df47c96f3b\u0026amp;signature=5cd61fdb0703bb57bdc47925802d4a26db725f339ed41e184e4f6ea978ff1a18\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Watx\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/segments/add-contacts-to-a-segment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.watx.in/#organization\",\"name\":\"Watx\",\"url\":\"https://docs.watx.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/watx/RbII_Y84cOqYh7_M/logo/light.svg?fit=max\u0026auto=format\u0026n=RbII_Y84cOqYh7_M\u0026q=85\u0026s=9f016a244568da620d7a646c56e7889f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.watx.in#website\",\"name\":\"Watx\",\"url\":\"https://docs.watx.in\",\"publisher\":{\"@id\":\"https://docs.watx.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment#webpage\",\"url\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment\",\"name\":\"Add contacts to a segment\",\"description\":\"Adds contacts to a static segment. A dynamic segment answers 400 — its membership comes from its filter. Up to 1000 contact ids per request. added counts the rows actually created, so ids that were already members and ids belonging to another workspace both count as zero — compare it with requested. Requires the contacts:write scope.\",\"dateModified\":\"2026-10-18T10:39:27.930Z\",\"isPartOf\":{\"@id\":\"https://docs.watx.in#website\"},\"breadcrumb\":{\"@id\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Segments\",\"item\":\"https://docs.watx.in/api-reference/segments/list-segments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add contacts to a segment\",\"item\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment#apireference\",\"headline\":\"Add contacts to a segment\",\"name\":\"Add contacts to a segment\",\"description\":\"Adds contacts to a static segment. A dynamic segment answers 400 — its membership comes from its filter. Up to 1000 contact ids per request. added counts the rows actually created, so ids that were already members and ids belonging to another workspace both count as zero — compare it with requested. Requires the contacts:write scope.\",\"url\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.watx.in/api-reference/segments/add-contacts-to-a-segment#webpage\"},\"dateModified\":\"2026-10-18T10:39:27.930Z\",\"publisher\":{\"@id\":\"https://docs.watx.in/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.watx.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Watx\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Watx","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Channels","pages":[{"title":"Channels","href":"/whatsapp/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API introduction","icon":"plug","href":"/api/introduction"},{"title":"Authentication","icon":"key","href":"/api/authentication"},{"title":"Requests and responses","icon":"code","href":"/api/requests-and-responses"},{"title":"Webhooks","icon":"bell","href":"/api/webhooks"},{"title":"Postman collection","icon":"paper-plane","href":"/api/postman"}]},{"group":"Account","pages":[{"title":"Who am I","deprecated":null,"version":null,"openapi":"/openapi.yaml get /me","href":"/api-reference/account/who-am-i"}]},{"group":"Messages","pages":[{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /messages","href":"/api-reference/messages/send-a-message"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /contacts/{id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /segments","href":"/api-reference/segments/list-segments"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /segments","href":"/api-reference/segments/create-a-segment"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /segments/{id}","href":"/api-reference/segments/get-a-segment"},{"title":"Update a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /segments/{id}","href":"/api-reference/segments/update-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /segments/{id}","href":"/api-reference/segments/delete-a-segment"},{"title":"List a segment's contacts","description":"Returns the people in a segment — the stored list for a static segment,\nthe result of the filter for a dynamic one. This is the only correct way\nto turn a segment into contacts.\n\n`limit` applies (default 50, max 100) but there is no cursor here:\n`meta.next_cursor` is always `null`.\n\nRequires the `contacts:read` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /segments/{id}/contacts","href":"/api-reference/segments/list-a-segments-contacts"},{"title":"Add contacts to a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /segments/{id}/contacts","href":"/api-reference/segments/add-contacts-to-a-segment"},{"title":"Remove contacts from a segment","description":"Removes contacts from a static segment. The contact ids go in the\nrequest body, as they do when adding. `removed` counts the rows\nactually deleted.\n\nRequires the `contacts:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /segments/{id}/contacts","href":"/api-reference/segments/remove-contacts-from-a-segment"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"Broadcasts","pages":[{"title":"Launch a broadcast","deprecated":null,"version":null,"openapi":"/openapi.yaml post /broadcasts","href":"/api-reference/broadcasts/launch-a-broadcast"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/openapi.yaml get /broadcasts/{id}","href":"/api-reference/broadcasts/get-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks","href":"/api-reference/webhooks/register-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"}]}]}]},"title":"Add contacts to a segment - Watx","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}