{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Reach Marketing \u0026 Automation Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/reach/VGl-b8qK8JmS6Tpg/logo/reach-logo.svg?fit=max\u0026auto=format\u0026n=VGl-b8qK8JmS6Tpg\u0026q=85\u0026s=d233fb37e119c10d0b620741f92a401d","dark":"https://mintcdn.com/reach/VGl-b8qK8JmS6Tpg/logo/reach-logo.svg?fit=max\u0026auto=format\u0026n=VGl-b8qK8JmS6Tpg\u0026q=85\u0026s=d233fb37e119c10d0b620741f92a401d"},"favicon":"https://mintcdn.com/reach/ol2jimDngsGIddSy/favicon.ico?fit=max\u0026auto=format\u0026n=ol2jimDngsGIddSy\u0026q=85\u0026s=4c7acb93bfaae0adf61e04bedfb56dff","navbar":{"links":[{"href":"mailto:support@embedreach.com","label":"Support"}],"primary":{"type":"button","label":"Home","href":"https://embedreach.com"}},"footer":{},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"reach","hasAudioNarration":false,"actualSubdomain":"reach","customDomains":["docs.embedreach.com"],"gitSource":{"type":"github","owner":"embedreach","repo":"reach-mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af34715be090639cae4ead4","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":126},{"language":"default","tag":"API Documentation","count":126},{"language":"default","tag":"Documentation","count":41},{"language":"default","tag":"Default Partner Resources","count":25},{"language":"default","tag":"Core Products","count":19},{"language":"default","tag":"Implementation","count":17},{"language":"default","tag":"Segments","count":14},{"language":"default","tag":"Onboarding","count":14},{"language":"default","tag":"Integration Guide","count":13},{"language":"default","tag":"Engage","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":".card-container{display:flex;flex-direction:column;height:100%;min-height:150px;position:relative}.card-content{flex-grow:1;margin-bottom:40px}.status-container{position:absolute;bottom:16px;left:0;width:100%}.developer-card{min-height:100px}.table-status{display:inline-block;text-align:center}.status-pill-wrapper{margin-top:8px;display:inline-block}.live-pill{background-color:#d1fae5;color:#065f46;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}.beta-pill{background-color:#dbeafe;color:#1e40af;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}.alpha-pill{background-color:#fef3c7;color:#92400e;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}.inquire-pill{background-color:#dfafff;color:#000000;font-size:0.75rem;font-weight:500;padding:0.25rem 0.625rem;border-radius:9999px}"}],"page":{"pagePath":"api-reference/endpoint/post-api-segments","slug":"/api-reference/endpoint/post-api-segments","pageMetadata":{"title":"Create Tenant Segment","openapi":"POST /api/segments","description":"Create a new tenant segment","href":"/api-reference/endpoint/post-api-segments"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new tenant segment\"\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":"Create Tenant Segment","openapi":"POST /api/segments","description":"Create a new tenant segment","href":"/api-reference/endpoint/post-api-segments"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create Tenant Segment","description":"Create a new tenant segment","tags":["Segments"],"parameters":["6ce21a04-a5ce-4075-be34-ff75eca38c17"],"requestBody":"98782288-019a-4b89-832d-7523622e5658","responses":{"200":"5d1a12ff-28e8-481f-bbca-724716d13cc0","400":"41586d94-d55d-47b3-92ab-c63f75633137"},"method":"post","type":"path","servers":["de5a790e-98b7-4d9a-8fb8-d0905fcada60"],"security":[],"path":"/api/segments","baseUrlOptions":["https://api.embedreach.com"],"title":"Create Tenant Segment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6ce21a04-a5ce-4075-be34-ff75eca38c17":{"name":"reach-tenant-id","in":"header","required":false,"schema":{"type":"string","description":"If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.","isRequired":false,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A friendly name for the segment","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"automationId":{"type":"string","format":"uuid","uniqueKey":"automationId","typeLabel":"string\u003cuuid>"},"description":{"type":"string","description":"A friendly description for the segment","uniqueKey":"description","typeLabel":"string"},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","value","operator"],"properties":{"field":{"oneOf":[{"type":"string","enum":["userId","email","phone","firstName","lastName","hipaaConsent"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.field.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.field.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring> | string"},"value":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"string","format":"date-time","uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate","typeLabel":"string\u003cdate-time> · null · object · null"},"endDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate","typeLabel":"string\u003cdate-time> · null · object · null"}},"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"conditions.items.[INDEX].oneOf.0.value.items.[INDEX]","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object"},"description":"The value to compare the field against (string, number, boolean, date)","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.value","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object[]"},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","exists","not_exists","equals_month_day","equals_month_day_year","between_month_day","between_month_day_year","array_contains","contains","not_contains","in"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["property"],"uniqueKey":"conditions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Optional human-readable note describing this clause","uniqueKey":"conditions.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"conditions.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["sql_segment_id"],"properties":{"sql_segment_id":{"type":"string","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.1.sql_segment_id","typeLabel":"string"}},"uniqueKey":"conditions.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Query the subject by its related resources. Nests at most 4 relationship hops.","required":["type","relatedResource","countOperator","countValue","conditions"],"properties":{"type":{"type":"string","enum":["related_resource"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"relatedResource":{"type":"object","properties":{"schemaId":{"type":"string","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.relatedResource.schemaId","typeLabel":"string"},"foreignKeyPath":{"type":"string","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.relatedResource.foreignKeyPath","typeLabel":"string"},"foreignKeyOn":{"type":"string","enum":["current","linked"],"uniqueKey":"conditions.items.[INDEX].oneOf.2.relatedResource.foreignKeyOn","typeLabel":"enum\u003cstring>"}},"required":["schemaId","foreignKeyPath"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.relatedResource","typeLabel":"object"},"countOperator":{"type":"string","enum":["eq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.countOperator","typeLabel":"enum\u003cstring>"},"countValue":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.countValue","typeLabel":"integer"},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","value","operator"],"properties":{"field":{"oneOf":[{"type":"string","enum":["userId","email","phone","firstName","lastName","hipaaConsent"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.field.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.field.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring> | string"},"value":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"string","format":"date-time","uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate","typeLabel":"string\u003cdate-time> · null · object · null"},"endDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate","typeLabel":"string\u003cdate-time> · null · object · null"}},"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value.items.[INDEX]","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object"},"description":"The value to compare the field against (string, number, boolean, date)","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.value","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object[]"},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","exists","not_exists","equals_month_day","equals_month_day_year","between_month_day","between_month_day_year","array_contains","contains","not_contains","in"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["property"],"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Optional human-readable note describing this clause","uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX].oneOf.0","typeLabel":"object"},{}],"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"},"aggregate":{"type":"object","properties":{"function":{"type":"string","enum":["sum","avg","min","max"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.function","typeLabel":"enum\u003cstring>"},"field":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.field","typeLabel":"string"},"operator":{"type":"string","enum":["eq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value.oneOf.0","typeLabel":"number"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value.oneOf.1.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value.oneOf.1.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value.oneOf.1.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate.value","typeLabel":"number | object"}},"required":["function","field","operator","value"],"uniqueKey":"conditions.items.[INDEX].oneOf.2.aggregate","typeLabel":"object"},"description":{"type":"string","uniqueKey":"conditions.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"conditions.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"conditions.items.[INDEX]","typeLabel":"object"},"description":"The conditions to include in the segment (legacy format)","uniqueKey":"conditions","typeLabel":"object[]"},"conditionGroups":{"type":"array","items":{"type":"object","properties":{"logic":{"type":"string","enum":["and","or"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].logic","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","value","operator"],"properties":{"field":{"oneOf":[{"type":"string","enum":["userId","email","phone","firstName","lastName","hipaaConsent"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.field.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.field.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring> | string"},"value":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"string","format":"date-time","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate","typeLabel":"string\u003cdate-time> · null · object · null"},"endDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate","typeLabel":"string\u003cdate-time> · null · object · null"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value.items.[INDEX]","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object"},"description":"The value to compare the field against (string, number, boolean, date)","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.value","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object[]"},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","exists","not_exists","equals_month_day","equals_month_day_year","between_month_day","between_month_day_year","array_contains","contains","not_contains","in"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["property"],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Optional human-readable note describing this clause","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Query the subject by its related resources. Nests at most 4 relationship hops.","required":["type","relatedResource","countOperator","countValue","conditions"],"properties":{"type":{"type":"string","enum":["related_resource"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"relatedResource":{"type":"object","properties":{"schemaId":{"type":"string","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.relatedResource.schemaId","typeLabel":"string"},"foreignKeyPath":{"type":"string","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.relatedResource.foreignKeyPath","typeLabel":"string"},"foreignKeyOn":{"type":"string","enum":["current","linked"],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.relatedResource.foreignKeyOn","typeLabel":"enum\u003cstring>"}},"required":["schemaId","foreignKeyPath"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.relatedResource","typeLabel":"object"},"countOperator":{"type":"string","enum":["eq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.countOperator","typeLabel":"enum\u003cstring>"},"countValue":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.countValue","typeLabel":"integer"},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","value","operator"],"properties":{"field":{"oneOf":[{"type":"string","enum":["userId","email","phone","firstName","lastName","hipaaConsent"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.field.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.field.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring> | string"},"value":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"string","format":"date-time","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.startDate","typeLabel":"string\u003cdate-time> · null · object · null"},"endDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.1","typeLabel":"null"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.2","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5.endDate","typeLabel":"string\u003cdate-time> · null · object · null"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value.items.[INDEX]","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object"},"description":"The value to compare the field against (string, number, boolean, date)","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.value","typeLabel":"string · number · boolean · string\u003cdate-time> · object · object[]"},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","exists","not_exists","equals_month_day","equals_month_day_year","between_month_day","between_month_day_year","array_contains","contains","not_contains","in"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["property"],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Optional human-readable note describing this clause","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX].oneOf.0","typeLabel":"object"},{}],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"},"aggregate":{"type":"object","properties":{"function":{"type":"string","enum":["sum","avg","min","max"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.function","typeLabel":"enum\u003cstring>"},"field":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.field","typeLabel":"string"},"operator":{"type":"string","enum":["eq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value.oneOf.0","typeLabel":"number"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value.oneOf.1.value","typeLabel":"integer"},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value.oneOf.1.unit","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["before","after"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value.oneOf.1.direction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate.value","typeLabel":"number | object"}},"required":["function","field","operator","value"],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.aggregate","typeLabel":"object"},"description":{"type":"string","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Conditions combined with AND/OR logic. Groups may nest to any depth.","required":["logic","conditions"],"properties":{"logic":{"type":"string","enum":["and","or"],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.2.logic","typeLabel":"enum\u003cstring>"},"conditions":{"oneOf":[{"$circularRef":"0c37f82c-3722-4598-9da9-1502db50086d","isRequired":true}],"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.2.conditions","typeLabel":"any"},"type":{"type":"string","enum":["group"],"default":"group","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"conditionGroups.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"conditionGroups.items.[INDEX].conditions","typeLabel":"object[]"},"type":{"type":"string","enum":["group"],"default":"group","uniqueKey":"conditionGroups.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","uniqueKey":"conditionGroups.items.[INDEX].description","typeLabel":"string"}},"required":["logic","conditions"],"description":"Conditions combined with AND/OR logic. Groups may nest to any depth.","uniqueKey":"conditionGroups.items.[INDEX]","typeLabel":"object"},"description":"Condition groups with AND/OR logic and related resource support (new format)","uniqueKey":"conditionGroups","typeLabel":"object[]"},"type":{"type":"string","enum":["custom","one_off"],"default":"custom","description":"The type of segment","uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","automationId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","description":"\u003cstring>","conditions":[{"value":["\u003cstring>"],"type":"property","description":"\u003cstring>"}],"conditionGroups":[{"conditions":[{"value":["\u003cstring>"],"type":"property","description":"\u003cstring>"}],"type":"group","description":"\u003cstring>"}],"type":"custom"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5d1a12ff-28e8-481f-bbca-724716d13cc0":{"description":"Status 200 response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the segment","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","description":"A friendly name for the segment","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the segment was created","isRequired":true,"uniqueKey":"data.createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the segment was created","isRequired":true,"uniqueKey":"data.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["all_users","managed","custom","one_off","sql"],"description":"The type of segment","isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"ownerAutomationId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.ownerAutomationId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.ownerAutomationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.ownerAutomationId","typeLabel":"string\u003cuuid> | null"},"description":{"type":"string","description":"A friendly description for the segment","uniqueKey":"data.description","typeLabel":"string"}},"required":["id","name","createdAt","type"],"uniqueKey":"data","typeLabel":"object"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","data":{"id":"\u003cstring>","name":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","type":"all_users","ownerAutomationId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","description":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"41586d94-d55d-47b3-92ab-c63f75633137":{"description":"Bad Request - Validation or request error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","enum":[false],"default":false,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"Optional array of specific validation errors","uniqueKey":"errors","typeLabel":"string[]"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":false,"errors":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"de5a790e-98b7-4d9a-8fb8-d0905fcada60":{"url":"https://api.embedreach.com","description":"Production server"}},"schemas":{"0c37f82c-3722-4598-9da9-1502db50086d":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","value","operator"],"properties":{"field":{"oneOf":[{"type":"string","enum":["userId","email","phone","firstName","lastName","hipaaConsent"],"isRequired":true},{"type":"string","isRequired":true}],"isRequired":true},"value":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}}},{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true},{"type":"null","format":"date-time","isRequired":true},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}},"isRequired":true},{"type":"null","isRequired":true}],"isRequired":true},"endDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true},{"type":"null","format":"date-time","isRequired":true},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}},"isRequired":true},{"type":"null","isRequired":true}],"isRequired":true}}}]},"description":"The value to compare the field against (string, number, boolean, date)","isRequired":true},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","exists","not_exists","equals_month_day","equals_month_day_year","between_month_day","between_month_day_year","array_contains","contains","not_contains","in"],"isRequired":true},"type":{"type":"string","enum":["property"]},"description":{"type":"string","description":"Optional human-readable note describing this clause"}}},{"type":"object","description":"Query the subject by its related resources. Nests at most 4 relationship hops.","required":["type","relatedResource","countOperator","countValue","conditions"],"properties":{"type":{"type":"string","enum":["related_resource"],"isRequired":true},"relatedResource":{"type":"object","properties":{"schemaId":{"type":"string","isRequired":true},"foreignKeyPath":{"type":"string","isRequired":true},"foreignKeyOn":{"type":"string","enum":["current","linked"]}},"required":["schemaId","foreignKeyPath"],"isRequired":true},"countOperator":{"type":"string","enum":["eq","gt","gte","lt","lte"],"isRequired":true},"countValue":{"type":"integer","minimum":0,"isRequired":true},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","value","operator"],"properties":{"field":{"oneOf":[{"type":"string","enum":["userId","email","phone","firstName","lastName","hipaaConsent"],"isRequired":true},{"type":"string","isRequired":true}],"isRequired":true},"value":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time"},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}}},{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true},{"type":"null","format":"date-time","isRequired":true},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}},"isRequired":true},{"type":"null","isRequired":true}],"isRequired":true},"endDate":{"oneOf":[{"type":"string","format":"date-time","isRequired":true},{"type":"null","format":"date-time","isRequired":true},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}},"isRequired":true},{"type":"null","isRequired":true}],"isRequired":true}}}]},"description":"The value to compare the field against (string, number, boolean, date)","isRequired":true},"operator":{"type":"string","enum":["equals","not_equals","greater_than","less_than","exists","not_exists","equals_month_day","equals_month_day_year","between_month_day","between_month_day_year","array_contains","contains","not_contains","in"],"isRequired":true},"type":{"type":"string","enum":["property"]},"description":{"type":"string","description":"Optional human-readable note describing this clause"}}},{}]},"isRequired":true},"aggregate":{"type":"object","properties":{"function":{"type":"string","enum":["sum","avg","min","max"],"isRequired":true},"field":{"type":"string","minLength":1,"isRequired":true},"operator":{"type":"string","enum":["eq","gt","gte","lt","lte"],"isRequired":true},"value":{"oneOf":[{"type":"number","isRequired":true},{"type":"object","required":["type","value","unit","direction"],"properties":{"type":{"type":"string","enum":["relative"],"isRequired":true},"value":{"type":"integer","minimum":0,"description":"Number of date units to add/subtract from today","isRequired":true},"unit":{"type":"string","enum":["days","months","years"],"isRequired":true},"direction":{"type":"string","enum":["before","after"],"isRequired":true}},"isRequired":true}],"isRequired":true}},"required":["function","field","operator","value"]},"description":{"type":"string"}}},{"type":"object","description":"Conditions combined with AND/OR logic. Groups may nest to any depth.","required":["logic","conditions"],"properties":{"logic":{"type":"string","enum":["and","or"],"isRequired":true},"conditions":{"oneOf":[{"isRequired":true}],"isRequired":true},"type":{"type":"string","enum":["group"],"default":"group"},"description":{"type":"string"}}}]}}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"reach","siteName":"Reach Marketing \u0026 Automation Documentation","title":"Create Tenant Segment - Reach Marketing \u0026 Automation Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T21:44:11.470Z","originalFileLocation":"api-reference/endpoint/post-api-segments.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=\"Create a new tenant segment\">\u003cmeta data-mint-head name=\"application-name\" content=\"Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_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/reach/Xd06gTcEFFBFlU7h/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Tenant Segment - Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new tenant segment\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://reach.mintlify.site/_mintlify/api/og/v2?division=Segments\u0026amp;title=Create+Tenant+Segment\u0026amp;description=Create+a+new+tenant+segment\u0026amp;theme=8f2be3aa00eff555d7076746\u0026amp;signature=acf0248b43a08f999819cb97bcc04562676a149d6be337b47e69cceff9430517\">\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=\"Create Tenant Segment - Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new tenant segment\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://reach.mintlify.site/_mintlify/api/og/v2?division=Segments\u0026amp;title=Create+Tenant+Segment\u0026amp;description=Create+a+new+tenant+segment\u0026amp;theme=8f2be3aa00eff555d7076746\u0026amp;signature=acf0248b43a08f999819cb97bcc04562676a149d6be337b47e69cceff9430517\">\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/reach/Xd06gTcEFFBFlU7h/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Reach Marketing \u0026amp; Automation Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/post-api-segments.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.embedreach.com/#organization\",\"name\":\"Reach Marketing \u0026 Automation Documentation\",\"url\":\"https://docs.embedreach.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/reach/VGl-b8qK8JmS6Tpg/logo/reach-logo.svg?fit=max\u0026auto=format\u0026n=VGl-b8qK8JmS6Tpg\u0026q=85\u0026s=d233fb37e119c10d0b620741f92a401d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.embedreach.com#website\",\"name\":\"Reach Marketing \u0026 Automation Documentation\",\"url\":\"https://docs.embedreach.com\",\"publisher\":{\"@id\":\"https://docs.embedreach.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments#webpage\",\"url\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments\",\"name\":\"Create Tenant Segment\",\"description\":\"Create a new tenant segment\",\"dateModified\":\"2026-01-28T21:44:11.470Z\",\"isPartOf\":{\"@id\":\"https://docs.embedreach.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.embedreach.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Segments\",\"item\":\"https://docs.embedreach.com/api-reference/endpoint/delete-api-segments-id\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Tenant Segment\",\"item\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments#apireference\",\"headline\":\"Create Tenant Segment\",\"name\":\"Create Tenant Segment\",\"description\":\"Create a new tenant segment\",\"url\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments\",\"mainEntityOfPage\":{\"@id\":\"https://docs.embedreach.com/api-reference/endpoint/post-api-segments#webpage\"},\"dateModified\":\"2026-01-28T21:44:11.470Z\",\"publisher\":{\"@id\":\"https://docs.embedreach.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.embedreach.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Reach Marketing \u0026 Automation Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Reach Marketing \u0026 Automation Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/post-api-segments.md","siteName":"Reach Marketing \u0026 Automation Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/home/welcome"}]},{"tab":"Onboarding","pages":[{"title":"Onboarding","href":"/onboarding/overview"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Automation Categories","pages":[{"title":"Delete an automation category","openapi":"DELETE /partner/automation-categories/{id}","href":"/api-reference/endpoint/delete-partner-automation-categories-id"},{"title":"Get partner automation categories","href":"/api-reference/endpoint/get-partner-automation-categories"},{"title":"Get automation category usage","openapi":"GET /partner/automation-categories/{id}/usage","href":"/api-reference/endpoint/get-partner-automation-categories-id-usage"},{"title":"Get automation template categories","openapi":"GET /partner/automation-templates/{templateId}/categories","href":"/api-reference/endpoint/get-partner-automation-templates-templateid-categories"},{"title":"Update an automation category","openapi":"PATCH /partner/automation-categories/{id}","href":"/api-reference/endpoint/patch-partner-automation-categories-id"},{"title":"Create an automation category","openapi":"POST /partner/automation-categories","href":"/api-reference/endpoint/post-partner-automation-categories"},{"title":"Put partner automation templates templateid categories","href":"/api-reference/endpoint/put-partner-automation-templates-templateid-categories"}]},{"group":"Automation Templates","pages":[{"title":"Overview","href":"/api-reference/endpoint/automation-templates-introduction"},{"title":"List automation templates","openapi":"GET /partner/automation-templates","href":"/api-reference/endpoint/get-partner-automation-templates"},{"title":"Get automation template by ID","openapi":"GET /partner/automation-templates/{id}","href":"/api-reference/endpoint/get-partner-automation-templates-id"},{"title":"Get automation template sync","openapi":"GET /partner/automation-templates/{id}/syncs/{jobId}","href":"/api-reference/endpoint/get-partner-automation-templates-id-syncs-jobid"},{"title":"Update automation template","openapi":"PATCH /partner/automation-templates/{id}","href":"/api-reference/endpoint/patch-partner-automation-templates-id"},{"title":"Create automation template","openapi":"POST /partner/automation-templates","href":"/api-reference/endpoint/post-partner-automation-templates"},{"title":"Copy an automation template","openapi":"POST /partner/automation-templates/{id}/copy","href":"/api-reference/endpoint/post-partner-automation-templates-id-copy"},{"title":"Post partner automation templates id syncs","href":"/api-reference/endpoint/post-partner-automation-templates-id-syncs"}]},{"group":"Batch Operations","pages":[{"title":"List Batch Jobs","openapi":"GET /api/batches","href":"/api-reference/endpoint/get-api-batches"},{"title":"Get Batch Status","openapi":"GET /api/batches/{batchId}","href":"/api-reference/endpoint/get-api-batches-batchid"}]},{"group":"Channel Accounts","pages":[{"title":"List Channel Accounts","openapi":"GET /api/channel/accounts","href":"/api-reference/endpoint/get-api-channel-accounts"},{"title":"Update Channel Account","openapi":"PATCH /api/channel/accounts/{id}","href":"/api-reference/endpoint/patch-api-channel-accounts-id"},{"title":"Create Channel Account","openapi":"POST /api/channel/accounts","href":"/api-reference/endpoint/post-api-channel-accounts"}]},{"group":"Channel Integrations","pages":[{"title":"List Channel Integrations","openapi":"GET /partner/channel/integrations","href":"/api-reference/endpoint/get-partner-channel-integrations"},{"title":"Update Channel Integration","openapi":"PATCH /partner/channel/integrations/{id}","href":"/api-reference/endpoint/patch-partner-channel-integrations-id"},{"title":"Create Channel Integration","openapi":"POST /partner/channel/integrations","href":"/api-reference/endpoint/post-partner-channel-integrations"}]},{"group":"Channel Senders","pages":[{"title":"List Channel Senders","openapi":"GET /api/channel/senders","href":"/api-reference/endpoint/get-api-channel-senders"},{"title":"Update Channel Sender","openapi":"PATCH /api/channel/senders/{id}","href":"/api-reference/endpoint/patch-api-channel-senders-id"},{"title":"Create Channel Sender","openapi":"POST /api/channel/senders","href":"/api-reference/endpoint/post-api-channel-senders"}]},{"group":"Communication Groups","pages":[{"title":"List Communication Groups","openapi":"GET /api/communication-groups","href":"/api-reference/endpoint/get-api-communication-groups"},{"title":"Get Link Click Statistics","openapi":"GET /api/communication-groups/{automationId}/link-click-stats","href":"/api-reference/endpoint/get-api-communication-groups-automationid-link-click-stats"},{"title":"Get Communication Group","openapi":"GET /api/communication-groups/{id}","href":"/api-reference/endpoint/get-api-communication-groups-id"},{"title":"Get Available Merge Fields","openapi":"GET /api/communication-groups/{id}/merge-fields","href":"/api-reference/endpoint/get-api-communication-groups-id-merge-fields"},{"title":"Update Communication Group","openapi":"PATCH /api/communication-groups/{id}","href":"/api-reference/endpoint/patch-api-communication-groups-id"},{"title":"Create Communication Group","openapi":"POST /api/communication-groups","href":"/api-reference/endpoint/post-api-communication-groups"},{"title":"Reset Communication Group to Default Template","openapi":"POST /api/communication-groups/{communicationGroupId}/{automationId}/reset","href":"/api-reference/endpoint/post-api-communication-groups-communicationgroupid-automationid-reset"},{"title":"Send Test Email/SMS","openapi":"POST /api/communication-groups/{id}/test","href":"/api-reference/endpoint/post-api-communication-groups-id-test"},{"title":"Save Email Auto-Save","openapi":"PUT /api/communication-groups/{id}/email-auto-save","href":"/api-reference/endpoint/put-api-communication-groups-id-email-auto-save"}]},{"group":"Default Partner Resources","pages":[{"title":"Default Partner Resources","href":"/api-reference/endpoint/default-partner-resources-introduction"},{"title":"Batch Delete Customer Resources","openapi":"DELETE /api/resources/customers/batch","href":"/api-reference/endpoint/delete-api-resources-customers-batch"},{"title":"Delete Customer Resource","openapi":"DELETE /api/resources/customers/{externalId}","href":"/api-reference/endpoint/delete-api-resources-customers-externalid"},{"title":"Batch Delete Location Resources","openapi":"DELETE /api/resources/locations/batch","href":"/api-reference/endpoint/delete-api-resources-locations-batch"},{"title":"Delete Location Resource","openapi":"DELETE /api/resources/locations/{externalId}","href":"/api-reference/endpoint/delete-api-resources-locations-externalid"},{"title":"Batch Delete Transaction Resources","openapi":"DELETE /api/resources/transactions/batch","href":"/api-reference/endpoint/delete-api-resources-transactions-batch"},{"title":"Delete Transaction Resource","openapi":"DELETE /api/resources/transactions/{externalId}","href":"/api-reference/endpoint/delete-api-resources-transactions-externalid"},{"title":"List Customer Resources","openapi":"GET /api/resources/customers","href":"/api-reference/endpoint/get-api-resources-customers"},{"title":"Get Customer Resource","openapi":"GET /api/resources/customers/{externalId}","href":"/api-reference/endpoint/get-api-resources-customers-externalid"},{"title":"List Location Resources","openapi":"GET /api/resources/locations","href":"/api-reference/endpoint/get-api-resources-locations"},{"title":"Get Location Resource","openapi":"GET /api/resources/locations/{externalId}","href":"/api-reference/endpoint/get-api-resources-locations-externalid"},{"title":"List Transaction Resources","openapi":"GET /api/resources/transactions","href":"/api-reference/endpoint/get-api-resources-transactions"},{"title":"Get Transaction Resource","openapi":"GET /api/resources/transactions/{externalId}","href":"/api-reference/endpoint/get-api-resources-transactions-externalid"},{"title":"Batch Patch Customer Resources","openapi":"PATCH /api/resources/customers/batch","href":"/api-reference/endpoint/patch-api-resources-customers-batch"},{"title":"Patch Customer Resource","openapi":"PATCH /api/resources/customers/{externalId}","href":"/api-reference/endpoint/patch-api-resources-customers-externalid"},{"title":"Batch Patch Location Resources","openapi":"PATCH /api/resources/locations/batch","href":"/api-reference/endpoint/patch-api-resources-locations-batch"},{"title":"Patch Location Resource","openapi":"PATCH /api/resources/locations/{externalId}","href":"/api-reference/endpoint/patch-api-resources-locations-externalid"},{"title":"Batch Patch Transaction Resources","openapi":"PATCH /api/resources/transactions/batch","href":"/api-reference/endpoint/patch-api-resources-transactions-batch"},{"title":"Patch Transaction Resource","openapi":"PATCH /api/resources/transactions/{externalId}","href":"/api-reference/endpoint/patch-api-resources-transactions-externalid"},{"title":"Create Customer Resource","openapi":"POST /api/resources/customers","href":"/api-reference/endpoint/post-api-resources-customers"},{"title":"Batch Upload Customer Resources","openapi":"POST /api/resources/customers/batch","href":"/api-reference/endpoint/post-api-resources-customers-batch"},{"title":"Create Location Resource","openapi":"POST /api/resources/locations","href":"/api-reference/endpoint/post-api-resources-locations"},{"title":"Batch Upload Location Resources","openapi":"POST /api/resources/locations/batch","href":"/api-reference/endpoint/post-api-resources-locations-batch"},{"title":"Create Transaction Resource","openapi":"POST /api/resources/transactions","href":"/api-reference/endpoint/post-api-resources-transactions"},{"title":"Batch Upload Transaction Resources","openapi":"POST /api/resources/transactions/batch","href":"/api-reference/endpoint/post-api-resources-transactions-batch"}]},{"group":"Engage Library","pages":[{"title":"Get partner engage library tenantid","href":"/api-reference/endpoint/get-partner-engage-library-tenantid"},{"title":"Get Tenant Engage Library Sync Status","openapi":"GET /partner/engage-library/{tenantId}/jobs/{jobId}","href":"/api-reference/endpoint/get-partner-engage-library-tenantid-jobs-jobid"},{"title":"Sync Tenant Engage Library","openapi":"PATCH /partner/engage-library/{tenantId}","href":"/api-reference/endpoint/patch-partner-engage-library-tenantid"}]},{"group":"Partner DB","pages":[{"title":"Upload SQLite database for a tenant","openapi":"POST /api/partner-db/upload","href":"/api-reference/endpoint/post-api-partner-db-upload"},{"title":"Upload SQLite database (platform-wide)","openapi":"POST /partner/partner-db/upload","href":"/api-reference/endpoint/post-partner-partner-db-upload"}]},{"group":"Partner Engage","pages":[{"title":"Get Engage usage per tenant","openapi":"GET /partner/engage/tenants","href":"/api-reference/endpoint/get-partner-engage-tenants"},{"title":"Get partner-wide Engage tenant usage summary","openapi":"GET /partner/engage/tenants/summary","href":"/api-reference/endpoint/get-partner-engage-tenants-summary"}]},{"group":"Partner Resources","pages":[{"title":"Batch Delete Resources","openapi":"DELETE /api/resources/{schemaDefinitionNameOrId}/batch","href":"/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-batch"},{"title":"Delete Resource","openapi":"DELETE /api/resources/{schemaDefinitionNameOrId}/{externalId}","href":"/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-externalid"},{"title":"Get Resource Counts","openapi":"GET /api/resources/counts","href":"/api-reference/endpoint/get-api-resources-counts"},{"title":"List Resources","openapi":"GET /api/resources/{schemaDefinitionNameOrId}","href":"/api-reference/endpoint/get-api-resources-schemadefinitionnameorid"},{"title":"Get Resource","openapi":"GET /api/resources/{schemaDefinitionNameOrId}/{externalId}","href":"/api-reference/endpoint/get-api-resources-schemadefinitionnameorid-externalid"},{"title":"Get Resource Counts for All Tenants","openapi":"GET /partner/resources/counts","href":"/api-reference/endpoint/get-partner-resources-counts"},{"title":"Batch Patch Resources","openapi":"PATCH /api/resources/{schemaDefinitionNameOrId}/batch","href":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-batch"},{"title":"Patch Resource","openapi":"PATCH /api/resources/{schemaDefinitionNameOrId}/{externalId}","href":"/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid"},{"title":"Upload Resource","openapi":"POST /api/resources/{schemaDefinitionNameOrId}","href":"/api-reference/endpoint/post-api-resources-schemadefinitionnameorid"},{"title":"Batch Upload Resources","openapi":"POST /api/resources/{schemaDefinitionNameOrId}/batch","href":"/api-reference/endpoint/post-api-resources-schemadefinitionnameorid-batch"}]},{"group":"Partner Voice","pages":[{"title":"Get voice call aggregates per tenant","openapi":"GET /partner/voice/calls/aggregates","href":"/api-reference/endpoint/get-partner-voice-calls-aggregates"},{"title":"Get partner-wide voice call aggregate summary","openapi":"GET /partner/voice/calls/aggregates/summary","href":"/api-reference/endpoint/get-partner-voice-calls-aggregates-summary"},{"title":"Update an active Voice call","openapi":"PATCH /partner/voice/active-calls/{callId}","href":"/api-reference/endpoint/patch-partner-voice-active-calls-callid"}]},{"group":"Schema Definitions","pages":[{"title":"Overview","href":"/api-reference/endpoint/schema-definitions-introduction"},{"title":"Deactivate Schema","openapi":"DELETE /partner/schema-definitions/{schemaIdOrName}","href":"/api-reference/endpoint/delete-partner-schema-definitions-schemaidorname"},{"title":"List Schemas","openapi":"GET /partner/schema-definitions","href":"/api-reference/endpoint/get-partner-schema-definitions"},{"title":"Get Schema","openapi":"GET /partner/schema-definitions/{schemaIdOrName}","href":"/api-reference/endpoint/get-partner-schema-definitions-schemaidorname"},{"title":"Get Schema Update","openapi":"GET /partner/schema-definitions/{schemaIdOrName}/updates/{updateId}","href":"/api-reference/endpoint/get-partner-schema-definitions-schemaidorname-updates-updateid"},{"title":"Create Schema","openapi":"POST /partner/schema-definitions","href":"/api-reference/endpoint/post-partner-schema-definitions"},{"title":"Update Schema","openapi":"POST /partner/schema-definitions/{schemaIdOrName}","href":"/api-reference/endpoint/post-partner-schema-definitions-schemaidorname"}]},{"group":"Schema Mappings","pages":[{"title":"Overview","href":"/api-reference/endpoint/schema-mappings-introduction"},{"title":"Get Partner Schema Mappings","openapi":"GET /partner/schema-mappings","href":"/api-reference/endpoint/get-partner-schema-mappings"},{"title":"Update Partner Schema Mappings","openapi":"POST /partner/schema-mappings","href":"/api-reference/endpoint/post-partner-schema-mappings"}]},{"group":"Segments","pages":[{"title":"Delete Tenant Segment","openapi":"DELETE /api/segments/{id}","href":"/api-reference/endpoint/delete-api-segments-id"},{"title":"List Tenant Segments","openapi":"GET /api/segments","href":"/api-reference/endpoint/get-api-segments"},{"title":"Get Segment Conditions","openapi":"GET /api/segments/conditions","href":"/api-reference/endpoint/get-api-segments-conditions"},{"title":"Find Segment Field Values","openapi":"GET /api/segments/field-values","href":"/api-reference/endpoint/get-api-segments-field-values"},{"title":"Get Tenant Segment","openapi":"GET /api/segments/{id}","href":"/api-reference/endpoint/get-api-segments-id"},{"title":"List Automations Using Tenant Segment","openapi":"GET /api/segments/{id}/automations","href":"/api-reference/endpoint/get-api-segments-id-automations"},{"title":"Get Users in Tenant Segment","openapi":"GET /api/segments/{id}/users","href":"/api-reference/endpoint/get-api-segments-id-users"},{"title":"Get Segment Schema Catalog","openapi":"GET /api/segments/schema-catalog","href":"/api-reference/endpoint/get-api-segments-schema-catalog"},{"title":"Get Segments by User External ID","openapi":"GET /api/segments/user/{externalId}","href":"/api-reference/endpoint/get-api-segments-user-externalid"},{"title":"Update Tenant Segment","openapi":"PATCH /api/segments/{id}","description":"Update a tenant segment","href":"/api-reference/endpoint/patch-api-segments-id"},{"title":"Create Tenant Segment","openapi":"POST /api/segments","href":"/api-reference/endpoint/post-api-segments"},{"title":"Enable Standard Google Ads Audiences","openapi":"POST /api/segments/audience-uploads/standard","description":"Create or reuse standard tenant segments and enable Google Ads audience publishing for a connected Google ad account.","href":"/api-reference/endpoint/post-api-segments-audience-uploads-standard"},{"title":"Get Count of Users in Include and Exclude Segment","openapi":"POST /api/segments/count","href":"/api-reference/endpoint/post-api-segments-count"}]},{"group":"Sending Domains","pages":[{"title":"List Sending Domains","openapi":"GET /api/sending-domains","href":"/api-reference/endpoint/get-api-sending-domains"},{"title":"Get Sending Domain","openapi":"GET /api/sending-domains/{id}","href":"/api-reference/endpoint/get-api-sending-domains-id"},{"title":"Create Sending Domain","openapi":"POST /api/sending-domains","href":"/api-reference/endpoint/post-api-sending-domains"},{"title":"Create Entri Token","openapi":"POST /api/sending-domains/entri-token","href":"/api-reference/endpoint/post-api-sending-domains-entri-token"},{"title":"Start Sending Domain Verification","openapi":"POST /api/sending-domains/{id}/verifications","href":"/api-reference/endpoint/post-api-sending-domains-id-verifications"}]},{"group":"Subscriptions","pages":[{"title":"List Subscriptions","openapi":"GET /api/subscriptions","href":"/api-reference/endpoint/get-api-subscriptions"},{"title":"Get Subscription by External ID","openapi":"GET /api/subscriptions/{externalId}","href":"/api-reference/endpoint/get-api-subscriptions-externalid"}]},{"group":"Tenant Automation","pages":[{"title":"Delete api automation categories id","href":"/api-reference/endpoint/delete-api-automation-categories-id"},{"title":"Get api automation categories","href":"/api-reference/endpoint/get-api-automation-categories"},{"title":"List Tenant Automations","openapi":"GET /api/automations","href":"/api-reference/endpoint/get-api-automations"},{"title":"Get Broadcast Experience","openapi":"GET /api/automations/has-broadcast-experience","href":"/api-reference/endpoint/get-api-automations-has-broadcast-experience"},{"title":"Get Tenant Automation","openapi":"GET /api/automations/{id}","href":"/api-reference/endpoint/get-api-automations-id"},{"title":"Get Recipients for Tenant Automation","openapi":"GET /api/automations/{id}/recipients","href":"/api-reference/endpoint/get-api-automations-id-recipients"},{"title":"Get Statistics for Tenant Automation","openapi":"GET /api/automations/{id}/statistics","href":"/api-reference/endpoint/get-api-automations-id-statistics"},{"title":"Get Statistics for All Tenant Automations","openapi":"GET /api/automations/statistics","href":"/api-reference/endpoint/get-api-automations-statistics"},{"title":"Patch api automation categories id","href":"/api-reference/endpoint/patch-api-automation-categories-id"},{"title":"Update Tenant Automation","openapi":"PATCH /api/automations/{id}","href":"/api-reference/endpoint/patch-api-automations-id"},{"title":"Post api automation categories","href":"/api-reference/endpoint/post-api-automation-categories"},{"title":"Create or Duplicate Tenant Automation","openapi":"POST /api/automations","href":"/api-reference/endpoint/post-api-automations"},{"title":"Put api automations id categories","href":"/api-reference/endpoint/put-api-automations-id-categories"}]},{"group":"Tenant Usage","pages":[{"title":"List tenant usage","openapi":"GET /partner/tenant-usage","href":"/api-reference/endpoint/get-partner-tenant-usage"},{"title":"Get usage for one tenant","openapi":"GET /partner/tenant-usage/{tenantId}","href":"/api-reference/endpoint/get-partner-tenant-usage-tenantid"}]},{"group":"Tenants","pages":[{"title":"Overview","href":"/api-reference/endpoint/tenants-introduction"},{"title":"Delete Tenant","openapi":"DELETE /partner/tenants/{id}","href":"/api-reference/endpoint/delete-partner-tenants-id"},{"title":"List Tenants","openapi":"GET /partner/tenants","href":"/api-reference/endpoint/get-partner-tenants"},{"title":"Get Tenant","openapi":"GET /partner/tenants/{id}","href":"/api-reference/endpoint/get-partner-tenants-id"},{"title":"Get Tenant Resource Statistics","openapi":"GET /partner/tenants/{id}/resource-stats","href":"/api-reference/endpoint/get-partner-tenants-id-resource-stats"},{"title":"Get SMS Registration Status","openapi":"GET /partner/tenants/{id}/sms-registration","href":"/api-reference/endpoint/get-partner-tenants-id-sms-registration"},{"title":"Update Tenant","openapi":"PATCH /partner/tenants/{id}","href":"/api-reference/endpoint/patch-partner-tenants-id"},{"title":"Create Tenant","openapi":"POST /partner/tenants","href":"/api-reference/endpoint/post-partner-tenants"},{"title":"Reactivate Tenant","openapi":"POST /partner/tenants/{id}/reactivate","href":"/api-reference/endpoint/post-partner-tenants-id-reactivate"}]}]}]}]},"basePath":"","title":"Create Tenant Segment - Reach Marketing \u0026 Automation Documentation","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}