Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.
Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.
Headers
If-Match
string
required
Quoted Study version last read from ETag or Study.version. Required on mutating Study writes.
Example:
"\"126300\""
Path Parameters
studyId
string<uuid>
required
Body
application/json
Input for creating a Block or Page in a Study.
name
string
Optional stable caller-defined name, unique among Blocks in the Study.
Required string length: 1 - 128
label
string
Optional display label for the Block.
Required string length: 1 - 500
displayLogic
Condition · object
Block or Page display logic. Null clears it. Omission on update preserves the stored value. Question display logic stays on the Question.
Condition
All of
Any of
Show child attributes
skipLogic
object[] | null
Block or Page skip logic. Null or an empty array clears it. Omission on update preserves the stored value. A Page owns skip logic for its Questions.
Maximum array length: 20
Show child attributes
randomizePosition
boolean
Whether this Block moves inside its parent shuffle. Defaults to false. A subset requires every direct child to be randomized.
subsetCount
integer | null
How many eligible direct children to show each respondent. Null clears the subset. Omission on update preserves the stored value. Eligible children are the ones delivery can leave out: a prior skip destination, display logic, and either side of carry-forward stay in the survey and do not count. The value must be from 1 to one less than that eligible count. Setting it randomizes every direct child.
Required range: x >= 1
position
object
Places the Block before or after an anchor Question or Block. BEFORE a Block uses that Block's slot. AFTER a Block lands after its subtree. With member Questions and a Question anchor, the Block takes the slot immediately before the first member. The anchor Question's Block, or a Block anchor's parent, becomes this Block's parent.
Show child attributes
displayAsPage
boolean
default:false
When true, the Block is shown as a single Page. Membership may be empty, one Question, or many.
Response
Created
Canonical Block resource.
id
string<uuid>
required
displayLogic
Condition · object
required
A single typed condition. Operators that inspect answer state omit value; choice comparisons use immutable Option values.
Condition
All of
Any of
Show child attributes
skipLogic
object[]
required
Ordered skip rules, limited to 20. An empty array clears skip logic.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Sprig Docs","colors":{"primary":"#000000","light":"#ffc566","dark":"#919191"},"logo":{"light":"https://mintcdn.com/sprig/NJ4Z7jccZmEgPa9A/images/light.svg?fit=max\u0026auto=format\u0026n=NJ4Z7jccZmEgPa9A\u0026q=85\u0026s=c1e092afbac43fa33fd40be7729084dc","dark":"https://mintcdn.com/sprig/NJ4Z7jccZmEgPa9A/images/dark.svg?fit=max\u0026auto=format\u0026n=NJ4Z7jccZmEgPa9A\u0026q=85\u0026s=bd07526f0bd395ca4d7005e8f59adcb3"},"favicon":"https://mintcdn.com/sprig/NJ4Z7jccZmEgPa9A/images/favicon.png?fit=max\u0026auto=format\u0026n=NJ4Z7jccZmEgPa9A\u0026q=85\u0026s=b623231e4d3d1db2810b13be57d52e09","appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#1C1A17"}},"navbar":{"links":[{"href":"https://sprig.com/guides","label":"Sprig Buyer Guides"}],"primary":{"type":"button","label":"Get Started Free","href":"https://app.sprig.com/signup"}},"footer":{"socials":{"website":"https://sprig.com","linkedin":"https://www.linkedin.com/company/sprig-official"}},"fonts":{"heading":{"family":"ABC Diatype","weight":500,"source":"fonts/ABCDiatype-Medium.woff2","format":"woff2"},"body":{"family":"ABC Diatype","weight":400,"source":"fonts/ABCDiatype-Regular.woff2","format":"woff2"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","grok","aistudio","devin","windsurf","mcp","cursor","vscode","devin-mcp"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sprig","hasAudioNarration":false,"actualSubdomain":"sprig","customDomains":["docs.sprig.com"],"gitSource":{"type":"github","owner":"userleap","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af7b48bf7a03cc7cdde369c","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Guides","count":129},{"language":"default","tag":"API Reference","count":48},{"language":"default","tag":"Sprig API","count":48},{"language":"default","tag":"V2","count":44},{"language":"default","tag":"Studies","count":32},{"language":"default","tag":"Native AI","count":22},{"language":"default","tag":"Sprig Studies","count":21},{"language":"default","tag":"Shared Study Foundations","count":20},{"language":"default","tag":"Account \u0026 Settings","count":14},{"language":"default","tag":"Developer Center","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@sprig.com"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/blocks/create-a-block","slug":"/api-reference/blocks/create-a-block","pageMetadata":{"title":"Create a Block","description":"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/blocks","href":"/api-reference/blocks/create-a-block","autogeneratedByOpenApi":true},"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: \"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.\"\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 a Block","description":"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/blocks","href":"/api-reference/blocks/create-a-block","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createBlock","summary":"Create a Block","description":"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.","tags":["Blocks"],"parameters":["e36cfb74-a8fb-47b3-b9b0-b0fe06a67a79","e227780c-1238-4dcf-a311-ce5a5c1a7bfc"],"requestBody":"17d17a35-fb94-4bde-b15c-6064c6677f96","responses":{"201":"6de17076-c9a6-4a6d-aa7b-c2e416d70a90","400":"d949096f-407c-4e25-a066-dacddfc4c6a2","403":"272f1a70-545b-4f25-ae2f-67d566e3aa84","404":"b005a21d-c476-4bda-930d-c92a5e52cd29","409":"1178abb3-a27d-4d40-aa28-567c8767934a","412":"42213f9b-df69-4cee-9b51-a3be8425ebac","422":"db0ffa1c-6ba2-425e-aae3-b5b6ed1237a4","428":"8b64b7a8-8e39-4f85-80c5-a61722d24b4a"},"security":["bb6e8938-699b-4952-94cc-e9f73b1f48b0"],"method":"post","type":"path","servers":["9717a559-6c62-44d2-b1da-68fe71d6bad4"],"path":"/v2/studies/{studyId}/blocks","baseUrlOptions":["https://api.sprig.com"],"title":"Create a Block","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e36cfb74-a8fb-47b3-b9b0-b0fe06a67a79":{"name":"If-Match","in":"header","required":true,"description":"Quoted Study version last read from ETag or Study.version. Required on mutating Study writes.","schema":{"type":"string","example":"\"126300\"","isRequired":true,"description":"Quoted Study version last read from ETag or Study.version. Required on mutating Study writes.","uniqueKey":"","typeLabel":"string"}},"e227780c-1238-4dcf-a311-ce5a5c1a7bfc":{"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"name":"studyId","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Optional stable caller-defined name, unique among Blocks in the Study.","uniqueKey":"name","typeLabel":"string"},"label":{"type":"string","minLength":1,"maxLength":500,"description":"Optional display label for the Block.","uniqueKey":"label","typeLabel":"string"},"displayLogic":{"oneOf":[{"type":"object","title":"Condition","description":"Block or Page display logic. Null clears it. Omission on update preserves the stored value. Question display logic stays on the Question.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0","typeLabel":"Question response · object"},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.1.attribute","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.1","typeLabel":"Environment attribute · object"}],"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source","typeLabel":"Question response · object | Environment attribute · object"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true,"uniqueKey":"displayLogic.oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Text","uniqueKey":"displayLogic.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","title":"Number","uniqueKey":"displayLogic.oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","title":"Yes / no","uniqueKey":"displayLogic.oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"displayLogic.oneOf.0.value.oneOf.3.items.[INDEX]","typeLabel":"string"},"title":"List","uniqueKey":"displayLogic.oneOf.0.value.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"displayLogic.oneOf.0.value","typeLabel":"string | number | boolean | string[]"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.0","typeLabel":"Condition · object"},{"type":"object","title":"All of","description":"Block or Page display logic. Null clears it. Omission on update preserves the stored value. Question display logic stays on the Question.","required":["all"],"properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0","typeLabel":"Question response · object"},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.1.attribute","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.1","typeLabel":"Environment attribute · object"}],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source","typeLabel":"Question response · object | Environment attribute · object"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Text","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","title":"Number","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","title":"Yes / no","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.3.items.[INDEX]","typeLabel":"string"},"title":"List","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value","typeLabel":"string | number | boolean | string[]"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0","typeLabel":"Condition · object"},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"oneOf":[{"$circularRef":"6985f0b6-cf9b-4a87-afdf-a8681184f678","isRequired":true}],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.1.all","typeLabel":"any"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.1","typeLabel":"All of · object"},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.2.any","typeLabel":"array"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.2","typeLabel":"Any of · object"}],"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX]","typeLabel":"Condition · object | All of · object | Any of · object"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all","typeLabel":"(Condition · object | All of · object | Any of · object)[]"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1","typeLabel":"All of · object"},{"type":"object","title":"Any of","description":"Block or Page display logic. Null clears it. Omission on update preserves the stored value. Question display logic stays on the Question.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"displayLogic.oneOf.2.any","typeLabel":"array"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.2","typeLabel":"Any of · object"},{"type":"null","title":"No display logic","description":"Block or Page display logic. Null clears it. Omission on update preserves the stored value. Question display logic stays on the Question.","uniqueKey":"displayLogic.oneOf.3","typeLabel":"null"}],"uniqueKey":"displayLogic","typeLabel":"Condition · object | All of · object | Any of · object | null"},"skipLogic":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"when":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.0.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.0.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.0.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.0","typeLabel":"Question response · object"},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.1.attribute","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source.oneOf.1","typeLabel":"Environment attribute · object"}],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.source","typeLabel":"Question response · object | Environment attribute · object"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Text","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","title":"Number","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","title":"Yes / no","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.value.oneOf.3.items.[INDEX]","typeLabel":"string"},"title":"List","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.value.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0.value","typeLabel":"string | number | boolean | string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.0","typeLabel":"Condition · object"},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"oneOf":[{"$circularRef":"6985f0b6-cf9b-4a87-afdf-a8681184f678","isRequired":true}],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.1.all","typeLabel":"any"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.1","typeLabel":"All of · object"},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.2.any","typeLabel":"array"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when.oneOf.2","typeLabel":"Any of · object"}],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].when","typeLabel":"Condition · object | All of · object | Any of · object"},"destination":{"oneOf":[{"type":"object","title":"End of study","description":"Public skip destination.","required":["type"],"properties":{"type":{"type":"string","enum":["END"],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.0","typeLabel":"End of study · object"},{"type":"object","title":"Question","description":"Public skip destination.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION"],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.1.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.1.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.1.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination.oneOf.1","typeLabel":"Question · object"}],"isRequired":true,"uniqueKey":"skipLogic.oneOf.0.items.[INDEX].destination","typeLabel":"End of study · object | Question · object"}},"required":["when","destination"],"additionalProperties":false,"description":"One skip rule with a typed condition and destination.","uniqueKey":"skipLogic.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"Block or Page skip logic. Null or an empty array clears it. Omission on update preserves the stored value. A Page owns skip logic for its Questions.","uniqueKey":"skipLogic.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"when":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"]},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":128}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both."}},"additionalProperties":false},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"]},"attribute":{"type":"string","minLength":1,"maxLength":128}},"additionalProperties":false}]},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type."},"value":{"oneOf":[{"type":"string","title":"Text"},{"type":"number","title":"Number"},{"type":"boolean","title":"Yes / no"},{"type":"array","items":{"type":"string"},"title":"List"}]}},"additionalProperties":false},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"oneOf":[{"$circularRef":"6985f0b6-cf9b-4a87-afdf-a8681184f678"}]}},"additionalProperties":false},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20}},"additionalProperties":false}]},"destination":{"oneOf":[{"type":"object","title":"End of study","description":"Public skip destination.","required":["type"],"properties":{"type":{"type":"string","enum":["END"]}},"additionalProperties":false},{"type":"object","title":"Question","description":"Public skip destination.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION"]},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":128}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both."}},"additionalProperties":false}]}},"required":["when","destination"],"additionalProperties":false,"description":"One skip rule with a typed condition and destination."},"maxItems":20,"description":"Block or Page skip logic. Null or an empty array clears it. Omission on update preserves the stored value. A Page owns skip logic for its Questions.","uniqueKey":"skipLogic.oneOf.1","typeLabel":"null"}],"uniqueKey":"skipLogic","typeLabel":"object[] | null"},"randomizePosition":{"type":"boolean","description":"Whether this Block moves inside its parent shuffle. Defaults to false. A subset requires every direct child to be randomized.","uniqueKey":"randomizePosition","typeLabel":"boolean"},"subsetCount":{"oneOf":[{"type":"integer","minimum":1,"description":"How many eligible direct children to show each respondent. Null clears the subset. Omission on update preserves the stored value. Eligible children are the ones delivery can leave out: a prior skip destination, display logic, and either side of carry-forward stay in the survey and do not count. The value must be from 1 to one less than that eligible count. Setting it randomizes every direct child.","uniqueKey":"subsetCount.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"How many eligible direct children to show each respondent. Null clears the subset. Omission on update preserves the stored value. Eligible children are the ones delivery can leave out: a prior skip destination, display logic, and either side of carry-forward stay in the survey and do not count. The value must be from 1 to one less than that eligible count. Setting it randomizes every direct child.","uniqueKey":"subsetCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subsetCount","typeLabel":"integer | null"},"position":{"type":"object","properties":{"placement":{"type":"string","enum":["BEFORE","AFTER"],"description":"Where to place the resource relative to the anchor. BEFORE a Block uses that Block's slot. AFTER a Block lands after its subtree.","isRequired":true,"uniqueKey":"position.placement","typeLabel":"enum\u003cstring>"},"anchor":{"oneOf":[{"type":"object","title":"By ID","description":"Exactly one of id or name for an existing Question or Block in the Study. A name includes type so lookup is only that Question or Block.","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Public UUID of the anchor Question or Block.","isRequired":true,"uniqueKey":"position.anchor.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"position.anchor.oneOf.0","typeLabel":"By ID · object"},{"type":"object","title":"By name","description":"Exactly one of id or name for an existing Question or Block in the Study. A name includes type so lookup is only that Question or Block.","required":["name","type"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of the anchor Question or Block.","isRequired":true,"uniqueKey":"position.anchor.oneOf.1.name","typeLabel":"string"},"type":{"type":"string","enum":["QUESTION","BLOCK"],"description":"Required with name. QUESTION looks up a Question. BLOCK looks up a Block.","isRequired":true,"uniqueKey":"position.anchor.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"position.anchor.oneOf.1","typeLabel":"By name · object"}],"isRequired":true,"uniqueKey":"position.anchor","typeLabel":"By ID · object | By name · object"}},"required":["placement","anchor"],"additionalProperties":false,"description":"Places the Block before or after an anchor Question or Block. BEFORE a Block uses that Block's slot. AFTER a Block lands after its subtree. With member Questions and a Question anchor, the Block takes the slot immediately before the first member. The anchor Question's Block, or a Block anchor's parent, becomes this Block's parent.","uniqueKey":"position","typeLabel":"object"},"displayAsPage":{"type":"boolean","default":false,"description":"When true, the Block is shown as a single Page. Membership may be empty, one Question, or many.","uniqueKey":"displayAsPage","typeLabel":"boolean"}},"additionalProperties":false,"description":"Input for creating a Block or Page in a Study.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","label":"\u003cstring>","displayLogic":{"source":{"type":"QUESTION_RESPONSE","question":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}},"value":"\u003cstring>"},"skipLogic":[{"when":{"source":{"type":"QUESTION_RESPONSE","question":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}},"value":"\u003cstring>"},"destination":{"type":"END"}}],"randomizePosition":true,"subsetCount":2,"displayAsPage":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6de17076-c9a6-4a6d-aa7b-c2e416d70a90":{"description":"Created","headers":{"ETag":{"description":"Quoted Study version validator matching Study.version, for example \"126300\".","schema":{"type":"string","example":"\"126300\""}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"displayLogic":{"oneOf":[{"type":"object","title":"Condition","description":"A single typed condition. Operators that inspect answer state omit value; choice comparisons use immutable Option values.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.0","typeLabel":"Question response · object"},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.1.attribute","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source.oneOf.1","typeLabel":"Environment attribute · object"}],"isRequired":true,"uniqueKey":"displayLogic.oneOf.0.source","typeLabel":"Question response · object | Environment attribute · object"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true,"uniqueKey":"displayLogic.oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Text","uniqueKey":"displayLogic.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","title":"Number","uniqueKey":"displayLogic.oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","title":"Yes / no","uniqueKey":"displayLogic.oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"displayLogic.oneOf.0.value.oneOf.3.items.[INDEX]","typeLabel":"string"},"title":"List","uniqueKey":"displayLogic.oneOf.0.value.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"displayLogic.oneOf.0.value","typeLabel":"string | number | boolean | string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.0","typeLabel":"Condition · object"},{"type":"object","title":"All of","description":"Typed display logic owned by a Question.","required":["all"],"properties":{"all":{"type":"array","items":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.0","typeLabel":"Question response · object"},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.1.attribute","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source.oneOf.1","typeLabel":"Environment attribute · object"}],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.source","typeLabel":"Question response · object | Environment attribute · object"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Text","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","title":"Number","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","title":"Yes / no","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.3.items.[INDEX]","typeLabel":"string"},"title":"List","uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0.value","typeLabel":"string | number | boolean | string[]"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.0","typeLabel":"Condition · object"},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"oneOf":[{"$circularRef":"6985f0b6-cf9b-4a87-afdf-a8681184f678","isRequired":true}],"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.1.all","typeLabel":"any"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.1","typeLabel":"All of · object"},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.2.any","typeLabel":"array"}},"additionalProperties":false,"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX].oneOf.2","typeLabel":"Any of · object"}],"uniqueKey":"displayLogic.oneOf.1.all.items.[INDEX]","typeLabel":"Condition · object | All of · object | Any of · object"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1.all","typeLabel":"(Condition · object | All of · object | Any of · object)[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.1","typeLabel":"All of · object"},{"type":"object","title":"Any of","description":"Typed display logic owned by a Question.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"displayLogic.oneOf.2.any","typeLabel":"array"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"displayLogic.oneOf.2","typeLabel":"Any of · object"},{"type":"null","title":"No display logic","isRequired":true,"uniqueKey":"displayLogic.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"displayLogic","typeLabel":"Condition · object | All of · object | Any of · object | null"},"skipLogic":{"type":"array","items":{"type":"object","properties":{"when":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.0.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.0.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.0.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.0","typeLabel":"Question response · object"},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.1.attribute","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source.oneOf.1","typeLabel":"Environment attribute · object"}],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.source","typeLabel":"Question response · object | Environment attribute · object"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Text","uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","title":"Number","uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","title":"Yes / no","uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.value.oneOf.3.items.[INDEX]","typeLabel":"string"},"title":"List","uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.value.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0.value","typeLabel":"string | number | boolean | string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.0","typeLabel":"Condition · object"},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"oneOf":[{"$circularRef":"6985f0b6-cf9b-4a87-afdf-a8681184f678","isRequired":true}],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.1.all","typeLabel":"any"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.1","typeLabel":"All of · object"},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.2.any","typeLabel":"array"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when.oneOf.2","typeLabel":"Any of · object"}],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].when","typeLabel":"Condition · object | All of · object | Any of · object"},"destination":{"oneOf":[{"type":"object","title":"End of study","description":"Public skip destination.","required":["type"],"properties":{"type":{"type":"string","enum":["END"],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.0","typeLabel":"End of study · object"},{"type":"object","title":"Question","description":"Public skip destination.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION"],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.1.question.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.1.question.name","typeLabel":"string"}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.1.question","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].destination.oneOf.1","typeLabel":"Question · object"}],"isRequired":true,"uniqueKey":"skipLogic.items.[INDEX].destination","typeLabel":"End of study · object | Question · object"}},"required":["when","destination"],"additionalProperties":false,"description":"One skip rule with a typed condition and destination.","uniqueKey":"skipLogic.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"Ordered skip rules, limited to 20. An empty array clears skip logic.","isRequired":true,"uniqueKey":"skipLogic","typeLabel":"object[]"},"randomizePosition":{"type":"boolean","isRequired":true,"uniqueKey":"randomizePosition","typeLabel":"boolean"},"subsetCount":{"oneOf":[{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"subsetCount.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"isRequired":true,"uniqueKey":"subsetCount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subsetCount","typeLabel":"integer | null"},"displayAsPage":{"type":"boolean","isRequired":true,"uniqueKey":"displayAsPage","typeLabel":"boolean"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"label":{"type":"string","uniqueKey":"label","typeLabel":"string"}},"required":["id","displayLogic","skipLogic","randomizePosition","subsetCount","displayAsPage"],"additionalProperties":false,"description":"Canonical Block resource.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","displayLogic":{"source":{"type":"QUESTION_RESPONSE","question":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}},"operator":"EQUALS","value":"\u003cstring>"},"skipLogic":[{"when":{"source":{"type":"QUESTION_RESPONSE","question":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}},"operator":"EQUALS","value":"\u003cstring>"},"destination":{"type":"END"}}],"randomizePosition":true,"subsetCount":2,"displayAsPage":true,"name":"\u003cstring>","label":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d949096f-407c-4e25-a066-dacddfc4c6a2":{"description":"The request is invalid, including a malformed or unquoted `If-Match` header.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code (e.g. STUDY_NOT_FOUND).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"resource":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.id","typeLabel":"string"}},"required":["type","id"],"description":"The other resource this issue points at, when the issue is not about the request itself.","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"object"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field validation issues, present when the request itself was malformed.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message"],"description":"Error response returned by the Public API V2.","title":"API error","uniqueKey":"","typeLabel":"API error · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","resource":{"type":"\u003cstring>","id":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"272f1a70-545b-4f25-ae2f-67d566e3aa84":{"description":"The environment API key is missing or invalid, cannot access this resource, or the Study API is not available for the account.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b005a21d-c476-4bda-930d-c92a5e52cd29":{"description":"Study not found.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code (e.g. STUDY_NOT_FOUND).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"resource":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.id","typeLabel":"string"}},"required":["type","id"],"description":"The other resource this issue points at, when the issue is not about the request itself.","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"object"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field validation issues, present when the request itself was malformed.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message"],"description":"Error response returned by the Public API V2.","title":"API error","uniqueKey":"","typeLabel":"API error · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","resource":{"type":"\u003cstring>","id":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1178abb3-a27d-4d40-aa28-567c8767934a":{"description":"The Study is not editable in its current status, or a conflicting update is already in progress.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code (e.g. STUDY_NOT_FOUND).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"resource":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.id","typeLabel":"string"}},"required":["type","id"],"description":"The other resource this issue points at, when the issue is not about the request itself.","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"object"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field validation issues, present when the request itself was malformed.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message"],"description":"Error response returned by the Public API V2.","title":"API error","uniqueKey":"","typeLabel":"API error · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","resource":{"type":"\u003cstring>","id":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"42213f9b-df69-4cee-9b51-a3be8425ebac":{"description":"The `If-Match` version is stale. Read the resource again and retry with its current ETag.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code (e.g. STUDY_NOT_FOUND).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"resource":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.id","typeLabel":"string"}},"required":["type","id"],"description":"The other resource this issue points at, when the issue is not about the request itself.","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"object"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field validation issues, present when the request itself was malformed.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message"],"description":"Error response returned by the Public API V2.","title":"API error","uniqueKey":"","typeLabel":"API error · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","resource":{"type":"\u003cstring>","id":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"db0ffa1c-6ba2-425e-aae3-b5b6ed1237a4":{"description":"The request is well-formed but fails a business-rule validation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code (e.g. STUDY_NOT_FOUND).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"resource":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.id","typeLabel":"string"}},"required":["type","id"],"description":"The other resource this issue points at, when the issue is not about the request itself.","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"object"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field validation issues, present when the request itself was malformed.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message"],"description":"Error response returned by the Public API V2.","title":"API error","uniqueKey":"","typeLabel":"API error · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","resource":{"type":"\u003cstring>","id":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"8b64b7a8-8e39-4f85-80c5-a61722d24b4a":{"description":"The `If-Match` header is missing. Read the resource first and send its ETag with the write.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code (e.g. STUDY_NOT_FOUND).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"},"resource":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].resource.id","typeLabel":"string"}},"required":["type","id"],"description":"The other resource this issue points at, when the issue is not about the request itself.","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"object"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field validation issues, present when the request itself was malformed.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message"],"description":"Error response returned by the Public API V2.","title":"API error","uniqueKey":"","typeLabel":"API error · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","resource":{"type":"\u003cstring>","id":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bb6e8938-699b-4952-94cc-e9f73b1f48b0":{"EnvironmentApiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Use `API-Key YOUR_API_KEY`. The key selects the Production or Development environment.","scopes":[],"schemeName":"EnvironmentApiKey"}}},"servers":{"9717a559-6c62-44d2-b1da-68fe71d6bad4":{"url":"https://api.sprig.com"}},"schemas":{"6985f0b6-cf9b-4a87-afdf-a8681184f678":{"type":"array","items":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":128}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true}},"additionalProperties":false,"isRequired":true},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true}},"additionalProperties":false,"isRequired":true}],"isRequired":true},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true},"value":{"oneOf":[{"type":"string","title":"Text"},{"type":"number","title":"Number"},{"type":"boolean","title":"Yes / no"},{"type":"array","items":{"type":"string"},"title":"List"}]}},"additionalProperties":false},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"oneOf":[{"isRequired":true}],"isRequired":true}},"additionalProperties":false},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true}},"additionalProperties":false}]},"minItems":1,"maxItems":20},"362364a0-3873-4730-b905-dfdf3309a83d":{"oneOf":[{"type":"object","title":"Condition","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["source","operator"],"properties":{"source":{"oneOf":[{"type":"object","title":"Question response","description":"Typed source of a logic condition.","required":["type","question"],"properties":{"type":{"type":"string","enum":["QUESTION_RESPONSE"],"isRequired":true},"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":128}},"additionalProperties":false,"description":"A reference by canonical identifier, unique name, or both.","isRequired":true}},"additionalProperties":false,"isRequired":true},{"type":"object","title":"Environment attribute","description":"Typed source of a logic condition.","required":["type","attribute"],"properties":{"type":{"type":"string","enum":["ATTRIBUTE"],"isRequired":true},"attribute":{"type":"string","minLength":1,"maxLength":128,"isRequired":true}},"additionalProperties":false,"isRequired":true}],"isRequired":true},"operator":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","IN","NOT_IN","INCLUDES_ALL","EXACTLY","CONTAINS","NOT_CONTAINS","STARTS_WITH","ENDS_WITH","ANSWERED","SKIPPED","PARTIALLY_ANSWERED","EXISTS","NOT_EXISTS"],"description":"Uppercase Public API operators. Study API selects the valid operator/value branch from the source type and referenced Question type.","isRequired":true},"value":{"oneOf":[{"type":"string","title":"Text"},{"type":"number","title":"Number"},{"type":"boolean","title":"Yes / no"},{"type":"array","items":{"type":"string"},"title":"List"}]}},"additionalProperties":false},{"type":"object","title":"All of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["all"],"properties":{"all":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true}},"additionalProperties":false},{"type":"object","title":"Any of","description":"Nested display or skip conditions using all/any groups. Maximum depth is 5; each group may contain at most 20 children.","required":["any"],"properties":{"any":{"type":"array","items":{"$circularRef":"362364a0-3873-4730-b905-dfdf3309a83d"},"minItems":1,"maxItems":20,"isRequired":true}},"additionalProperties":false}]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Use `API-Key YOUR_API_KEY`. The key selects the Production or Development environment.","scopes":[],"schemeName":"EnvironmentApiKey"},"schema":{"title":"Authorization","type":"string","description":"Use `API-Key YOUR_API_KEY`. The key selects the Production or Development environment.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"EnvironmentApiKey","name":"Authorization"}],"title":"EnvironmentApiKey"}]},"originalFileLocation":"reference/study-api-v2.json"},"subdomain":"sprig","siteName":"Sprig Docs","title":"Create a Block - Sprig Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T21:15:40.220Z","originalFileLocation":"api-reference/blocks/create-a-block.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=\"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=\"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sprig Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_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/sprig/woVXERoV24GgHEnq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a Block - Sprig Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sprig Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sprig.com/api-reference/blocks/create-a-block\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sprig.mintlify.site/_mintlify/api/og/v2?division=Blocks\u0026amp;title=Create+a+Block\u0026amp;description=Creates+a+Block+or+Page.+Pages+are+supported+only+for+SURVEY+Studies%2C+not+IN_PRODUCT_SURVEY+Studies.+skipLogic+and+displayLogic+on+the+Block+are+the+group+rules\u0026amp;theme=311974c26a82eed3e0c09c9a\u0026amp;signature=3782a4319046eb9219eb5f16a6fafbc76851f23f3a2e461fe49e3cfd9b86d136\">\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 a Block - Sprig Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sprig.mintlify.site/_mintlify/api/og/v2?division=Blocks\u0026amp;title=Create+a+Block\u0026amp;description=Creates+a+Block+or+Page.+Pages+are+supported+only+for+SURVEY+Studies%2C+not+IN_PRODUCT_SURVEY+Studies.+skipLogic+and+displayLogic+on+the+Block+are+the+group+rules\u0026amp;theme=311974c26a82eed3e0c09c9a\u0026amp;signature=3782a4319046eb9219eb5f16a6fafbc76851f23f3a2e461fe49e3cfd9b86d136\">\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/sprig/woVXERoV24GgHEnq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sprig Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sprig.com/api-reference/blocks/create-a-block\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/blocks/create-a-block.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sprig.com/#organization\",\"name\":\"Sprig Docs\",\"url\":\"https://docs.sprig.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sprig/NJ4Z7jccZmEgPa9A/images/light.svg?fit=max\u0026auto=format\u0026n=NJ4Z7jccZmEgPa9A\u0026q=85\u0026s=c1e092afbac43fa33fd40be7729084dc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sprig.com#website\",\"name\":\"Sprig Docs\",\"url\":\"https://docs.sprig.com\",\"publisher\":{\"@id\":\"https://docs.sprig.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sprig.com/api-reference/blocks/create-a-block#webpage\",\"url\":\"https://docs.sprig.com/api-reference/blocks/create-a-block\",\"name\":\"Create a Block\",\"description\":\"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.\",\"dateModified\":\"2026-10-30T21:15:40.220Z\",\"isPartOf\":{\"@id\":\"https://docs.sprig.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sprig.com/api-reference/blocks/create-a-block#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sprig.com/api-reference/blocks/create-a-block#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sprig API\",\"item\":\"https://docs.sprig.com/reference/sprig-api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"V2\",\"item\":\"https://docs.sprig.com/reference/study-api-v2/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Studies\",\"item\":\"https://docs.sprig.com/api-reference/studies/list-studies\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Create a Block\",\"item\":\"https://docs.sprig.com/api-reference/blocks/create-a-block\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sprig.com/api-reference/blocks/create-a-block#apireference\",\"headline\":\"Create a Block\",\"name\":\"Create a Block\",\"description\":\"Creates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. skipLogic and displayLogic on the Block are the group rules. Question responses keep only member rules: display logic that is not owned by the group, and skip logic only when the Question is not in a Page.\",\"url\":\"https://docs.sprig.com/api-reference/blocks/create-a-block\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sprig.com/api-reference/blocks/create-a-block#webpage\"},\"dateModified\":\"2026-10-30T21:15:40.220Z\",\"publisher\":{\"@id\":\"https://docs.sprig.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sprig.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/blocks/create-a-block.md","siteName":"Sprig Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/docs/welcome-to-sprig/what-is-sprig"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Sprig API","expanded":false,"pages":[{"title":"Overview","href":"/reference/sprig-api/overview"},{"group":"V2","expanded":false,"pages":[{"group":"Study API guides","expanded":false,"pages":[{"title":"Study API overview","href":"/reference/study-api-v2/overview"},{"title":"Authentication and authorization","href":"/reference/study-api-v2/authentication"},{"title":"Versioned writes with ETag","href":"/reference/study-api-v2/concurrency"},{"title":"Errors and launch validation","href":"/reference/study-api-v2/errors-and-validation"},{"title":"Build a shareable survey","href":"/reference/study-api-v2/create-shareable-survey"},{"title":"Build an in-product survey","href":"/reference/study-api-v2/create-in-product-survey"},{"title":"In-product targeting","href":"/reference/study-api-v2/targeting"}]},{"group":"Visitors","expanded":false,"pages":[{"title":"Purge Visitors","openapi":"reference/sprig-api.json POST /v2/purge/visitors","mode":"default","href":"/reference/sprig-api/v2/post-v2-purge-visitors-1"}]},{"group":"Users","expanded":false,"pages":[{"title":"Upsert a User","openapi":"reference/sprig-api.json POST /v2/users","href":"/reference/sprig-api/v2/post-user-v2-1"},{"title":"Retrieve a User","openapi":"reference/sprig-api.json GET /v2/users/{userId}","href":"/reference/sprig-api/v2/get-v2-users-userid-1"}]},{"group":"Studies","expanded":false,"pages":[{"title":"List Studies","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies","href":"/api-reference/studies/list-studies"},{"title":"Create a draft Study","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies","href":"/api-reference/studies/create-a-draft-study"},{"title":"Get a Study","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}","href":"/api-reference/studies/get-a-study"},{"title":"Update Study settings or lifecycle status","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json patch /v2/studies/{studyId}","href":"/api-reference/studies/update-study-settings-or-lifecycle-status"},{"title":"Delete a draft Study","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}","href":"/api-reference/studies/delete-a-draft-study"},{"title":"Get a Study layout","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/layout","href":"/api-reference/studies/get-a-study-layout"},{"title":"Validate a Study","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/validate","href":"/api-reference/studies/validate-a-study"},{"group":"Targeting","expanded":false,"pages":[{"title":"Get Study targeting","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/targeting","href":"/api-reference/targeting/get-study-targeting"},{"title":"Edit Study targeting","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json put /v2/studies/{studyId}/targeting","href":"/api-reference/targeting/edit-study-targeting"},{"title":"Clear Study targeting","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}/targeting","href":"/api-reference/targeting/clear-study-targeting"}]},{"group":"Assets","expanded":false,"pages":[{"title":"Upload a Study asset","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/assets","href":"/api-reference/studies/upload-a-study-asset"},{"title":"List Study assets","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/assets","href":"/api-reference/studies/list-study-assets"},{"title":"Get a Study asset","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/assets/{assetId}","href":"/api-reference/studies/get-a-study-asset"},{"title":"Delete a Study asset","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}/assets/{assetId}","href":"/api-reference/studies/delete-a-study-asset"}]},{"group":"Questions","expanded":false,"pages":[{"title":"List Questions","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/questions","href":"/api-reference/questions/list-questions"},{"title":"Create a Question","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/questions","href":"/api-reference/questions/create-a-question"},{"title":"Get a Question","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/questions/{questionId}","href":"/api-reference/questions/get-a-question"},{"title":"Update a Question","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json patch /v2/studies/{studyId}/questions/{questionId}","href":"/api-reference/questions/update-a-question"},{"title":"Delete a Question","description":"Deletes a Question from a Study.","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}/questions/{questionId}","href":"/api-reference/questions/delete-a-question"}]},{"group":"Blocks","expanded":false,"pages":[{"title":"Create a Block","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/blocks","href":"/api-reference/blocks/create-a-block"},{"title":"Update a Block","description":"Updates a Block or Page. Pages are supported only for SURVEY Studies, not IN_PRODUCT_SURVEY Studies. Replaces Block or Page skipLogic and displayLogic when those fields are sent. Omission preserves the stored group rules. A Page owns skip logic for its Questions, so Question skipLogic is rejected for Page members.","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json patch /v2/studies/{studyId}/blocks/{blockId}","href":"/api-reference/blocks/update-a-block"},{"title":"Delete a Block","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}/blocks/{blockId}","href":"/api-reference/blocks/delete-a-block"}]},{"group":"Invitations","expanded":false,"pages":[{"title":"List invitations","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/invitations","href":"/api-reference/invitations/list-invitations"},{"title":"Create invitations","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/invitations","href":"/api-reference/invitations/create-invitations"}]},{"group":"Translations","expanded":false,"pages":[{"title":"Create a translation job","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json post /v2/studies/{studyId}/translationJobs","href":"/api-reference/translations/create-a-translation-job"},{"title":"Get a translation job","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/translationJobs/{jobId}","href":"/api-reference/translations/get-a-translation-job"},{"title":"Cancel a translation job","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}/translationJobs/{jobId}","href":"/api-reference/translations/cancel-a-translation-job"},{"title":"List translations","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/translations","href":"/api-reference/translations/list-translations"},{"title":"Get a Study translation","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/studies/{studyId}/translations/{locale}","href":"/api-reference/translations/get-a-study-translation"},{"title":"Replace a Study translation","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json put /v2/studies/{studyId}/translations/{locale}","href":"/api-reference/translations/replace-a-study-translation"},{"title":"Partially update a Study translation","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json patch /v2/studies/{studyId}/translations/{locale}","href":"/api-reference/translations/partially-update-a-study-translation"},{"title":"Delete a Study translation","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json delete /v2/studies/{studyId}/translations/{locale}","href":"/api-reference/translations/delete-a-study-translation"}]}]},{"group":"Events","expanded":false,"pages":[{"title":"List Event definitions","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/events","href":"/api-reference/events/list-event-definitions"}]},{"group":"Attributes","expanded":false,"pages":[{"title":"List Attribute definitions","deprecated":null,"version":null,"openapi":"/reference/study-api-v2.json get /v2/attributes","href":"/api-reference/attributes/list-attribute-definitions"}]}]},{"group":"V1","expanded":false,"pages":[{"title":"Retrieve Responses","openapi":"reference/sprig-api.json GET /v1/responses","href":"/reference/sprig-api/v1/get-v1-responses-1"},{"title":"Retrieve Surveys","openapi":"reference/sprig-api.json GET /v1/surveys","href":"/reference/sprig-api/v1/get-v1-surveys-1"},{"title":"Retrieve Themes","openapi":"reference/sprig-api.json GET /v1/themes","href":"/reference/sprig-api/v1/get-v1-themes-1"}]}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Video Tutorials","pages":[{"title":"Video Tutorials","href":"/tutorials"}]}]},"basePath":"","title":"Create a Block - Sprig Docs","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CWFqNdGh.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}