Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.
Original delegated Clerk OAuth bearer. Go independently verifies signature/current revocation, exact resource audience, allowed OAuth client and action scope. Caller must match attributed API key creator. Never send an unverified subject header.
Versioned form definition with persistent option IDs. On writes, mutually exclusive with fields and form_presentation. Legacy revisions may omit this until their choices have IDs.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Batch Relay API","colors":{"primary":"#2563EB","light":"#EFF6FF","dark":"#1D4ED8"},"logo":{"light":"https://media.brand.dev/e0f13cde-5756-4d8b-bfdf-01f76e6b0d41.svg","dark":"https://media.brand.dev/e0f13cde-5756-4d8b-bfdf-01f76e6b0d41.svg"},"navbar":{"primary":{"type":"button","label":"Developer Dashboard","href":"https://app.batchrelay.com/developers"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ftrbnd","hasAudioNarration":false,"actualSubdomain":"ftrbnd","customDomains":["docs.batchrelay.com"],"gitSource":{"type":"github","owner":"sentinelite","repo":"batch-relay-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb62041a579503f229c714","collectionId":"23dfe798-efb7-41c4-b1c8-d0e85ac3e687","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb62041a579503f229c714"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aded16f6700f7f3814a1850","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":160},{"language":"default","tag":"Guides","count":33},{"language":"default","tag":"Studio Operations","count":26},{"language":"default","tag":"Core Concepts","count":16},{"language":"default","tag":"Studio catalog","count":16},{"language":"default","tag":"Product reference","count":13},{"language":"default","tag":"Studio management","count":12},{"language":"default","tag":"Studio offers","count":11},{"language":"default","tag":"Consumer printing","count":10},{"language":"default","tag":"API accounts","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/studio-operations/archive-studio-form-definition","slug":"/api-reference/studio-operations/archive-studio-form-definition","pageMetadata":{"title":"Archive studio form definition","description":"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/form-definitions/{form_definition_id}/archive","href":"/api-reference/studio-operations/archive-studio-form-definition","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: \"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.\"\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":"Archive studio form definition","description":"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/form-definitions/{form_definition_id}/archive","href":"/api-reference/studio-operations/archive-studio-form-definition","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.","operationId":"archiveStudioFormDefinition","parameters":["4c743a70-f028-45aa-b7f2-065ece63229d","6496bb2f-66d0-4bff-801f-8b2e99a40dd0","615d3b64-883c-4e5c-bd1d-6f346120ca04"],"requestBody":"87caa994-6523-43e5-b182-a1fa769ff40b","responses":{"200":"20e34fc3-4916-4764-aeee-f3fc905ce61a","401":"335bdd78-6efd-42b4-8d1b-97288173139a","403":"2017f042-8efa-4467-a778-ed67474a7bfc","404":"fbd9861b-bf4b-4b8d-a973-4520e8bfacb3","409":"ca21a268-6bd1-4b7d-9290-6d5dc33b126c","422":"966d30fd-7cd8-4953-ab95-4fe1088db48e","503":"1da58083-b1d1-4821-aaf9-a3da42cb2625"},"security":["d1537eb3-ae86-41e6-94e6-68d45056acf2"],"summary":"Archive studio form definition","tags":["Studio Operations"],"x-required-scopes":["forms:write"],"method":"post","type":"path","servers":["03bd255f-2b65-4435-a06a-bbd537bbae99"],"path":"/v1/studios/{studio_id}/form-definitions/{form_definition_id}/archive","baseUrlOptions":["https://api.batchrelay.com"],"title":"Archive studio form definition","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4c743a70-f028-45aa-b7f2-065ece63229d":{"description":"Original delegated Clerk OAuth bearer. Go independently verifies signature/current revocation, exact resource audience, allowed OAuth client and action scope. Caller must match attributed API key creator. Never send an unverified subject header.","in":"header","name":"X-BatchRelay-Delegated-Authorization","required":false,"schema":{"type":"string","isRequired":false,"description":"Original delegated Clerk OAuth bearer. Go independently verifies signature/current revocation, exact resource audience, allowed OAuth client and action scope. Caller must match attributed API key creator. Never send an unverified subject header.","uniqueKey":"","typeLabel":"string"}},"6496bb2f-66d0-4bff-801f-8b2e99a40dd0":{"description":"Opaque public studio_id. Private Convex IDs are rejected.","in":"path","name":"studio_id","required":true,"schema":{"type":"string","isRequired":true,"description":"Opaque public studio_id. Private Convex IDs are rejected.","uniqueKey":"","typeLabel":"string"}},"615d3b64-883c-4e5c-bd1d-6f346120ca04":{"description":"Opaque public form_definition_id. Private Convex IDs are rejected.","in":"path","name":"form_definition_id","required":true,"schema":{"type":"string","isRequired":true,"description":"Opaque public form_definition_id. Private Convex IDs are rejected.","uniqueKey":"","typeLabel":"string"}},"24234047-4e3d-4cd3-882d-6ea05138963b":{"description":"Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.","in":"header","name":"X-BatchRelay-Client-Surface","required":false,"schema":{"maxLength":100,"minLength":1,"type":"string","isRequired":false,"description":"Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.","uniqueKey":"","typeLabel":"string"}},"ff59d607-3da8-424d-83ec-017ff0ef4481":{"description":"Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.","in":"header","name":"X-BatchRelay-Client-Version","required":false,"schema":{"maxLength":100,"minLength":1,"type":"string","isRequired":false,"description":"Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.","uniqueKey":"","typeLabel":"string"}},"5ea0290c-4498-4407-b4c9-8ea26c44d60b":{"description":"Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.","in":"header","name":"X-BatchRelay-Invocation-Mode","required":false,"schema":{"maxLength":100,"minLength":1,"type":"string","isRequired":false,"description":"Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_edit_version":{"format":"int64","minimum":1,"type":"integer","isRequired":true,"uniqueKey":"expected_edit_version","typeLabel":"integer\u003cint64>"}},"required":["expected_edit_version"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"expected_edit_version":2}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"20e34fc3-4916-4764-aeee-f3fc905ce61a":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"input_type":{"enum":["text","number","select","checkbox","textarea","date","event_team"],"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].input_type","typeLabel":"enum\u003cstring>"},"key":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].key","typeLabel":"string"},"label":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].label","typeLabel":"string"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"fields.items.[INDEX].required","typeLabel":"boolean"},"sort_order":{"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"fields.items.[INDEX].sort_order","typeLabel":"integer"},"allow_multiple":{"type":"boolean","uniqueKey":"fields.items.[INDEX].allow_multiple","typeLabel":"boolean"},"boolean_display":{"enum":["toggle","yes_no"],"type":"string","uniqueKey":"fields.items.[INDEX].boolean_display","typeLabel":"enum\u003cstring>"},"description":{"maxLength":2000,"type":"string","uniqueKey":"fields.items.[INDEX].description","typeLabel":"string"},"option_ids":{"items":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","uniqueKey":"fields.items.[INDEX].option_ids.items.[INDEX]","typeLabel":"string"},"maxItems":200,"type":"array","uniqueItems":true,"uniqueKey":"fields.items.[INDEX].option_ids","typeLabel":"string[]"},"options":{"items":{"minLength":1,"type":"string","uniqueKey":"fields.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"maxItems":200,"type":"array","uniqueKey":"fields.items.[INDEX].options","typeLabel":"string[]"},"options_display":{"enum":["dropdown","pills"],"type":"string","uniqueKey":"fields.items.[INDEX].options_display","typeLabel":"enum\u003cstring>"},"placeholder":{"type":"string","uniqueKey":"fields.items.[INDEX].placeholder","typeLabel":"string"},"semantic_key":{"minLength":1,"type":"string","uniqueKey":"fields.items.[INDEX].semantic_key","typeLabel":"string"},"semantic_label":{"minLength":1,"type":"string","uniqueKey":"fields.items.[INDEX].semantic_label","typeLabel":"string"},"show_when":{"oneOf":[{"type":"object","required":["field_key","operator","option_ids"],"properties":{"field_key":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.0.field_key","typeLabel":"string"},"operator":{"const":"is_one_of","isRequired":true,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.0.operator","typeLabel":"any"},"option_ids":{"items":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","uniqueKey":"fields.items.[INDEX].show_when.oneOf.0.option_ids.items.[INDEX]","typeLabel":"string"},"maxItems":200,"minItems":1,"type":"array","uniqueItems":true,"isRequired":true,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.0.option_ids","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.0","typeLabel":"object"},{"type":"object","required":["field_key","operator","value"],"properties":{"field_key":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.1.field_key","typeLabel":"string"},"operator":{"const":"equals","isRequired":true,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.1.operator","typeLabel":"any"},"value":{"type":"boolean","isRequired":true,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.1.value","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"fields.items.[INDEX].show_when.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"fields.items.[INDEX].show_when.oneOf.2","typeLabel":"null"}],"uniqueKey":"fields.items.[INDEX].show_when","typeLabel":"object · object · null"}},"required":["key","label","input_type","required","sort_order"],"type":"object","uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"maxItems":200,"type":"array","isRequired":true,"uniqueKey":"fields","typeLabel":"object[]"},"id":{"description":"Stable public form-definition ID.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"studio_id":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"studio_id","typeLabel":"string"},"created_at":{"type":"string","uniqueKey":"created_at","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"edit_version":{"format":"int64","type":"integer","uniqueKey":"edit_version","typeLabel":"integer\u003cint64>"},"environment":{"type":"string","uniqueKey":"environment","typeLabel":"string"},"form_presentation":{"additionalProperties":false,"description":"Typed public form layout. It intentionally excludes heroStorageId, Convex IDs, athlete data, guardian data, and submitted answers.","properties":{"pages":{"items":{"additionalProperties":false,"properties":{"id":{"description":"Public stable layout page identifier, not a Convex document ID.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].id","typeLabel":"string"},"rows":{"items":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"field_key":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields.items.[INDEX].field_key","typeLabel":"string"},"width":{"enum":["full","half"],"type":"string","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields.items.[INDEX].width","typeLabel":"enum\u003cstring>"}},"required":["field_key","width"],"type":"object","uniqueKey":"form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields.items.[INDEX]","typeLabel":"object"},"maxItems":2,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields","typeLabel":"object[]"},"id":{"description":"Public stable layout row identifier, not a Convex document ID.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].rows.items.[INDEX].id","typeLabel":"string"}},"required":["id","fields"],"type":"object","uniqueKey":"form_presentation.pages.items.[INDEX].rows.items.[INDEX]","typeLabel":"object"},"maxItems":100,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].rows","typeLabel":"object[]"},"title":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_presentation.pages.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"form_presentation.pages.items.[INDEX].description","typeLabel":"string"}},"required":["id","title","rows"],"type":"object","uniqueKey":"form_presentation.pages.items.[INDEX]","typeLabel":"object"},"maxItems":50,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_presentation.pages","typeLabel":"object[]"},"public_title":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_presentation.public_title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"form_presentation.description","typeLabel":"string"}},"required":["public_title","pages"],"type":"object","uniqueKey":"form_presentation","typeLabel":"object"},"form_spec":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"input_type":{"enum":["text","number","select","checkbox","textarea","date","event_team"],"type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].input_type","typeLabel":"enum\u003cstring>"},"key":{"maxLength":160,"minLength":1,"pattern":"^[a-z0-9]+(?:_[a-z0-9]+)*$","type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].key","typeLabel":"string"},"label":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].label","typeLabel":"string"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].required","typeLabel":"boolean"},"sort_order":{"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].sort_order","typeLabel":"integer"},"allow_multiple":{"type":"boolean","uniqueKey":"form_spec.fields.items.[INDEX].allow_multiple","typeLabel":"boolean"},"boolean_display":{"enum":["toggle","yes_no"],"type":"string","uniqueKey":"form_spec.fields.items.[INDEX].boolean_display","typeLabel":"enum\u003cstring>"},"description":{"maxLength":2000,"type":"string","uniqueKey":"form_spec.fields.items.[INDEX].description","typeLabel":"string"},"options":{"items":{"additionalProperties":false,"properties":{"id":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].options.items.[INDEX].id","typeLabel":"string"},"label":{"maxLength":160,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"type":"object","uniqueKey":"form_spec.fields.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"maxItems":200,"minItems":1,"type":"array","uniqueKey":"form_spec.fields.items.[INDEX].options","typeLabel":"object[]"},"options_display":{"enum":["dropdown","pills"],"type":"string","uniqueKey":"form_spec.fields.items.[INDEX].options_display","typeLabel":"enum\u003cstring>"},"placeholder":{"type":"string","uniqueKey":"form_spec.fields.items.[INDEX].placeholder","typeLabel":"string"},"semantic_key":{"minLength":1,"type":"string","uniqueKey":"form_spec.fields.items.[INDEX].semantic_key","typeLabel":"string"},"show_when":{"oneOf":[{"type":"object","required":["field_key","operator","option_ids"],"properties":{"field_key":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.0.field_key","typeLabel":"string"},"operator":{"const":"is_one_of","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.0.operator","typeLabel":"any"},"option_ids":{"items":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.0.option_ids.items.[INDEX]","typeLabel":"string"},"maxItems":200,"minItems":1,"type":"array","uniqueItems":true,"isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.0.option_ids","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.0","typeLabel":"object"},{"type":"object","required":["field_key","operator","value"],"properties":{"field_key":{"maxLength":160,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,160}$","type":"string","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.1.field_key","typeLabel":"string"},"operator":{"const":"equals","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.1.operator","typeLabel":"any"},"value":{"type":"boolean","isRequired":true,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.1.value","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"form_spec.fields.items.[INDEX].show_when.oneOf.2","typeLabel":"null"}],"uniqueKey":"form_spec.fields.items.[INDEX].show_when","typeLabel":"object · object · null"}},"required":["key","label","input_type","required","sort_order"],"type":"object","uniqueKey":"form_spec.fields.items.[INDEX]","typeLabel":"object"},"maxItems":200,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_spec.fields","typeLabel":"object[]"},"name":{"maxLength":240,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.name","typeLabel":"string"},"spec_version":{"const":2,"description":"JSON specification version; independent of a form revision or draft edit version.","type":"integer","isRequired":true,"uniqueKey":"form_spec.spec_version","typeLabel":"integer"},"form_presentation":{"additionalProperties":false,"description":"Typed public form layout. It intentionally excludes heroStorageId, Convex IDs, athlete data, guardian data, and submitted answers.","properties":{"pages":{"items":{"additionalProperties":false,"properties":{"id":{"description":"Public stable layout page identifier, not a Convex document ID.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].id","typeLabel":"string"},"rows":{"items":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"field_key":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields.items.[INDEX].field_key","typeLabel":"string"},"width":{"enum":["full","half"],"type":"string","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields.items.[INDEX].width","typeLabel":"enum\u003cstring>"}},"required":["field_key","width"],"type":"object","uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields.items.[INDEX]","typeLabel":"object"},"maxItems":2,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows.items.[INDEX].fields","typeLabel":"object[]"},"id":{"description":"Public stable layout row identifier, not a Convex document ID.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows.items.[INDEX].id","typeLabel":"string"}},"required":["id","fields"],"type":"object","uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows.items.[INDEX]","typeLabel":"object"},"maxItems":100,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].rows","typeLabel":"object[]"},"title":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"form_spec.form_presentation.pages.items.[INDEX].description","typeLabel":"string"}},"required":["id","title","rows"],"type":"object","uniqueKey":"form_spec.form_presentation.pages.items.[INDEX]","typeLabel":"object"},"maxItems":50,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"form_spec.form_presentation.pages","typeLabel":"object[]"},"public_title":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"form_spec.form_presentation.public_title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"form_spec.form_presentation.description","typeLabel":"string"}},"required":["public_title","pages"],"type":"object","uniqueKey":"form_spec.form_presentation","typeLabel":"object"}},"required":["spec_version","name","fields"],"type":"object","description":"Versioned form definition with persistent option IDs. On writes, mutually exclusive with fields and form_presentation. Legacy revisions may omit this until their choices have IDs.","uniqueKey":"form_spec","typeLabel":"object"},"status":{"type":"string","uniqueKey":"status","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"updated_at","typeLabel":"string"}},"required":["id","studio_id","name","fields"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"fields":[{"input_type":"text","key":"\u003cstring>","label":"\u003cstring>","required":true,"sort_order":1,"allow_multiple":true,"boolean_display":"toggle","description":"\u003cstring>","option_ids":["\u003cstring>"],"options":["\u003cstring>"],"options_display":"dropdown","placeholder":"\u003cstring>","semantic_key":"\u003cstring>","semantic_label":"\u003cstring>","show_when":{"field_key":"\u003cstring>","operator":"is_one_of","option_ids":["\u003cstring>"]}}],"id":"\u003cstring>","name":"\u003cstring>","studio_id":"\u003cstring>","created_at":"\u003cstring>","description":"\u003cstring>","edit_version":123,"environment":"\u003cstring>","form_presentation":{"pages":[{"id":"\u003cstring>","rows":[{"fields":[{"field_key":"\u003cstring>","width":"full"}],"id":"\u003cstring>"}],"title":"\u003cstring>","description":"\u003cstring>"}],"public_title":"\u003cstring>","description":"\u003cstring>"},"form_spec":{"fields":[{"input_type":"text","key":"\u003cstring>","label":"\u003cstring>","required":true,"sort_order":1,"allow_multiple":true,"boolean_display":"toggle","description":"\u003cstring>","options":[{"id":"\u003cstring>","label":"\u003cstring>"}],"options_display":"dropdown","placeholder":"\u003cstring>","semantic_key":"\u003cstring>","show_when":{"field_key":"\u003cstring>","operator":"is_one_of","option_ids":["\u003cstring>"]}}],"name":"\u003cstring>","spec_version":2,"form_presentation":{"pages":[{"id":"\u003cstring>","rows":[{"fields":[{"field_key":"\u003cstring>","width":"full"}],"id":"\u003cstring>"}],"title":"\u003cstring>","description":"\u003cstring>"}],"public_title":"\u003cstring>","description":"\u003cstring>"}},"status":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Authoritative Studio result","exampleType":"generated"},"335bdd78-6efd-42b4-8d1b-97288173139a":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Invalid credential or expired/revoked delegated token","exampleType":"generated"},"2017f042-8efa-4467-a778-ed67474a7bfc":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Wrong Studio, role, action scope or disabled Live effects","exampleType":"generated"},"fbd9861b-bf4b-4b8d-a973-4520e8bfacb3":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Resource unavailable in this Studio and lane","exampleType":"generated"},"ca21a268-6bd1-4b7d-9290-6d5dc33b126c":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Stale resource, expired preview, dependency blocker or idempotency conflict","exampleType":"generated"},"966d30fd-7cd8-4953-ab95-4fe1088db48e":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Invalid typed request or unsupported query","exampleType":"generated"},"1da58083-b1d1-4821-aaf9-a3da42cb2625":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Required adapter or delegated verification is not configured","exampleType":"generated"}},"security":{"d1537eb3-ae86-41e6-94e6-68d45056acf2":{"bearerAuth":{"bearerFormat":"Batch Relay API key or anonymous session","description":"Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"03bd255f-2b65-4435-a06a-bbd537bbae99":{"url":"https://api.batchrelay.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"Batch Relay API key or anonymous session","description":"Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.batchrelay.com/openapi.json"},"subdomain":"ftrbnd","siteName":"Batch Relay API","title":"Archive studio form definition - Batch Relay API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T04:05:12.461Z","originalFileLocation":"api-reference/studio-operations/archive-studio-form-definition.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Batch Relay API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/ftrbnd/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/ftrbnd/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/ftrbnd/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/ftrbnd/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Archive studio form definition - Batch Relay API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Batch Relay API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ftrbnd.mintlify.app/_mintlify/api/og/v2?division=Studio+Operations\u0026amp;title=Archive+studio+form+definition\u0026amp;description=Requires+forms%3Awrite.+History+is+retained.+Delete+rejects+any+event%2C+revision+or+team+reference+and+incomplete+dependency+scan.\u0026amp;theme=182a8e84995dd9358c2ea7e4\u0026amp;signature=9f5cbfdbece95b7510d865642ac4e622e473d763c4446bc4f2e35c4681afd76b\">\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=\"Archive studio form definition - Batch Relay API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ftrbnd.mintlify.app/_mintlify/api/og/v2?division=Studio+Operations\u0026amp;title=Archive+studio+form+definition\u0026amp;description=Requires+forms%3Awrite.+History+is+retained.+Delete+rejects+any+event%2C+revision+or+team+reference+and+incomplete+dependency+scan.\u0026amp;theme=182a8e84995dd9358c2ea7e4\u0026amp;signature=9f5cbfdbece95b7510d865642ac4e622e473d763c4446bc4f2e35c4681afd76b\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/ftrbnd/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Batch Relay API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/studio-operations/archive-studio-form-definition.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.batchrelay.com/#organization\",\"name\":\"Batch Relay API\",\"url\":\"https://docs.batchrelay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://media.brand.dev/e0f13cde-5756-4d8b-bfdf-01f76e6b0d41.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.batchrelay.com#website\",\"name\":\"Batch Relay API\",\"url\":\"https://docs.batchrelay.com\",\"publisher\":{\"@id\":\"https://docs.batchrelay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition#webpage\",\"url\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition\",\"name\":\"Archive studio form definition\",\"description\":\"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.\",\"dateModified\":\"2026-10-26T04:05:12.461Z\",\"isPartOf\":{\"@id\":\"https://docs.batchrelay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Studio Operations\",\"item\":\"https://docs.batchrelay.com/api-reference/studio-operations/get-studio-athlete\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Archive studio form definition\",\"item\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition#apireference\",\"headline\":\"Archive studio form definition\",\"name\":\"Archive studio form definition\",\"description\":\"Requires forms:write. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.\",\"url\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition\",\"mainEntityOfPage\":{\"@id\":\"https://docs.batchrelay.com/api-reference/studio-operations/archive-studio-form-definition#webpage\"},\"dateModified\":\"2026-10-26T04:05:12.461Z\",\"publisher\":{\"@id\":\"https://docs.batchrelay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.batchrelay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Batch Relay API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Batch Relay API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/n8n"}]},{"tab":"Events","pages":[{"title":"Events","href":"/events/overview"}]},{"tab":"API Reference","groups":[{"group":"System","pages":[{"title":"Check API health","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /healthz","href":"/api-reference/system/check-api-health"},{"title":"Get this OpenAPI document","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /openapi.json","href":"/api-reference/system/get-this-openapi-document"}]},{"group":"Authentication","pages":[{"title":"Create an isolated Test Mode session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/anonymous-sessions","href":"/api-reference/authentication/create-an-isolated-test-mode-session"},{"title":"Get safe API-key or dashboard authentication context","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/auth/status","href":"/api-reference/authentication/get-safe-api-key-or-dashboard-authentication-context"}]},{"group":"Anonymous sessions","pages":[{"title":"Create a one-time anonymous session claim code","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/anonymous-sessions/current/claim-codes","href":"/api-reference/anonymous-sessions/create-a-one-time-anonymous-session-claim-code"}]},{"group":"API accounts","pages":[{"title":"List authorized API accounts","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/api-accounts","href":"/api-reference/api-accounts/list-authorized-api-accounts"},{"title":"Create an individual or studio-owned API account","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts","href":"/api-reference/api-accounts/create-an-individual-or-studio-owned-api-account"},{"title":"Get an authorized API account","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/api-accounts/{account_id}","href":"/api-reference/api-accounts/get-an-authorized-api-account"},{"title":"Activate an API account","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/activate","href":"/api-reference/api-accounts/activate-an-api-account"},{"title":"Get API account activation status","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/api-accounts/{account_id}/activation","href":"/api-reference/api-accounts/get-api-account-activation-status"},{"title":"Accept a versioned agreement","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/agreements/{agreement_id}/accept","href":"/api-reference/api-accounts/accept-a-versioned-agreement"},{"title":"Start hosted payment-method setup","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/billing/setup-sessions","href":"/api-reference/api-accounts/start-hosted-payment-method-setup"},{"title":"Claim an account sandbox","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/sandbox-claim","href":"/api-reference/api-accounts/claim-an-account-sandbox"},{"title":"Get API account usage and spend summary","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/usage","href":"/api-reference/api-accounts/get-api-account-usage-and-spend-summary"}]},{"group":"API keys","pages":[{"title":"List remote API keys","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/api-accounts/{account_id}/keys","href":"/api-reference/api-keys/list-remote-api-keys"},{"title":"Create a remote API key","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/keys","href":"/api-reference/api-keys/create-a-remote-api-key"},{"title":"Revoke a remote API key","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/keys/{key_id}/revoke","href":"/api-reference/api-keys/revoke-a-remote-api-key"},{"title":"Rotate a remote API key","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/api-accounts/{account_id}/keys/{key_id}/rotate","href":"/api-reference/api-keys/rotate-a-remote-api-key"}]},{"group":"Managed assets","pages":[{"title":"Copy one external image into Batch Relay-managed fulfillment storage","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/assets/ingest","href":"/api-reference/managed-assets/copy-one-external-image-into-batch-relay-managed-fulfillment-storage"}]},{"group":"Browser previews","pages":[{"title":"Get browser-preview proof status","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/browser-previews/{render_id}","href":"/api-reference/browser-previews/get-browser-preview-proof-status"},{"title":"Stream a short-lived browser-preview artifact","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/browser-previews/{render_id}/artifacts/{artifact_id}/content","href":"/api-reference/browser-previews/stream-a-short-lived-browser-preview-artifact"},{"title":"Get a published browser-preview package","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/templates/{template_id}/outputs/{output_id}/browser-preview","href":"/api-reference/browser-previews/get-a-published-browser-preview-package"},{"title":"Queue a short-lived browser proof render","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/templates/{template_id}/outputs/{output_id}/browser-preview","href":"/api-reference/browser-previews/queue-a-short-lived-browser-proof-render"},{"title":"Stream an authorized browser-preview source asset","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/templates/{template_id}/outputs/{output_id}/browser-preview/assets/{asset_ref}/content","href":"/api-reference/browser-previews/stream-an-authorized-browser-preview-source-asset"}]},{"group":"Catalog","pages":[{"title":"List active products","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/catalog/products","href":"/api-reference/catalog/list-active-products"},{"title":"Get one active product","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/catalog/products/{product_id}","href":"/api-reference/catalog/get-one-active-product"},{"title":"List exact published provider offers","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/catalog/products/{product_id}/offers","href":"/api-reference/catalog/list-exact-published-provider-offers"},{"title":"List semantic field definitions","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/catalog/semantic-fields","href":"/api-reference/catalog/list-semantic-field-definitions"},{"title":"Get a semantic field definition","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/catalog/semantic-fields/{semantic_key}","href":"/api-reference/catalog/get-a-semantic-field-definition"},{"title":"List V1 automation shipping services","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/catalog/shipping-services","href":"/api-reference/catalog/list-v1-automation-shipping-services"}]},{"group":"Consumer printing","pages":[{"title":"List guest print products and temporary retail prices","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/consumer/catalog","href":"/api-reference/consumer-printing/list-guest-print-products-and-temporary-retail-prices"},{"title":"Create a separate guest print session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/consumer/sessions","href":"/api-reference/consumer-printing/create-a-separate-guest-print-session"},{"title":"Read the exact owned guest session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/consumer/sessions/{session_id}","href":"/api-reference/consumer-printing/read-the-exact-owned-guest-session"},{"title":"Upload local prepared image bytes","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json put /v1/consumer/sessions/{session_id}/assets","href":"/api-reference/consumer-printing/upload-local-prepared-image-bytes"},{"title":"Import a public HTTPS image into owned managed artwork","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/consumer/sessions/{session_id}/assets","href":"/api-reference/consumer-printing/import-a-public-https-image-into-owned-managed-artwork"},{"title":"Read an owned artwork preview without public storage capabilities","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/consumer/sessions/{session_id}/assets/{asset_id}/preview","href":"/api-reference/consumer-printing/read-an-owned-artwork-preview-without-public-storage-capabilities"},{"title":"Replace a guest cart using owned artwork","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json put /v1/consumer/sessions/{session_id}/cart","href":"/api-reference/consumer-printing/replace-a-guest-cart-using-owned-artwork"},{"title":"Create or reuse a hosted Checkout from an owned frozen quote","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/consumer/sessions/{session_id}/checkout","href":"/api-reference/consumer-printing/create-or-reuse-a-hosted-checkout-from-an-owned-frozen-quote"},{"title":"Read an owned order status and valid pending checkout resume link","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/consumer/sessions/{session_id}/orders/{order_id}","href":"/api-reference/consumer-printing/read-an-owned-order-status-and-valid-pending-checkout-resume-link"},{"title":"Freeze cart, recipient, retail price, authoritative shipping and tax","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/consumer/sessions/{session_id}/quotes","href":"/api-reference/consumer-printing/freeze-cart-recipient-retail-price-authoritative-shipping-and-tax"}]},{"group":"Event context","pages":[{"title":"Get explicitly authorized purchaser context for a studio order event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/event-records/{event_id}/buyer","href":"/api-reference/event-context/get-explicitly-authorized-purchaser-context-for-a-studio-order-event"}]},{"group":"Event team changes","pages":[{"title":"Apply one reviewed bulk athlete team change","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/event-team-changes/apply","href":"/api-reference/event-team-changes/apply-one-reviewed-bulk-athlete-team-change"},{"title":"Prepare a studio-owned bulk athlete team change","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/event-team-changes/prepare","href":"/api-reference/event-team-changes/prepare-a-studio-owned-bulk-athlete-team-change"}]},{"group":"Studio management","pages":[{"title":"List events for the header-selected studio","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/events","href":"/api-reference/studio-management/list-events-for-the-header-selected-studio"},{"title":"Create an unpublished event for the header-selected studio","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/events","href":"/api-reference/studio-management/create-an-unpublished-event-for-the-header-selected-studio"},{"title":"Get an event for the header-selected studio","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/events/{event_id}","href":"/api-reference/studio-management/get-an-event-for-the-header-selected-studio"},{"title":"List studios available to this API credential","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios","href":"/api-reference/studio-management/list-studios-available-to-this-api-credential"},{"title":"List events for one explicit studio","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/events","href":"/api-reference/studio-management/list-events-for-one-explicit-studio"},{"title":"List an event's form revisions","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/events/{event_id}/form-revisions","href":"/api-reference/studio-management/list-an-events-form-revisions"},{"title":"Create a draft event form revision","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/form-revisions","href":"/api-reference/studio-management/create-a-draft-event-form-revision"},{"title":"Get one event form revision","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/events/{event_id}/form-revisions/{form_revision_id}","href":"/api-reference/studio-management/get-one-event-form-revision"},{"title":"Update an editable event form revision","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/events/{event_id}/form-revisions/{form_revision_id}","href":"/api-reference/studio-management/update-an-editable-event-form-revision"},{"title":"Publish an editable event form revision","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/form-revisions/{form_revision_id}/publish","href":"/api-reference/studio-management/publish-an-editable-event-form-revision"},{"title":"List reusable form definitions","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/form-definitions","href":"/api-reference/studio-management/list-reusable-form-definitions"},{"title":"Get a reusable form definition","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/form-definitions/{form_definition_id}","href":"/api-reference/studio-management/get-a-reusable-form-definition"}]},{"group":"Print orders","pages":[{"title":"List account-scoped API print orders","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/print-orders","href":"/api-reference/print-orders/list-account-scoped-api-print-orders"},{"title":"Submit a quoted API print order","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/print-orders","href":"/api-reference/print-orders/submit-a-quoted-api-print-order"},{"title":"Create a server-calculated API order quote","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/print-orders/quote","href":"/api-reference/print-orders/create-a-server-calculated-api-order-quote"},{"title":"Validate a non-authorizing prepared-media print order","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/print-orders/validate","href":"/api-reference/print-orders/validate-a-non-authorizing-prepared-media-print-order"},{"title":"Get an account-scoped API print order","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/print-orders/{order_id}","href":"/api-reference/print-orders/get-an-account-scoped-api-print-order"}]},{"group":"Template renders","pages":[{"title":"Get a template render and its output artifacts","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/renders/{render_id}","href":"/api-reference/template-renders/get-a-template-render-and-its-output-artifacts"},{"title":"List studio template renders","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/renders","href":"/api-reference/template-renders/list-studio-template-renders"},{"title":"Get one published output's render contract","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/templates/{template_id}/outputs/{output_id}/contract","href":"/api-reference/template-renders/get-one-published-outputs-render-contract"},{"title":"Create a render from a published template","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/templates/{template_id}/renders","href":"/api-reference/template-renders/create-a-render-from-a-published-template"}]},{"group":"Studio assets","pages":[{"title":"Reserve a studio-scoped original-asset upload session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studio-assets/sessions","href":"/api-reference/studio-assets/reserve-a-studio-scoped-original-asset-upload-session"},{"title":"Get a studio asset upload session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studio-assets/sessions/{session_id}","href":"/api-reference/studio-assets/get-a-studio-asset-upload-session"},{"title":"Upload bytes for one reserved studio asset","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json put /v1/studio-assets/sessions/{session_id}/assets/{asset_id}","href":"/api-reference/studio-assets/upload-bytes-for-one-reserved-studio-asset"}]},{"group":"Studio audit","pages":[{"title":"List privacy-safe studio management activity","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/activity","href":"/api-reference/studio-audit/list-privacy-safe-studio-management-activity"}]},{"group":"Studio Analytics","pages":[{"title":"Read Studio events analytics","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/analytics/events","href":"/api-reference/studio-analytics/read-studio-events-analytics"},{"title":"Read Studio sales analytics","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/analytics/sales","href":"/api-reference/studio-analytics/read-studio-sales-analytics"},{"title":"Read Studio sellables analytics","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/analytics/sellables","href":"/api-reference/studio-analytics/read-studio-sellables-analytics"}]},{"group":"Asset sessions","pages":[{"title":"Create an asset session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/asset-sessions","href":"/api-reference/asset-sessions/create-an-asset-session"},{"title":"Get an asset session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/asset-sessions/{session_id}","href":"/api-reference/asset-sessions/get-an-asset-session"},{"title":"Upload a session asset","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json put /v1/studios/{studio_id}/asset-sessions/{session_id}/assets/{asset_id}","href":"/api-reference/asset-sessions/upload-a-session-asset"},{"title":"Cancel an asset session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/asset-sessions/{session_id}/cancel","href":"/api-reference/asset-sessions/cancel-an-asset-session"},{"title":"Finalize an asset session","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/asset-sessions/{session_id}/finalize","href":"/api-reference/asset-sessions/finalize-an-asset-session"}]},{"group":"Assets","pages":[{"title":"List studio-scoped managed assets","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/assets","href":"/api-reference/assets/list-studio-scoped-managed-assets"}]},{"group":"Studio catalog assets","pages":[{"title":"Reserve a managed asset upload","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/assets/uploads","href":"/api-reference/studio-catalog-assets/reserve-a-managed-asset-upload"},{"title":"Finalize a managed asset upload","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/assets/uploads/{upload_session_id}/finalize","href":"/api-reference/studio-catalog-assets/finalize-a-managed-asset-upload"},{"title":"Get managed asset metadata","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/assets/{asset_id}","href":"/api-reference/studio-catalog-assets/get-managed-asset-metadata"}]},{"group":"Studio Operations","pages":[{"title":"Get studio athlete","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/athletes/{athlete_id}","href":"/api-reference/studio-operations/get-studio-athlete"},{"title":"Search studio customers","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/customers","href":"/api-reference/studio-operations/search-studio-customers"},{"title":"Get studio customer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/customers/{customer_id}","href":"/api-reference/studio-operations/get-studio-customer"},{"title":"List studio customer athletes","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/customers/{customer_id}/athletes","href":"/api-reference/studio-operations/list-studio-customer-athletes"},{"title":"Create studio event with setup","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events","href":"/api-reference/studio-operations/create-studio-event-with-setup"},{"title":"Get studio event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/events/{event_id}","href":"/api-reference/studio-operations/get-studio-event"},{"title":"Update studio event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/events/{event_id}","href":"/api-reference/studio-operations/update-studio-event"},{"title":"Archive studio event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/archive","href":"/api-reference/studio-operations/archive-studio-event"},{"title":"Delete studio event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/delete","href":"/api-reference/studio-operations/delete-studio-event"},{"title":"Delete studio event form revision","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json delete /v1/studios/{studio_id}/events/{event_id}/form-revisions/{form_revision_id}","href":"/api-reference/studio-operations/delete-studio-event-form-revision"},{"title":"Publish studio event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/publish","href":"/api-reference/studio-operations/publish-studio-event"},{"title":"Get studio event readiness","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/events/{event_id}/readiness","href":"/api-reference/studio-operations/get-studio-event-readiness"},{"title":"Restore studio event","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/restore","href":"/api-reference/studio-operations/restore-studio-event"},{"title":"Create studio form definition","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/form-definitions","href":"/api-reference/studio-operations/create-studio-form-definition"},{"title":"Update studio form definition","description":"Requires forms:write. Expected version required. Does not rewrite event-owned revisions or prior submissions.","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/form-definitions/{form_definition_id}","href":"/api-reference/studio-operations/update-studio-form-definition"},{"title":"Archive studio form definition","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/form-definitions/{form_definition_id}/archive","href":"/api-reference/studio-operations/archive-studio-form-definition"},{"title":"Delete studio form definition","description":"Requires forms:delete. History is retained. Delete rejects any event, revision or team reference and incomplete dependency scan.","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/form-definitions/{form_definition_id}/delete","href":"/api-reference/studio-operations/delete-studio-form-definition"},{"title":"Restore studio form definition","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/form-definitions/{form_definition_id}/restore","href":"/api-reference/studio-operations/restore-studio-form-definition"},{"title":"List studio retail orders","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/orders","href":"/api-reference/studio-operations/list-studio-retail-orders"},{"title":"Get studio retail order","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/orders/{order_id}","href":"/api-reference/studio-operations/get-studio-retail-order"},{"title":"Get studio order delivery","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/orders/{order_id}/delivery","href":"/api-reference/studio-operations/get-studio-order-delivery"},{"title":"Get studio order refund eligibility","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/orders/{order_id}/refund-eligibility","href":"/api-reference/studio-operations/get-studio-order-refund-eligibility"},{"title":"List studio outstanding orders","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/outstanding-orders","href":"/api-reference/studio-operations/list-studio-outstanding-orders"},{"title":"Prepare studio order refund","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/refund-previews","href":"/api-reference/studio-operations/prepare-studio-order-refund"},{"title":"Apply studio order refund","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/refund-requests","href":"/api-reference/studio-operations/apply-studio-order-refund"},{"title":"Get studio order refund status","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/refund-requests/{request_id}","href":"/api-reference/studio-operations/get-studio-order-refund-status"}]},{"group":"Checkout links","pages":[{"title":"List studio checkout links","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/checkout-links","href":"/api-reference/checkout-links/list-studio-checkout-links"},{"title":"Create a studio-scoped guest checkout link","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/checkout-links","href":"/api-reference/checkout-links/create-a-studio-scoped-guest-checkout-link"},{"title":"Get a studio-scoped checkout link","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/checkout-links/{link_id}","href":"/api-reference/checkout-links/get-a-studio-scoped-checkout-link"},{"title":"Prepare a payable checkout URL","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/checkout-links/{link_id}/prepare","href":"/api-reference/checkout-links/prepare-a-payable-checkout-url"},{"title":"Recover a prepared checkout URL","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/checkout-links/{link_id}/recover","href":"/api-reference/checkout-links/recover-a-prepared-checkout-url"},{"title":"Revoke a studio-scoped checkout link","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/checkout-links/{link_id}/revoke","href":"/api-reference/checkout-links/revoke-a-studio-scoped-checkout-link"},{"title":"Get checkout payment status","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/checkout-links/{link_id}/status","href":"/api-reference/checkout-links/get-checkout-payment-status"}]},{"group":"Image imports","pages":[{"title":"Create an event image import","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/image-imports","href":"/api-reference/image-imports/create-an-event-image-import"},{"title":"Get an event image import","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/events/{event_id}/image-imports/{import_id}","href":"/api-reference/image-imports/get-an-event-image-import"},{"title":"Review an event image import","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/events/{event_id}/image-imports/{import_id}","href":"/api-reference/image-imports/review-an-event-image-import"},{"title":"Cancel an event image import","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/image-imports/{import_id}/cancel","href":"/api-reference/image-imports/cancel-an-event-image-import"},{"title":"Commit an event image import","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/events/{event_id}/image-imports/{import_id}/commit","href":"/api-reference/image-imports/commit-an-event-image-import"}]},{"group":"Studio messages","pages":[{"title":"List a studio's operational messages","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/messages","href":"/api-reference/studio-messages/list-a-studios-operational-messages"},{"title":"Create or schedule an operational event message","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/messages","href":"/api-reference/studio-messages/create-or-schedule-an-operational-event-message"},{"title":"Get an operational message","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/messages/{message_id}","href":"/api-reference/studio-messages/get-an-operational-message"},{"title":"Cancel a draft or scheduled message","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/messages/{message_id}/cancel","href":"/api-reference/studio-messages/cancel-a-draft-or-scheduled-message"},{"title":"Create an immutable correction","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/messages/{message_id}/corrections","href":"/api-reference/studio-messages/create-an-immutable-correction"},{"title":"List read and delivery facts without recipient addresses","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/messages/{message_id}/recipients","href":"/api-reference/studio-messages/list-read-and-delivery-facts-without-recipient-addresses"}]},{"group":"Studio offers","pages":[{"title":"List studio offers","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/offers","href":"/api-reference/studio-offers/list-studio-offers"},{"title":"Create a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers","href":"/api-reference/studio-offers/create-a-studio-offer"},{"title":"Get a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/offers/{offer_id}","href":"/api-reference/studio-offers/get-a-studio-offer"},{"title":"Append a studio offer revision","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/offers/{offer_id}","href":"/api-reference/studio-offers/append-a-studio-offer-revision"},{"title":"Activate a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers/{offer_id}/activate","href":"/api-reference/studio-offers/activate-a-studio-offer"},{"title":"Preview studio offer margin","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers/{offer_id}/margin-preview","href":"/api-reference/studio-offers/preview-studio-offer-margin"},{"title":"Pause a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers/{offer_id}/pause","href":"/api-reference/studio-offers/pause-a-studio-offer"},{"title":"List offer redemptions","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/offers/{offer_id}/redemptions","href":"/api-reference/studio-offers/list-offer-redemptions"},{"title":"Resume a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers/{offer_id}/resume","href":"/api-reference/studio-offers/resume-a-studio-offer"},{"title":"Revoke a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers/{offer_id}/revoke","href":"/api-reference/studio-offers/revoke-a-studio-offer"},{"title":"Schedule a studio offer","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/offers/{offer_id}/schedule","href":"/api-reference/studio-offers/schedule-a-studio-offer"}]},{"group":"Studio catalog","pages":[{"title":"List studio packages","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/packages","href":"/api-reference/studio-catalog/list-studio-packages"},{"title":"Create a draft package","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/packages","href":"/api-reference/studio-catalog/create-a-draft-package"},{"title":"Get a package","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/packages/{package_id}","href":"/api-reference/studio-catalog/get-a-package"},{"title":"Update a package draft","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/packages/{package_id}","href":"/api-reference/studio-catalog/update-a-package-draft"},{"title":"Archive a package","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/packages/{package_id}/archive","href":"/api-reference/studio-catalog/archive-a-package"},{"title":"Publish a package","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/packages/{package_id}/publish","href":"/api-reference/studio-catalog/publish-a-package"},{"title":"Restore a package","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/packages/{package_id}/restore","href":"/api-reference/studio-catalog/restore-a-package"},{"title":"List a studio's retail products","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/products","href":"/api-reference/studio-catalog/list-a-studios-retail-products"},{"title":"Create a draft studio product","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/products","href":"/api-reference/studio-catalog/create-a-draft-studio-product"},{"title":"Get a studio product","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/products/{product_id}","href":"/api-reference/studio-catalog/get-a-studio-product"},{"title":"Update a product draft","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/products/{product_id}","href":"/api-reference/studio-catalog/update-a-product-draft"},{"title":"Archive a product","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/products/{product_id}/archive","href":"/api-reference/studio-catalog/archive-a-product"},{"title":"Publish a product","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/products/{product_id}/publish","href":"/api-reference/studio-catalog/publish-a-product"},{"title":"Restore a product","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/products/{product_id}/restore","href":"/api-reference/studio-catalog/restore-a-product"},{"title":"List product variants","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/products/{product_id}/variants","href":"/api-reference/studio-catalog/list-product-variants"},{"title":"Create a product variant","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/products/{product_id}/variants","href":"/api-reference/studio-catalog/create-a-product-variant"}]},{"group":"Sandbox promotions","pages":[{"title":"Create an immutable sandbox-to-Live promotion plan","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/sandbox-promotions","href":"/api-reference/sandbox-promotions/create-an-immutable-sandbox-to-live-promotion-plan"},{"title":"Get a bounded sandbox-to-Live promotion plan","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/sandbox-promotions/{promotion_id}","href":"/api-reference/sandbox-promotions/get-a-bounded-sandbox-to-live-promotion-plan"},{"title":"Apply one reviewed sandbox-to-Live promotion plan","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/apply","href":"/api-reference/sandbox-promotions/apply-one-reviewed-sandbox-to-live-promotion-plan"},{"title":"Roll back one applied sandbox-to-Live promotion","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback","href":"/api-reference/sandbox-promotions/roll-back-one-applied-sandbox-to-live-promotion"}]},{"group":"Storefront","pages":[{"title":"Get a studio storefront assortment","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/storefront","href":"/api-reference/storefront/get-a-studio-storefront-assortment"},{"title":"Atomically replace a studio storefront assortment","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json patch /v1/studios/{studio_id}/storefront","href":"/api-reference/storefront/atomically-replace-a-studio-storefront-assortment"}]},{"group":"Templates","pages":[{"title":"List published studio templates","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/templates","href":"/api-reference/templates/list-published-studio-templates"},{"title":"Get one studio template","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/templates/{template_id}","href":"/api-reference/templates/get-one-studio-template"},{"title":"List a template's compatible canonical products","deprecated":null,"version":null,"openapi":"https://api.batchrelay.com/openapi.json get /v1/studios/{studio_id}/templates/{template_id}/outputs","href":"/api-reference/templates/list-a-templates-compatible-canonical-products"}]}]}]},"title":"Archive studio form definition - Batch Relay API","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-7TwLLapg.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}