{
"error": {
"code": "REFERENCE_NOT_FOUND",
"message": "A condition refers to something that is not in your account",
"retryable": false,
"details": {
"path": "filter.conditions.0.documentId",
"kind": "document"
}
}
}
{
"error": {
"code": "REFERENCE_NOT_FOUND",
"message": "A condition refers to something that is not in your account",
"retryable": false,
"details": {
"path": "filter.conditions.0.documentId",
"kind": "document"
}
}
}
A key generated from Settings → Developers, sent as
Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>. Keys
carry explicit scopes — each endpoint states the one it requires.
The full key is shown exactly once at generation time and cannot be
retrieved again; only the keyId prefix is shown afterward. A
revoked key fails auth on its very next request.
The rule that decides who is in a group. A contact is in the group when it
matches conditions (joined by operator), matches every condition in
requiredConditions, and matches none of excludeConditions. Each list holds
at most 20 conditions, and at least one condition is needed across the three
lists (otherwise 422 EMPTY_FILTER). Unsubscribed contacts are never members.
See Group conditions.
How many contacts the rule matches now (never unsubscribed contacts). A count only.
Required range: x >= 0
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DocuRise Developer Docs","colors":{"primary":"#DA350B","light":"#FF3C00","dark":"#AE2D13"},"logo":"https://mintcdn.com/docu-rise/ClhhLqgPXOXvt7Zz/logo.png?fit=max\u0026auto=format\u0026n=ClhhLqgPXOXvt7Zz\u0026q=85\u0026s=b73379a7630a12945d164a128a6ddb12","favicon":"https://mintcdn.com/docu-rise/uxv1U4cKVTA4xM3l/favicon.png?fit=max\u0026auto=format\u0026n=uxv1U4cKVTA4xM3l\u0026q=85\u0026s=0b88e688751814cb08931184873ba0be","appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://docurise.io/dashboard"}},"footer":{"socials":{}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"ko","href":"ko"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"docu-rise","hasAudioNarration":false,"actualSubdomain":"docu-rise","customDomains":["docurise.io"],"gitSource":{"type":"github","owner":"ireneshlee814","repo":"docurise","deployBranch":"master","contentDirectory":"docs-content","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adf1a4ed7cf896c8ad7ba87","collectionId":"94de5c8f-93e4-44a5-af98-0fc3dd32e1b8","liveDeploymentHistoryId":"6adf1a4ed7cf896c8ad7ba87","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adf7b89b80f21f061134342","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"en","tag":"API Reference","count":27},{"language":"ko","tag":"API Reference","count":27},{"language":"en","tag":"Documents","count":8},{"language":"ko","tag":"문서","count":8},{"language":"en","tag":"Audiences","count":7},{"language":"en","tag":"Guides","count":7},{"language":"ko","tag":"오디언스","count":7},{"language":"ko","tag":"가이드","count":7},{"language":"en","tag":"Instagram","count":4},{"language":"ko","tag":"Instagram","count":4},{"language":"en","tag":"Email","count":3},{"language":"en","tag":"Get Started","count":3},{"language":"ko","tag":"이메일","count":3},{"language":"ko","tag":"시작하기","count":3},{"language":"en","tag":"Contacts","count":2},{"language":"en","tag":"Reference","count":2},{"language":"en","tag":"AI Apps","count":2},{"language":"ko","tag":"연락처","count":2},{"language":"ko","tag":"레퍼런스","count":2},{"language":"ko","tag":"AI 앱","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/preview-segment","slug":"/api-reference/preview-segment","pageMetadata":{"title":"Preview a group rule","description":"Count who a rule would match without saving anything","openapi":"api-reference/openapi.yaml POST /api/preview/segments/preview","href":"/api-reference/preview-segment"},"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: \"Count who a rule would match without saving anything\"\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":"Preview a group rule","description":"Count who a rule would match without saving anything","openapi":"api-reference/openapi.yaml POST /api/preview/segments/preview","href":"/api-reference/preview-segment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"previewSegment","tags":["Audiences"],"summary":"Preview a group rule","description":"Count who a rule would match without saving anything","security":["647ef4a9-78cf-4a87-8ebe-f85b3fae54c2"],"requestBody":"d9d4dbba-a138-4ca3-bf60-0295db3b1409","responses":{"200":"c87d4828-2906-4270-8758-c4b73d075ad4","400":"da0816c8-0810-4ae7-b2bd-7cb153b504f6","401":"cc4d14b6-79f1-4885-b354-c1f0188f8323","403":"7b2bf750-7e7e-49dd-8b1e-ae36c3c5c83c","404":"a964ae9c-1054-4fe0-b594-b369ca50ac5e","422":"98899c2c-c4bf-4523-bcbf-44698f2bc67c","429":"32cbf27f-bd66-475b-8572-e5bb7b0534e1","500":"53816db7-3ca9-4ccb-a250-3b54bd8bc4db","503":"f3e4763d-35e0-4507-9766-04f2196a3817"},"x-codeSamples":[{"lang":"bash","label":"curl","source":"curl -X POST 'https://docurise.io/api/preview/segments/preview' \\\n -H 'Authorization: Bearer dr_live_\u003ckeyId>_\u003csecret>' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"filter\": {\n \"operator\": \"OR\",\n \"conditions\": [\n { \"field\": \"tag\", \"operator\": \"has\", \"value\": \"vip\" },\n { \"field\": \"payment_status\", \"operator\": \"is\", \"value\": \"paid\" }\n ]\n }\n }'\n"}],"method":"post","type":"path","servers":["7304e0b3-d967-42dc-a414-a807932689bf"],"path":"/api/preview/segments/preview","baseUrlOptions":["https://docurise.io"],"title":"Preview a group rule","codeSamples":[{"label":"curl","lang":"bash","source":"curl -X POST 'https://docurise.io/api/preview/segments/preview' \\\n -H 'Authorization: Bearer dr_live_\u003ckeyId>_\u003csecret>' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"filter\": {\n \"operator\": \"OR\",\n \"conditions\": [\n { \"field\": \"tag\", \"operator\": \"has\", \"value\": \"vip\" },\n { \"field\": \"payment_status\", \"operator\": \"is\", \"value\": \"paid\" }\n ]\n }\n }'\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filter"],"additionalProperties":false,"properties":{"filter":{"type":"object","required":["operator","conditions"],"additionalProperties":false,"description":"The rule that decides who is in a group. A contact is in the group when it\nmatches `conditions` (joined by `operator`), matches every condition in\n`requiredConditions`, and matches none of `excludeConditions`. Each list holds\nat most 20 conditions, and at least one condition is needed across the three\nlists (otherwise `422 EMPTY_FILTER`). Unsubscribed contacts are never members.\nSee [Group conditions](/api-reference/group-conditions).\n","properties":{"operator":{"type":"string","enum":["AND","OR"],"description":"How the conditions in `conditions` are joined, `AND` (all of them) or `OR` (any of them).","isRequired":true,"uniqueKey":"filter.operator","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","maxItems":20,"items":{"type":"object","required":["field"],"additionalProperties":true,"description":"One condition of a rule: an object whose required `field` names the condition\ntype, plus the keys that type takes (for example `operator` and `value`). The\n20 types, their keys and allowed values, and where to find the ids they need\nare on [Group conditions](/api-reference/group-conditions); this schema lists\nonly `field` so the two cannot disagree. The server validates every condition\nstrictly: an unknown key, a wrong value or a combination of keys the type does\nnot allow is a `400 VALIDATION_ERROR` naming the path. A `custom_field`\ncondition is refused with `422 CONDITION_NOT_SUPPORTED`, and so are the few\ncondition shapes that give a wrong answer for some contacts in the list they\nare in (see Group conditions).\n","properties":{"field":{"type":"string","enum":["tag","document_view","consent","cta_click","email_open","email_link_click","has_phone","form_submission","payment_status","first_seen","last_active","group_membership","tier_access","days_since_purchase","repeat_bounce","course_last_access","kakao_reachable","course_progress","location","checkout_abandoned"],"description":"The condition type.","isRequired":true,"uniqueKey":"filter.conditions.items.[INDEX].field","typeLabel":"enum\u003cstring>"}},"example":{"field":"tag","operator":"has","value":"newsletter"},"uniqueKey":"filter.conditions.items.[INDEX]","typeLabel":"object"},"description":"The main list of conditions. May be empty when `requiredConditions` or `excludeConditions` has some.","isRequired":true,"uniqueKey":"filter.conditions","typeLabel":"object[]"},"requiredConditions":{"type":"array","maxItems":20,"items":{"type":"object","required":["field"],"additionalProperties":true,"description":"One condition of a rule: an object whose required `field` names the condition\ntype, plus the keys that type takes (for example `operator` and `value`). The\n20 types, their keys and allowed values, and where to find the ids they need\nare on [Group conditions](/api-reference/group-conditions); this schema lists\nonly `field` so the two cannot disagree. The server validates every condition\nstrictly: an unknown key, a wrong value or a combination of keys the type does\nnot allow is a `400 VALIDATION_ERROR` naming the path. A `custom_field`\ncondition is refused with `422 CONDITION_NOT_SUPPORTED`, and so are the few\ncondition shapes that give a wrong answer for some contacts in the list they\nare in (see Group conditions).\n","properties":{"field":{"type":"string","enum":["tag","document_view","consent","cta_click","email_open","email_link_click","has_phone","form_submission","payment_status","first_seen","last_active","group_membership","tier_access","days_since_purchase","repeat_bounce","course_last_access","kakao_reachable","course_progress","location","checkout_abandoned"],"description":"The condition type.","isRequired":true,"uniqueKey":"filter.requiredConditions.items.[INDEX].field","typeLabel":"enum\u003cstring>"}},"example":{"field":"tag","operator":"has","value":"newsletter"},"uniqueKey":"filter.requiredConditions.items.[INDEX]","typeLabel":"object"},"description":"Conditions every member must also match. Always AND-ed in, whatever `operator` is.","uniqueKey":"filter.requiredConditions","typeLabel":"object[]"},"excludeConditions":{"type":"array","maxItems":20,"items":{"type":"object","required":["field"],"additionalProperties":true,"description":"One condition of a rule: an object whose required `field` names the condition\ntype, plus the keys that type takes (for example `operator` and `value`). The\n20 types, their keys and allowed values, and where to find the ids they need\nare on [Group conditions](/api-reference/group-conditions); this schema lists\nonly `field` so the two cannot disagree. The server validates every condition\nstrictly: an unknown key, a wrong value or a combination of keys the type does\nnot allow is a `400 VALIDATION_ERROR` naming the path. A `custom_field`\ncondition is refused with `422 CONDITION_NOT_SUPPORTED`, and so are the few\ncondition shapes that give a wrong answer for some contacts in the list they\nare in (see Group conditions).\n","properties":{"field":{"type":"string","enum":["tag","document_view","consent","cta_click","email_open","email_link_click","has_phone","form_submission","payment_status","first_seen","last_active","group_membership","tier_access","days_since_purchase","repeat_bounce","course_last_access","kakao_reachable","course_progress","location","checkout_abandoned"],"description":"The condition type.","isRequired":true,"uniqueKey":"filter.excludeConditions.items.[INDEX].field","typeLabel":"enum\u003cstring>"}},"example":{"field":"tag","operator":"has","value":"newsletter"},"uniqueKey":"filter.excludeConditions.items.[INDEX]","typeLabel":"object"},"description":"Conditions that remove contacts. A contact matching any one of them is left out. A few condition shapes are refused here (`422 CONDITION_NOT_SUPPORTED`); see [Group conditions](/api-reference/group-conditions).","uniqueKey":"filter.excludeConditions","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"filter","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"filter":{"operator":"OR","conditions":[{"field":"tag","operator":"has","value":"vip"},{"field":"payment_status","operator":"is","value":"paid"}]}},"examples":{"Example":{"title":"Example","value":{"filter":{"operator":"OR","conditions":[{"field":"tag","operator":"has","value":"vip"},{"field":"payment_status","operator":"is","value":"paid"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c87d4828-2906-4270-8758-c4b73d075ad4":{"description":"How many contacts the rule matches.","content":{"application/json":{"schema":{"type":"object","required":["memberCount"],"properties":{"memberCount":{"type":"integer","minimum":0,"description":"How many contacts the rule matches now (never unsubscribed contacts). A count only.","isRequired":true,"uniqueKey":"memberCount","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"memberCount":87},"examples":{"Example":{"title":"Example","value":{"memberCount":87}}},"exampleType":"examples"}},"exampleType":"examples"},"da0816c8-0810-4ae7-b2bd-7cb153b504f6":{"description":"`INVALID_JSON` (the body is not JSON) or `VALIDATION_ERROR` (a bad `filter`; `message` starts with the path of the bad part, for example `filter.conditions.2.value:`. Causes include a missing `filter`, an unknown key in the body, the rule or a condition, a wrong value or type, a list of more than 20 conditions, an id that is not a UUID, and a combination of keys a condition does not allow).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"cc4d14b6-79f1-4885-b354-c1f0188f8323":{"description":"Missing, malformed, or revoked API key (`code: UNAUTHORIZED`).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"7b2bf750-7e7e-49dd-8b1e-ae36c3c5c83c":{"description":"`PAST_DUE_RESTRICTED`, `PLAN_REQUIRED` or `INSUFFICIENT_SCOPE` (the key lacks `automations:read`).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a964ae9c-1054-4fe0-b594-b369ca50ac5e":{"description":"The API is available to some accounts only, whatever the plan. If you\nexpect access, check with your DocuRise contact (`code: NOT_FOUND`).\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"98899c2c-c4bf-4523-bcbf-44698f2bc67c":{"description":"The request is well-formed but the rule cannot be used. None is\nretryable as is.\n`EMPTY_FILTER`: the rule has no condition in any of its three lists.\n`CONDITION_NOT_SUPPORTED`: a condition type the API does not accept yet\n(`custom_field`), or a condition shape that gives a wrong answer for some\ncontacts in the list it is in (see Group conditions);\n`details` is `{ field, path }`, plus `{ operator, invertTo }` for the second\nkind (`invertTo` is left out when there is no equivalent operator).\n`REFERENCE_NOT_FOUND`: a condition carries an id that is not in your\naccount; `details` is `{ path, kind }`, with `kind` one of `document`,\n`product`, `tier`, `cta`, `folder`, `broadcast` or `step`.\n`TAG_NOT_FOUND`: a `tag` condition names a tag your account does not\nhave (names are matched exactly, case included); `details` is\n`{ tag }`.\n`GROUP_REFERENCE_NOT_FOUND`: a `group_membership` condition refers to a\ngroup that is not in your account; `details` is `{ groupIds }`.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"REFERENCE_NOT_FOUND","message":"A condition refers to something that is not in your account","retryable":false,"details":{"path":"filter.conditions.0.documentId","kind":"document"}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"REFERENCE_NOT_FOUND","message":"A condition refers to something that is not in your account","retryable":false,"details":{"path":"filter.conditions.0.documentId","kind":"document"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"32cbf27f-bd66-475b-8572-e5bb7b0534e1":{"description":"Rate limited (`code: RATE_LIMITED`, always retryable): see the `Retry-After` header and `X-RateLimit-*` headers. Or too many requests running at once (`code: TOO_MANY_CONCURRENT_REQUESTS`, always retryable): `Retry-After` is `1` and there are no `X-RateLimit-*` headers.","headers":{"Retry-After":{"schema":{"type":"integer"}},"X-RateLimit-Limit":{"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix timestamp (seconds) when the limit resets."}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"53816db7-3ca9-4ccb-a250-3b54bd8bc4db":{"description":"`INTERNAL_ERROR` (retryable). Something failed on our side; the cause is not echoed.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"f3e4763d-35e0-4507-9766-04f2196a3817":{"description":"A server-side dependency is temporarily down (`RATE_LIMIT_UNAVAILABLE`\nor `SERVICE_UNAVAILABLE`). Not a problem with the request or key;\nalways retryable — honor `retryAfterSeconds` when present. The group\nendpoints (`POST /segments`, `POST /segments/preview`,\n`GET /segments/{id}`) also return it when a very heavy rule could not be\ncounted within about 10 seconds: simplify the rule or retry.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code — switch on this, not `message`.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable detail. May change wording without notice.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the identical request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfterSeconds":{"type":"integer","description":"Present only when a concrete backoff hint applies.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"details":{"type":"object","description":"Present only for a few specific codes:\n- `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request\n (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`).\n Open-ended: tolerate new values.\n- `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule.\n- `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of\n `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`,\n `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`,\n `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`,\n `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`.\n- `HTML_REJECTED`: `{ reason: string }`, one of `too_large`, `css_rejected` or `invalid`.\n Open-ended: tolerate new values.\n- `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not\n accepted and where it sits in the request. For a condition shape refused where it sits\n also `operator: string` and, when there is an equivalent operator for `requiredConditions`,\n `invertTo: string`.\n- `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the\n request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or\n `step`. Open-ended: tolerate new values.\n- `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist.\n- `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account.\n- `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API.\n","uniqueKey":"error.details","typeLabel":"object"}},"description":"The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"retryAfterSeconds":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"647ef4a9-78cf-4a87-8ebe-f85b3fae54c2":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"dr_live_\u003ckeyId>_\u003csecret>","description":"A key generated from Settings → Developers, sent as\n`Authorization: Bearer dr_live_\u003c12 hex chars>_\u003c64 hex chars>`. Keys\ncarry explicit scopes — each endpoint states the one it requires.\nThe full key is shown exactly once at generation time and cannot be\nretrieved again; only the `keyId` prefix is shown afterward. A\nrevoked key fails auth on its very next request.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"7304e0b3-d967-42dc-a414-a807932689bf":{"url":"https://docurise.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"dr_live_\u003ckeyId>_\u003csecret>","description":"A key generated from Settings → Developers, sent as\n`Authorization: Bearer dr_live_\u003c12 hex chars>_\u003c64 hex chars>`. Keys\ncarry explicit scopes — each endpoint states the one it requires.\nThe full key is shown exactly once at generation time and cannot be\nretrieved again; only the `keyId` prefix is shown afterward. A\nrevoked key fails auth on its very next request.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A key generated from Settings → Developers, sent as\n`Authorization: Bearer dr_live_\u003c12 hex chars>_\u003c64 hex chars>`. Keys\ncarry explicit scopes — each endpoint states the one it requires.\nThe full key is shown exactly once at generation time and cannot be\nretrieved again; only the `keyId` prefix is shown afterward. A\nrevoked key fails auth on its very next request.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"docu-rise","siteName":"DocuRise Developer Docs","title":"Preview a group rule - DocuRise Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/preview-segment","matchLevel":0},"ko":{"href":"/ko/api-reference/preview-segment","matchLevel":1}}},"lastModified":"2026-10-26T16:11:33.618Z","originalFileLocation":"api-reference/preview-segment.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Count who a rule would match without saving anything\">\u003cmeta data-mint-head name=\"application-name\" content=\"DocuRise Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_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=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview a group rule - DocuRise Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Count who a rule would match without saving anything\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DocuRise Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docurise.io/docs/api-reference/preview-segment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docu-rise.mintlify.app/_mintlify/api/og/v2?division=Audiences\u0026amp;title=Preview+a+group+rule\u0026amp;description=Count+who+a+rule+would+match+without+saving+anything\u0026amp;theme=53f5ca0b0069a8a509ebc847\u0026amp;signature=9e03c84563042456cc2e58cd426c6ae039dc8410c7b53768bce12048a6c8afb5\">\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=\"Preview a group rule - DocuRise Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Count who a rule would match without saving anything\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docu-rise.mintlify.app/_mintlify/api/og/v2?division=Audiences\u0026amp;title=Preview+a+group+rule\u0026amp;description=Count+who+a+rule+would+match+without+saving+anything\u0026amp;theme=53f5ca0b0069a8a509ebc847\u0026amp;signature=9e03c84563042456cc2e58cd426c6ae039dc8410c7b53768bce12048a6c8afb5\">\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=\"/docs/mintlify-assets/_mintlify/favicons/docu-rise/PjNyTTc63ErGT2fG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DocuRise Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#DA350B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docurise.io/docs/api-reference/preview-segment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/preview-segment.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docurise.io/docs/api-reference/preview-segment\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docurise.io/docs/ko/api-reference/preview-segment\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docurise.io/docs/api-reference/preview-segment\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docurise.io/#organization\",\"name\":\"DocuRise Developer Docs\",\"url\":\"https://docurise.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/docu-rise/ClhhLqgPXOXvt7Zz/logo.png?fit=max\u0026auto=format\u0026n=ClhhLqgPXOXvt7Zz\u0026q=85\u0026s=b73379a7630a12945d164a128a6ddb12\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docurise.io/docs#website\",\"name\":\"DocuRise Developer Docs\",\"url\":\"https://docurise.io/docs\",\"publisher\":{\"@id\":\"https://docurise.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docurise.io/docs/api-reference/preview-segment#webpage\",\"url\":\"https://docurise.io/docs/api-reference/preview-segment\",\"name\":\"Preview a group rule\",\"description\":\"Count who a rule would match without saving anything\",\"dateModified\":\"2026-10-26T16:11:33.618Z\",\"isPartOf\":{\"@id\":\"https://docurise.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://docurise.io/docs/api-reference/preview-segment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docurise.io/docs/api-reference/preview-segment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Audiences\",\"item\":\"https://docurise.io/docs/api-reference/list-tags\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview a group rule\",\"item\":\"https://docurise.io/docs/api-reference/preview-segment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docurise.io/docs/api-reference/preview-segment#apireference\",\"headline\":\"Preview a group rule\",\"name\":\"Preview a group rule\",\"description\":\"Count who a rule would match without saving anything\",\"url\":\"https://docurise.io/docs/api-reference/preview-segment\",\"mainEntityOfPage\":{\"@id\":\"https://docurise.io/docs/api-reference/preview-segment#webpage\"},\"dateModified\":\"2026-10-26T16:11:33.618Z\",\"publisher\":{\"@id\":\"https://docurise.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docurise.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DocuRise Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DocuRise Developer Docs","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Documents","pages":[{"title":"Create a document","openapi":"api-reference/openapi.yaml POST /api/preview/documents","href":"/api-reference/create-document"},{"title":"List documents","openapi":"api-reference/openapi.yaml GET /api/preview/documents","href":"/api-reference/list-documents"},{"title":"Get a document","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}","href":"/api-reference/get-document"},{"title":"Update a document","openapi":"api-reference/openapi.yaml PATCH /api/preview/documents/{id}","href":"/api-reference/update-document"},{"title":"Get document analytics","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics","href":"/api-reference/get-document-analytics"},{"title":"Get document analytics by channel","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics/channels","href":"/api-reference/get-document-analytics-channels"},{"title":"Get form funnel","openapi":"api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics/funnel","href":"/api-reference/get-form-funnel"},{"title":"List top documents","openapi":"api-reference/openapi.yaml GET /api/preview/analytics/documents","href":"/api-reference/list-top-documents"}]},{"group":"Folders","pages":[{"title":"List folders and courses","openapi":"api-reference/openapi.yaml GET /api/preview/folders","href":"/api-reference/list-folders"}]},{"group":"Products","pages":[{"title":"List products","openapi":"api-reference/openapi.yaml GET /api/preview/products","href":"/api-reference/list-products"}]},{"group":"Audiences","pages":[{"title":"List tags","openapi":"api-reference/openapi.yaml GET /api/preview/tags","href":"/api-reference/list-tags"},{"title":"Create a tag","openapi":"api-reference/openapi.yaml POST /api/preview/tags","href":"/api-reference/create-tag"},{"title":"List groups","openapi":"api-reference/openapi.yaml GET /api/preview/segments","href":"/api-reference/list-segments"},{"title":"Create a group","description":"Create one group from a rule; an Idempotency-Key makes retries safe","openapi":"api-reference/openapi.yaml POST /api/preview/segments","href":"/api-reference/create-segment"},{"title":"Preview a group rule","openapi":"api-reference/openapi.yaml POST /api/preview/segments/preview","href":"/api-reference/preview-segment"},{"title":"Get a group","description":"Read one group with its rule and its live member count","openapi":"api-reference/openapi.yaml GET /api/preview/segments/{id}","href":"/api-reference/get-segment"},{"title":"Group conditions","href":"/api-reference/group-conditions"}]},{"group":"Contacts","pages":[{"title":"Add a tag to a contact","openapi":"api-reference/openapi.yaml PUT /api/preview/contacts/{contactId}/tags/{tagName}","href":"/api-reference/add-contact-tag"},{"title":"Remove a tag from a contact","openapi":"api-reference/openapi.yaml DELETE /api/preview/contacts/{contactId}/tags/{tagName}","href":"/api-reference/remove-contact-tag"}]},{"group":"Email","pages":[{"title":"List email broadcasts","openapi":"api-reference/openapi.yaml GET /api/preview/email/broadcasts","href":"/api-reference/list-email-broadcasts"},{"title":"Get broadcast insights","openapi":"api-reference/openapi.yaml GET /api/preview/email/broadcasts/{id}/insights","href":"/api-reference/get-broadcast-insights"},{"title":"List automations","openapi":"api-reference/openapi.yaml GET /api/preview/automations","href":"/api-reference/list-automations"}]},{"group":"Instagram","pages":[{"title":"Create an Instagram rule","openapi":"api-reference/openapi.yaml POST /api/preview/instagram/rules","href":"/api-reference/create-instagram-rule"},{"title":"List Instagram rules","openapi":"api-reference/openapi.yaml GET /api/preview/instagram/rules","href":"/api-reference/list-instagram-rules"},{"title":"Get an Instagram rule","openapi":"api-reference/openapi.yaml GET /api/preview/instagram/rules/{id}","href":"/api-reference/get-instagram-rule"},{"title":"Update an Instagram rule","openapi":"api-reference/openapi.yaml PATCH /api/preview/instagram/rules/{id}","href":"/api-reference/update-instagram-rule"}]},{"group":"Account","pages":[{"title":"Inspect the calling key","openapi":"api-reference/openapi.yaml GET /api/preview/whoami","href":"/api-reference/whoami"}]}]}]},{"language":"ko","pages":[{"title":"ko","href":"/ko/api-reference/preview-segment"}]}]},"title":"Preview a group rule - DocuRise Developer Docs","buildId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","deploymentId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DsGgv5pK.js","utils-B0h6ZXi-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-IgrnFwPw.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C49-TBER.js","snippetPresets-BPHn-9OB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CGBwAHwX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BjABHCCH.js","shallow-C0Uj5sOI.js","getApiPlaygroundDisplay-BnYiIeY4.js","CodeSnippet-BJWWrlBw.js","CodeSnippets-bxE5aDye.js","Page-BBU7roUf.js","getPastedJson-BAjriezQ.js","icon-BqcS52QC.js","MethodPill-BPGyN9me.js","DuplicateIcon-CCf2giLL.js","createIcon-CVH8aNt2.js","DynamicMarkdown-BklwmxA6.js","SectionHeading-DYCZQFxh.js","axios-vUo_bRtp.js","Markdown-D26rHnOC.js","clsx-DkiOUx4h.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DI8jfVGc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DwJy-csb.js"]}