API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TesterArmy","description":"TesterArmy documentation: AI-agent testing automation for web and mobile apps. Set up projects, write reliable test steps, automate runs from CI, and use the CLI, MCP server, and public API.","colors":{"primary":"#FF8001","light":"#FFB56C","dark":"#9C4E01"},"logo":{"light":"https://mintcdn.com/tester-army/cxPvc8T8okiKYoP3/logo/light.svg?fit=max\u0026auto=format\u0026n=cxPvc8T8okiKYoP3\u0026q=85\u0026s=d248c622a49091cb7ef1cb2868377b57","dark":"https://mintcdn.com/tester-army/cxPvc8T8okiKYoP3/logo/dark.svg?fit=max\u0026auto=format\u0026n=cxPvc8T8okiKYoP3\u0026q=85\u0026s=4923170b5bc1dfc1be671c8041a295b4","href":"https://tester.army"},"favicon":"https://mintcdn.com/tester-army/cxPvc8T8okiKYoP3/favicon.ico?fit=max\u0026auto=format\u0026n=cxPvc8T8okiKYoP3\u0026q=85\u0026s=373aa31169919bd93ccf0d24514ffcde","appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF","dark":"#161616"}},"navbar":{"links":[{"href":"https://tester.army/discord","label":"Discord"}],"primary":{"type":"button","label":"Start testing","href":"https://tester.army/sign-up"}},"footer":{"socials":{"github":"https://github.com/tester-army","x":"https://x.com/intent/user?screen_name=testerarmy","discord":"https://tester.army/discord"}},"seo":{"metatags":{"og:site_name":"TesterArmy","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@TesterArmy"},"indexing":"navigable"},"fonts":{"heading":{"family":"Stack Sans Notch","weight":500,"source":"https://tester.army/fonts/stack-sans-notch-latin-wght-normal.woff2","format":"woff2"},"body":{"family":"Inter","source":"https://tester.army/fonts/inter-latin-wght-normal.woff2","format":"woff2"}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":"vesper"},"latex":false},"integrations":{"posthog":{"apiKey":"phc_zp7taksuGbNJPWKOStUpbJTSvjE7KOikZWALbJY9sHB","apiHost":"https://eu.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tester-army","hasAudioNarration":false,"actualSubdomain":"tester-army","customDomains":["docs.tester.army"],"gitSource":{"type":"github","owner":"tester-army","repo":"app","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae1e6b98ead5bbc3c1ca1b1","collectionId":"12e30053-7fe7-4e87-aa51-3d48cacd15d0","liveDeploymentHistoryId":"6ae1e6b98ead5bbc3c1ca1b1","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1e6b98ead5bbc3c1ca1b1","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Docs","count":71},{"language":"default","tag":"API Reference","count":59},{"language":"default","tag":"Endpoints","count":58},{"language":"default","tag":"Projects","count":25},{"language":"default","tag":"Automate Testing","count":20},{"language":"default","tag":"Build and Run Tests","count":13},{"language":"default","tag":"Test Runs","count":12},{"language":"default","tag":"Groups","count":11},{"language":"default","tag":"Set Up Your Project","count":9},{"language":"default","tag":"Migrate to TesterArmy","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"DM Mono\";src:url(https://tester.army/fonts/dm-mono-latin-400-normal.woff2) format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"DM Mono\";src:url(https://tester.army/fonts/dm-mono-latin-500-normal.woff2) format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}:root{--ta-orange-300:rgb(255 128 1);--ta-grey-50:rgb(232 232 232);--ta-grey-400:rgb(78 78 78);--ta-grey-500:rgb(22 22 22)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}[class*=rounded]:not([class*=rounded-full]){border-radius:0!important}#content h1,#content h2,#content h3,#content h4,#content strong,#content th,#page-title,#page-title h1,#sidebar [data-active=true]{font-weight:500}#content h3,#content h4,#content h5,#content h6{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif}#content h2,#content h3{letter-spacing:-.01em}#page-title{padding-top:1rem;border-top:2px solid var(--ta-orange-300)}#topbar-cta-button a{padding:10px 20px}#topbar-cta-button a>span.absolute{background-color:var(--ta-orange-300);opacity:1;clip-path:polygon(12px 0,100% 0,100% 12px,calc(100% - 12px) 12px,calc(100% - 12px) 24px,100% 24px,100% 100%,0 100%,0 12px,12px 12px)}#topbar-cta-button a:focus-visible>span.absolute,#topbar-cta-button a:hover>span.absolute{clip-path:polygon(0 0,100% 0,100% 24px,calc(100% - 12px) 24px,calc(100% - 12px) 100%,0 100%,0 24px,12px 24px,12px 12px,0 12px)}#topbar-cta-button a .text-white{color:var(--ta-grey-500);font-family:\"DM Mono\",ui-monospace,monospace;font-size:12px;line-height:16px;font-weight:500;letter-spacing:.07em;text-transform:uppercase}#topbar-cta-button a svg{display:none}#content h2{padding-top:1rem;border-top:1px solid var(--ta-grey-50)}.dark #content h2{border-top-color:var(--ta-grey-400)}code,kbd,pre,samp{font-family:\"DM Mono\",ui-monospace,SFMono-Regular,Menlo,monospace}#content :not(pre)>code{font-weight:500}#content-area{max-width:816px;margin-right:auto}"}],"page":{"pagePath":"api-reference/tests/update-a-test","slug":"/api-reference/tests/update-a-test","pageMetadata":{"title":"Update a test","description":"Update a structured test definition. `settings` is merged field by field; every other field replaces its stored value.","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/tests/{testId}","href":"/api-reference/tests/update-a-test","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Update a structured test definition. \", _jsx(_components.code, {\n children: \"settings\"\n }), \" is merged field by field; every other field replaces its stored value.\"]\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":{"codeStyling":{"theme":"vesper"},"config":{},"pageMetadata":{"title":"Update a test","description":"Update a structured test definition. `settings` is merged field by field; every other field replaces its stored value.","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/tests/{testId}","href":"/api-reference/tests/update-a-test","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update a test","description":"Update a structured test definition. `settings` is merged field by field; every other field replaces its stored value.","tags":["Tests"],"security":["e08f758b-aa2a-4b2f-ab3f-a63d3c3fc2ef"],"parameters":["54307b53-983d-4784-a60a-e424dbfe71a2"],"requestBody":"6cb2c90d-4225-4567-a506-9ccd045433cc","responses":{"200":"adcc0b63-36c8-4012-97dc-ad5748970dfa","400":"df0fa4b5-b1d1-4a3f-8fab-afd2484704ce","401":"3d897d31-b3cc-40ac-b530-044d46cfac36","429":"0caf06a7-404f-4473-8214-d3c451c60fa4","500":"011d6f4b-3016-4913-9792-885c08fcd0f3","504":"7c6848c7-1355-4a73-bcac-6e5dcd06e7ad"},"method":"patch","type":"path","servers":["f7d6b841-ce67-4f63-b602-423cc7a1f4a0"],"path":"/v1/tests/{testId}","baseUrlOptions":["https://tester.army/api"],"title":"Update a test","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"54307b53-983d-4784-a60a-e424dbfe71a2":{"schema":{"type":"string","format":"uuid","description":"Test ID","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Test ID","name":"testId","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":500,"uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"steps":{"type":"array","items":{"oneOf":[{"type":"object","required":["title","type"],"properties":{"title":{"type":"string","minLength":1,"maxLength":2000,"description":"Action to perform. Reference a project file for upload by writing @ followed by its exact filename (e.g. @receipt.jpg); the run resolves it by name.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.title","typeLabel":"string"},"type":{"type":"string","enum":["act"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.0.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["title","type"],"properties":{"title":{"type":"string","minLength":1,"maxLength":2000,"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.1.title","typeLabel":"string"},"type":{"type":"string","enum":["assert"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.1.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["title","type"],"properties":{"title":{"type":"string","maxLength":2000,"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.2.title","typeLabel":"string"},"type":{"type":"string","enum":["login"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"credentialId":{"type":"string","format":"uuid","uniqueKey":"steps.items.[INDEX].oneOf.2.credentialId","typeLabel":"string\u003cuuid>"},"temporaryEmail":{"type":"boolean","uniqueKey":"steps.items.[INDEX].oneOf.2.temporaryEmail","typeLabel":"boolean"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.2.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["title","type","fileIds"],"properties":{"title":{"type":"string","maxLength":2000,"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.3.title","typeLabel":"string"},"type":{"type":"string","enum":["files"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"fileIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"steps.items.[INDEX].oneOf.3.fileIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.3.fileIds","typeLabel":"string\u003cuuid>[]"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.3.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["screenshot"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","maxLength":2000,"uniqueKey":"steps.items.[INDEX].oneOf.4.title","typeLabel":"string"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.4.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["type","code"],"properties":{"type":{"type":"string","enum":["javascript"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","maxLength":10000,"description":"JavaScript run in the browser page. Runs as an awaited function body; passes unless it throws or returns { success: false, reason }; any other return value, including diagnostic data, counts as a pass. Web tests only.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.5.code","typeLabel":"string"},"title":{"type":"string","maxLength":2000,"uniqueKey":"steps.items.[INDEX].oneOf.5.title","typeLabel":"string"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.5.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["type","fileId","mode"],"properties":{"type":{"type":"string","enum":["microphone"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"fileId":{"oneOf":[{"type":"string","description":"Project file ID (UUID) of the audio file (e.g. MP3) to play through the microphone. Empty string marks an unconfigured draft that must have a file attached before the test runs.","format":"uuid","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.6.fileId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"string","description":"Project file ID (UUID) of the audio file (e.g. MP3) to play through the microphone. Empty string marks an unconfigured draft that must have a file attached before the test runs.","enum":[""],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.6.fileId.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.6.fileId","typeLabel":"string\u003cuuid> | enum\u003cstring>"},"mode":{"type":"string","enum":["blocking","loop"],"description":"blocking: the agent waits for playback to finish before continuing. loop: playback repeats until the run ends and the agent continues immediately. Web tests only.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.6.mode","typeLabel":"enum\u003cstring>"},"title":{"type":"string","maxLength":2000,"uniqueKey":"steps.items.[INDEX].oneOf.6.title","typeLabel":"string"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"steps.items.[INDEX].oneOf.6.disabled","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].oneOf.6","typeLabel":"object"}],"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":30,"uniqueKey":"steps","typeLabel":"object[]"},"settings":{"type":"object","description":"Settings patch; omitted fields keep their stored value.","properties":{"executionMode":{"type":"string","enum":["fast","deep"],"description":"Deprecated and ignored. Deep mode was removed; every run uses the same mode.","uniqueKey":"settings.executionMode","typeLabel":"enum\u003cstring>"},"browserRegion":{"oneOf":[{"type":"string","enum":["us","us-dynamic","eu","pl",null],"description":"Per-test proxy exit region. null falls back to the project's region.","uniqueKey":"settings.browserRegion.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["us","us-dynamic","eu","pl",null],"description":"Per-test proxy exit region. null falls back to the project's region.","uniqueKey":"settings.browserRegion.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.browserRegion","typeLabel":"enum\u003cstring> | null"},"simulatorRegion":{"type":"string","enum":["eu-north1","us-west1"],"description":"Region the simulator or emulator runs in. Mobile tests only.","uniqueKey":"settings.simulatorRegion","typeLabel":"enum\u003cstring>"},"viewport":{"oneOf":[{"type":"string","enum":["desktop","desktop-hd","mobile","tablet",null],"description":"Browser viewport preset: desktop (1280x800), desktop-hd (1920x1080), mobile (390x844), tablet (768x1024). null restores the default. Web tests only.","uniqueKey":"settings.viewport.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["desktop","desktop-hd","mobile","tablet",null],"description":"Browser viewport preset: desktop (1280x800), desktop-hd (1920x1080), mobile (390x844), tablet (768x1024). null restores the default. Web tests only.","uniqueKey":"settings.viewport.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.viewport","typeLabel":"enum\u003cstring> | null"},"webSearchEnabled":{"type":"boolean","description":"Allow the test to use internet search for factual checks.","uniqueKey":"settings.webSearchEnabled","typeLabel":"boolean"},"prepGroupId":{"oneOf":[{"type":"string","format":"uuid","description":"Group whose preparation test a solo run of this test uses.","uniqueKey":"settings.prepGroupId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Group whose preparation test a solo run of this test uses.","uniqueKey":"settings.prepGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.prepGroupId","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"settings","typeLabel":"object"},"enabled":{"type":"boolean","uniqueKey":"enabled","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","description":"\u003cstring>","steps":[{"title":"\u003cstring>","type":"act","disabled":true}],"settings":{"webSearchEnabled":true,"prepGroupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"enabled":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"adcc0b63-36c8-4012-97dc-ad5748970dfa":{"description":"Test updated","content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"test.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"test.title","typeLabel":"string"},"steps":{"type":"array","items":{"oneOf":[{"type":"object","required":["title","type"],"properties":{"title":{"type":"string","minLength":1,"maxLength":2000,"description":"Action to perform. Reference a project file for upload by writing @ followed by its exact filename (e.g. @receipt.jpg); the run resolves it by name.","isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.0.title","typeLabel":"string"},"type":{"type":"string","enum":["act"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.0.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["title","type"],"properties":{"title":{"type":"string","minLength":1,"maxLength":2000,"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.1.title","typeLabel":"string"},"type":{"type":"string","enum":["assert"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.1.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["title","type"],"properties":{"title":{"type":"string","maxLength":2000,"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.2.title","typeLabel":"string"},"type":{"type":"string","enum":["login"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"credentialId":{"type":"string","format":"uuid","uniqueKey":"test.steps.items.[INDEX].oneOf.2.credentialId","typeLabel":"string\u003cuuid>"},"temporaryEmail":{"type":"boolean","uniqueKey":"test.steps.items.[INDEX].oneOf.2.temporaryEmail","typeLabel":"boolean"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.2.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["title","type","fileIds"],"properties":{"title":{"type":"string","maxLength":2000,"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.3.title","typeLabel":"string"},"type":{"type":"string","enum":["files"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"fileIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"test.steps.items.[INDEX].oneOf.3.fileIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.3.fileIds","typeLabel":"string\u003cuuid>[]"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.3.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["screenshot"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","maxLength":2000,"uniqueKey":"test.steps.items.[INDEX].oneOf.4.title","typeLabel":"string"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.4.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["type","code"],"properties":{"type":{"type":"string","enum":["javascript"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","maxLength":10000,"description":"JavaScript run in the browser page. Runs as an awaited function body; passes unless it throws or returns { success: false, reason }; any other return value, including diagnostic data, counts as a pass. Web tests only.","isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.5.code","typeLabel":"string"},"title":{"type":"string","maxLength":2000,"uniqueKey":"test.steps.items.[INDEX].oneOf.5.title","typeLabel":"string"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.5.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["type","fileId","mode"],"properties":{"type":{"type":"string","enum":["microphone"],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"fileId":{"oneOf":[{"type":"string","description":"Project file ID (UUID) of the audio file (e.g. MP3) to play through the microphone. Empty string marks an unconfigured draft that must have a file attached before the test runs.","format":"uuid","isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.6.fileId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"string","description":"Project file ID (UUID) of the audio file (e.g. MP3) to play through the microphone. Empty string marks an unconfigured draft that must have a file attached before the test runs.","enum":[""],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.6.fileId.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.6.fileId","typeLabel":"string\u003cuuid> | enum\u003cstring>"},"mode":{"type":"string","enum":["blocking","loop"],"description":"blocking: the agent waits for playback to finish before continuing. loop: playback repeats until the run ends and the agent continues immediately. Web tests only.","isRequired":true,"uniqueKey":"test.steps.items.[INDEX].oneOf.6.mode","typeLabel":"enum\u003cstring>"},"title":{"type":"string","maxLength":2000,"uniqueKey":"test.steps.items.[INDEX].oneOf.6.title","typeLabel":"string"},"disabled":{"type":"boolean","description":"When true, the step stays saved on the test but is skipped during runs.","uniqueKey":"test.steps.items.[INDEX].oneOf.6.disabled","typeLabel":"boolean"}},"uniqueKey":"test.steps.items.[INDEX].oneOf.6","typeLabel":"object"}],"uniqueKey":"test.steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"test.steps","typeLabel":"object[]"},"description":{"oneOf":[{"type":"string","uniqueKey":"test.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"test.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"test.description","typeLabel":"string | null"},"enabled":{"type":"boolean","uniqueKey":"test.enabled","typeLabel":"boolean"},"platform":{"type":"string","enum":["web","mobile"],"uniqueKey":"test.platform","typeLabel":"enum\u003cstring>"},"settings":{"type":"object","properties":{"executionMode":{"type":"string","enum":["fast","deep"],"description":"Deprecated and ignored. Deep mode was removed; every run uses the same mode.","uniqueKey":"test.settings.executionMode","typeLabel":"enum\u003cstring>"},"browserRegion":{"oneOf":[{"type":"string","enum":["us","us-dynamic","eu","pl",null],"description":"Per-test proxy exit region. null falls back to the project's region.","uniqueKey":"test.settings.browserRegion.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["us","us-dynamic","eu","pl",null],"description":"Per-test proxy exit region. null falls back to the project's region.","uniqueKey":"test.settings.browserRegion.oneOf.1","typeLabel":"null"}],"uniqueKey":"test.settings.browserRegion","typeLabel":"enum\u003cstring> | null"},"simulatorRegion":{"type":"string","enum":["eu-north1","us-west1"],"description":"Region the simulator or emulator runs in. Mobile tests only.","uniqueKey":"test.settings.simulatorRegion","typeLabel":"enum\u003cstring>"},"viewport":{"oneOf":[{"type":"string","enum":["desktop","desktop-hd","mobile","tablet",null],"description":"Browser viewport preset: desktop (1280x800), desktop-hd (1920x1080), mobile (390x844), tablet (768x1024). null restores the default. Web tests only.","uniqueKey":"test.settings.viewport.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["desktop","desktop-hd","mobile","tablet",null],"description":"Browser viewport preset: desktop (1280x800), desktop-hd (1920x1080), mobile (390x844), tablet (768x1024). null restores the default. Web tests only.","uniqueKey":"test.settings.viewport.oneOf.1","typeLabel":"null"}],"uniqueKey":"test.settings.viewport","typeLabel":"enum\u003cstring> | null"},"webSearchEnabled":{"type":"boolean","description":"Allow the test to use internet search for factual checks.","uniqueKey":"test.settings.webSearchEnabled","typeLabel":"boolean"},"prepGroupId":{"oneOf":[{"type":"string","format":"uuid","description":"Group whose preparation test a solo run of this test uses.","uniqueKey":"test.settings.prepGroupId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Group whose preparation test a solo run of this test uses.","uniqueKey":"test.settings.prepGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"test.settings.prepGroupId","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"test.settings","typeLabel":"object"},"projectId":{"type":"string","format":"uuid","uniqueKey":"test.projectId","typeLabel":"string\u003cuuid>"},"projectUrl":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"test.projectUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"test.projectUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"test.projectUrl","typeLabel":"string\u003curi> | null"},"projectName":{"type":"string","uniqueKey":"test.projectName","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"test.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"test.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","title","steps"],"isRequired":true,"uniqueKey":"test","typeLabel":"object"}},"required":["test"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"test":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","steps":[{"title":"\u003cstring>","type":"act","disabled":true}],"description":"\u003cstring>","enabled":true,"platform":"web","settings":{"executionMode":"fast","browserRegion":"us","simulatorRegion":"eu-north1","viewport":"desktop","webSearchEnabled":true,"prepGroupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"projectId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","projectUrl":"\u003cstring>","projectName":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"df0fa4b5-b1d1-4a3f-8fab-afd2484704ce":{"description":"Bad Request - Invalid input parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error code or type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3d897d31-b3cc-40ac-b530-044d46cfac36":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error code or type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0caf06a7-404f-4473-8214-d3c451c60fa4":{"description":"Too Many Requests - Usage limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error code or type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"011d6f4b-3016-4913-9792-885c08fcd0f3":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error code or type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7c6848c7-1355-4a73-bcac-6e5dcd06e7ad":{"description":"Gateway Timeout - Test execution exceeded time limit","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error code or type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e08f758b-aa2a-4b2f-ab3f-a63d3c3fc2ef":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"API key authentication using Bearer token format. The CLI's `ta auth` access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the `x-testerarmy-team` header (workspace id or slug).","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"f7d6b841-ce67-4f63-b602-423cc7a1f4a0":{"url":"https://tester.army/api","description":"Production API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"API key authentication using Bearer token format. The CLI's `ta auth` access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the `x-testerarmy-team` header (workspace id or slug).","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication using Bearer token format. The CLI's `ta auth` access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the `x-testerarmy-team` header (workspace id or slug).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"tester-army","siteName":"TesterArmy","title":"Update a test - TesterArmy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T09:29:00.517Z","originalFileLocation":"api-reference/tests/update-a-test.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=\"Update a structured test definition. settings is merged field by field; every other field replaces its stored value.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TesterArmy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_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/tester-army/TtppYuy6BcVq96kt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a test - TesterArmy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a structured test definition. settings is merged field by field; every other field replaces its stored value.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TesterArmy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tester.army/api-reference/tests/update-a-test\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tester-army.mintlify.app/_mintlify/api/og/v2?division=Tests\u0026amp;title=Update+a+test\u0026amp;description=Update+a+structured+test+definition.+%60settings%60+is+merged+field+by+field%3B+every+other+field+replaces+its+stored+value.\u0026amp;theme=afd979fb7c3ad63caebb415c\u0026amp;signature=4ecdd24ee469534ddf3ae78bdefcaa043d7264213859b7746e75873b8e43790f\">\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=\"Update a test - TesterArmy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a structured test definition. settings is merged field by field; every other field replaces its stored value.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tester-army.mintlify.app/_mintlify/api/og/v2?division=Tests\u0026amp;title=Update+a+test\u0026amp;description=Update+a+structured+test+definition.+%60settings%60+is+merged+field+by+field%3B+every+other+field+replaces+its+stored+value.\u0026amp;theme=afd979fb7c3ad63caebb415c\u0026amp;signature=4ecdd24ee469534ddf3ae78bdefcaa043d7264213859b7746e75873b8e43790f\">\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/tester-army/TtppYuy6BcVq96kt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TesterArmy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF8001\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tester.army/api-reference/tests/update-a-test\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tests/update-a-test.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tester.army/#organization\",\"name\":\"TesterArmy\",\"url\":\"https://docs.tester.army\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tester-army/cxPvc8T8okiKYoP3/logo/light.svg?fit=max\u0026auto=format\u0026n=cxPvc8T8okiKYoP3\u0026q=85\u0026s=d248c622a49091cb7ef1cb2868377b57\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tester.army#website\",\"name\":\"TesterArmy\",\"url\":\"https://docs.tester.army\",\"publisher\":{\"@id\":\"https://docs.tester.army/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tester.army/api-reference/tests/update-a-test#webpage\",\"url\":\"https://docs.tester.army/api-reference/tests/update-a-test\",\"name\":\"Update a test\",\"description\":\"Update a structured test definition. settings is merged field by field; every other field replaces its stored value.\",\"dateModified\":\"2026-10-07T09:29:00.517Z\",\"isPartOf\":{\"@id\":\"https://docs.tester.army#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tester.army/api-reference/tests/update-a-test#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tester.army/api-reference/tests/update-a-test#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.tester.army/api-reference/account/get-the-current-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tests\",\"item\":\"https://docs.tester.army/api-reference/tests/list-tests\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a test\",\"item\":\"https://docs.tester.army/api-reference/tests/update-a-test\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tester.army/api-reference/tests/update-a-test#apireference\",\"headline\":\"Update a test\",\"name\":\"Update a test\",\"description\":\"Update a structured test definition. settings is merged field by field; every other field replaces its stored value.\",\"url\":\"https://docs.tester.army/api-reference/tests/update-a-test\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tester.army/api-reference/tests/update-a-test#webpage\"},\"dateModified\":\"2026-10-07T09:29:00.517Z\",\"publisher\":{\"@id\":\"https://docs.tester.army/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tester.army#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TesterArmy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TesterArmy","nav":{"global":null,"tabs":[{"tab":"Docs","icon":{"style":"duotone","name":"house"},"pages":[{"title":"Docs","href":"/get-started"}]},{"tab":"API Reference","icon":{"style":"duotone","name":"code"},"groups":[{"group":"Overview","pages":[{"title":"API Overview","icon":"code","iconType":"duotone","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-user"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projects/get-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{projectId}","href":"/api-reference/projects/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/projects/{projectId}","href":"/api-reference/projects/update-a-project"},{"title":"Trigger a pull request exploration run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/pull-request-runs","href":"/api-reference/projects/trigger-a-pull-request-exploration-run"},{"title":"Trigger a discovery run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/discovery-runs","href":"/api-reference/projects/trigger-a-discovery-run"},{"title":"List project environments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/environments","href":"/api-reference/projects/list-project-environments"},{"title":"Create a project environment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/environments","href":"/api-reference/projects/create-a-project-environment"},{"title":"Delete a project environment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{projectId}/environments/{environmentId}","href":"/api-reference/projects/delete-a-project-environment"},{"title":"List project credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/credentials","href":"/api-reference/projects/list-project-credentials"},{"title":"Create a project credential","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/credentials","href":"/api-reference/projects/create-a-project-credential"},{"title":"List project memories","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/memories","href":"/api-reference/projects/list-project-memories"},{"title":"Create a project memory","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/memories","href":"/api-reference/projects/create-a-project-memory"},{"title":"List project issues","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/issues","href":"/api-reference/projects/list-project-issues"},{"title":"Get a project issue","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/issues/{issueId}","href":"/api-reference/projects/get-a-project-issue"},{"title":"Delete a project memory","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{projectId}/memories/{memoryId}","href":"/api-reference/projects/delete-a-project-memory"},{"title":"List project files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/files","href":"/api-reference/projects/list-project-files"},{"title":"Confirm a project file upload","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{projectId}/files","href":"/api-reference/projects/confirm-a-project-file-upload"},{"title":"Initiate a project file upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/files","href":"/api-reference/projects/initiate-a-project-file-upload"},{"title":"List project mobile apps","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{projectId}/mobile","href":"/api-reference/projects/list-project-mobile-apps"},{"title":"Upload a project mobile app","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/mobile","href":"/api-reference/projects/upload-a-project-mobile-app"},{"title":"Delete a project mobile app","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{projectId}/mobile/{appId}","href":"/api-reference/projects/delete-a-project-mobile-app"},{"title":"Initiate a project mobile app upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/mobile/upload","href":"/api-reference/projects/initiate-a-project-mobile-app-upload"},{"title":"Confirm a project mobile app upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{projectId}/mobile/upload/confirm","href":"/api-reference/projects/confirm-a-project-mobile-app-upload"}]},{"group":"Tests","pages":[{"title":"List tests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tests","href":"/api-reference/tests/list-tests"},{"title":"Create a test","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tests","href":"/api-reference/tests/create-a-test"},{"title":"Get a test","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tests/{testId}","href":"/api-reference/tests/get-a-test"},{"title":"Delete a test","description":"Delete a structured test definition.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/tests/{testId}","href":"/api-reference/tests/delete-a-test"},{"title":"Update a test","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/tests/{testId}","href":"/api-reference/tests/update-a-test"},{"title":"Trigger a test run","description":"Trigger a saved dashboard test remotely using API-key authentication. Returns the queued run ID.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tests/{testId}/runs","href":"/api-reference/tests/trigger-a-test-run"}]},{"group":"Groups","pages":[{"title":"List test groups","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/groups","href":"/api-reference/groups/list-test-groups"},{"title":"Create a test group","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/groups","href":"/api-reference/groups/create-a-test-group"},{"title":"Get a test group","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/groups/{groupId}","href":"/api-reference/groups/get-a-test-group"},{"title":"Delete a test group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/groups/{groupId}","href":"/api-reference/groups/delete-a-test-group"},{"title":"Update a test group","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/groups/{groupId}","href":"/api-reference/groups/update-a-test-group"},{"title":"Add a test to a group","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/groups/{groupId}/tests","href":"/api-reference/groups/add-a-test-to-a-group"},{"title":"Remove a test from a group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/groups/{groupId}/tests/{testId}","href":"/api-reference/groups/remove-a-test-from-a-group"},{"title":"Trigger a test group run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/groups/{groupId}/runs","href":"/api-reference/groups/trigger-a-test-group-run"},{"title":"Get a group's schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/groups/{groupId}/schedule","href":"/api-reference/groups/get-a-groups-schedule"},{"title":"Create or replace a group's schedule","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/groups/{groupId}/schedule","href":"/api-reference/groups/create-or-replace-a-groups-schedule"},{"title":"Delete a group's schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/groups/{groupId}/schedule","href":"/api-reference/groups/delete-a-groups-schedule"}]},{"group":"Webhooks","pages":[{"title":"Trigger a project webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook/{webhookId}/{secret}","href":"/api-reference/webhooks/trigger-a-project-webhook"},{"title":"Trigger a group webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/groups/webhook/{webhookId}/{secret}","href":"/api-reference/webhooks/trigger-a-group-webhook"}]},{"group":"Test Runs","pages":[{"title":"List test runs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs","href":"/api-reference/test-runs/list-test-runs"},{"title":"Get test run status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{id}","href":"/api-reference/test-runs/get-test-run-status"},{"title":"Get run agent transcript","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{id}/messages","href":"/api-reference/test-runs/get-run-agent-transcript"},{"title":"Get run console and network logs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{id}/telemetry","href":"/api-reference/test-runs/get-run-console-and-network-logs"},{"title":"Get run screen recording","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{id}/recording","href":"/api-reference/test-runs/get-run-screen-recording"},{"title":"Get a run recording download URL","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{id}/recording/download-url","href":"/api-reference/test-runs/get-a-run-recording-download-url"},{"title":"Cancel a queued or running run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/runs/{id}/cancel","href":"/api-reference/test-runs/cancel-a-queued-or-running-run"},{"title":"Get batch status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/batches/{batchId}","href":"/api-reference/test-runs/get-batch-status"},{"title":"Get batch JUnit XML report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/batches/{batchId}/junit","href":"/api-reference/test-runs/get-batch-junit-xml-report"},{"title":"Get run JUnit XML report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{id}/junit","href":"/api-reference/test-runs/get-run-junit-xml-report"},{"title":"Cancel a queued or running batch","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/batches/{batchId}/cancel","href":"/api-reference/test-runs/cancel-a-queued-or-running-batch"},{"title":"Re-run a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/batches/{batchId}/rerun","href":"/api-reference/test-runs/re-run-a-batch"}]},{"group":"Feedback","pages":[{"title":"Submit product feedback","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/feedback","href":"/api-reference/feedback/submit-product-feedback"}]}]}]}]},"title":"Update a test - TesterArmy","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}