Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.
IDs of the teams that may see this instance. On start, list order is kept, and the field is accepted only when the workflow allows or requires a team selection; omit it to use the workflow's default audience. On update, sending this field sets the audience to exactly these teams and requires permission to manage instance visibility. Teams that were already selected stay in their current order; newly added teams are appended in the order given. Omit the field to leave the teams unchanged. An empty list clears the teams, except for restrictive instances, which must keep at least one.
A snapshot of the workflow structure.
If you set "inject_values" query parameter to "true", this will return the input values of the form fields.,
If you set "steps_time_frame" query parameter to "true", this will return the completion values of the form fields.
Who can see this instance. Set from the workflow when the instance starts and cannot be changed. One of public, involved, involved_plus, or restrictive.
IDs of the teams that may see this instance. On start, list order is kept, and the field is accepted only when the workflow allows or requires a team selection; omit it to use the workflow's default audience. On update, sending this field sets the audience to exactly these teams and requires permission to manage instance visibility. Teams that were already selected stay in their current order; newly added teams are appended in the order given. Omit the field to leave the teams unchanged. An empty list clears the teams, except for restrictive instances, which must keep at least one.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Welcome to Next Matter","colors":{"primary":"#2563EB","light":"#7BB4FF","dark":"#1B6ED5"},"logo":{"light":"https://mintcdn.com/nextmatter/Z3-w3RiDibcpWWcE/images/Logo_light.png?fit=max\u0026auto=format\u0026n=Z3-w3RiDibcpWWcE\u0026q=85\u0026s=137252a032983d8c466728fb8942866b","dark":"https://mintcdn.com/nextmatter/Z3-w3RiDibcpWWcE/images/Logo_dark.png?fit=max\u0026auto=format\u0026n=Z3-w3RiDibcpWWcE\u0026q=85\u0026s=c73af117d9c32a2ba175e2ca0f1901f1"},"favicon":"https://mintcdn.com/nextmatter/Z3-w3RiDibcpWWcE/ac63b08-small-NextMatter_favicon_32_blue2x.png?fit=max\u0026auto=format\u0026n=Z3-w3RiDibcpWWcE\u0026q=85\u0026s=f3d74120cd4172ddb1aa92b534e1c69b","background":{"color":{"light":"#F7F8F8","dark":"#0B1428"}},"navbar":{"links":[{"href":"https://www.nextmatter.com/try-next-matter","label":"Contact us"},{"href":"https://status.nextmatter.com/","label":"Status"}],"primary":{"type":"button","label":"Sign in","href":"https://app.nextmatter.com"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@nextmatter","linkedin":"https://www.linkedin.com/company/nextmatter/posts?feedView=all"}},"fonts":{"family":"Inter Tight"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"ga4":{"measurementId":"G-N5P3F12LJ7"},"gtm":{"tagId":"GTM-K4FMSC9"}},"navigation":{"global":{"anchors":[{"anchor":"Product updates","icon":"gift","href":"https://nextmatter.mintlify.app/changelog/changelog"},{"anchor":"Videos","icon":"video","href":"https://www.youtube.com/playlist?list=PLfgqOsRV3ZEXN2pII9HHQlTHwllZ9uj8r"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nextmatter","hasAudioNarration":false,"actualSubdomain":"nextmatter","customDomains":["help.nextmatter.com"],"gitSource":{"type":"gitlab","owner":"nextmatter/help-centre","repo":"documentation","projectId":68524865,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad210a585b9446e96abcc0f","collectionId":"79b21115-5f8a-44c7-97d1-417ced1eee43","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad210a585b9446e96abcc0f"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad210ab636983af6beeb61e","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Integrations","count":75},{"language":"default","tag":"Custom integrations","count":41},{"language":"default","tag":"Components","count":39},{"language":"default","tag":"Get started","count":38},{"language":"default","tag":"No-code","count":28},{"language":"default","tag":"No-code operations","count":18},{"language":"default","tag":"APIs","count":16},{"language":"default","tag":"Endpoints","count":15},{"language":"default","tag":"Forms and form fields","count":12},{"language":"default","tag":"Manage workspace","count":11}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@nextmatter.com","showHelpButton":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":"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":"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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":"@keyframes nm-hero-float{0%,to{transform:translate(0,0) rotate(0deg) scale(1)}25%{transform:translate(-10px,-20px) rotate(2deg) scale(1.05)}50%{transform:translate(10px,-10px) rotate(-1deg) scale(.95)}75%{transform:translate(-5px,15px) rotate(1deg) scale(1.02)}}:root{--font-h3:2rem;--font-h4:1.625rem;--font-h5:1.25rem;--font-h6:1.125rem;--font-body:0.9375rem;--blue-100:#0A1024;--grey-100:#273441;--grey-75:#5D6771;--grey-03:#F7F8F8;--blue-20:#D1DDF6;--blue-15:#DDE6F8;--blue-05:#F4F7FD}.h-7{height:1.9rem;margin-left:-35px}div.text-sm.max-w-\\[160px\\]{font-size:.75rem;line-height:1.25rem;font-weight:500;font-family:'Inter'}@media (max-width:1023px){#search-bar-entry-mobile{margin-right:40px}#assistant-entry-mobile{margin-right:20px}}.asw-menu-btn{position:fixed!important;z-index:9999!important;right:25px!important;left:auto!important;bottom:100px!important;width:38px!important;height:38px!important}html:not(.dark) .text-gray-400{color:#000}html:not(.dark) .text-gray-500{color:#595959}html:not(.dark) .text-gray-600{color:#3a3c3e}html:not(.dark) .text-gray-900{color:#2c2c2c}.dark\\:text-gray-200:is(.dark *),.dark\\:text-gray-300:is(.dark *),.dark\\:text-gray-400:is(.dark *),.dark\\:text-gray-500:is(.dark *),.dark\\:text-gray-600:is(.dark *){color:#fff}.dark .sidebar-group-header,.dark .sidebar-title{color:#fff!important}.dark .sidebar-nav-group-divider{background-color:rgba(255,255,255,.15)!important}.dark #search-bar-entry,.dark #search-bar-entry span{color:rgba(255,255,255,.85)!important}.dark #search-input,.dark #search-input::placeholder{color:#fff!important}.dark #search-input::placeholder{opacity:.75}.dark #assistant-entry,.dark #assistant-entry span{color:#fff!important}.dark #navbar .border-b,.dark #navbar-transition{border-color:rgba(255,255,255,.15)!important}.dark .nav-tabs-item:hover>div{background-color:rgba(255,255,255,.25)!important}.dark\\:text-white\\/40:is(.dark *),.dark\\:text-white\\/50:is(.dark *),.dark\\:text-white\\/60:is(.dark *){color:rgba(255,255,255,.85)!important}.dark\\:hover\\:text-gray-300:is(.dark *):hover{color:#fff!important}.dark #ask-assistant-code-block-button,.dark #ask-assistant-code-block-button svg{color:rgba(255,255,255,.85)!important}.dark\\:prose-invert:is(.dark *){--tw-prose-body:#ffffff;--tw-prose-headings:#ffffff;--tw-prose-lead:#ffffff;--tw-prose-links:#93c5fd}.text-emerald-600,.text-emerald-900{--tw-text-opacity:1;color:rgb(5 70 49/var(--tw-text-opacity))}.bg-gray-400{background-color:#4d4e52}.dark\\:bg-gray-500:is(.dark *){background-color:#d8dadf}.text-zinc-400{--tw-text-opacity:1;color:#4d4e52}.dark\\:text-zinc-300:is(.dark *){--tw-text-opacity:1;color:#d8dadf}.dark .prose :where(p){color:#fff}.dark .prose :where(code):not(:where([class~=\"not-prose\"] *)){background-color:rgba(55,65,81,.8)!important;color:#f3f4f6!important;border:1px solid rgba(75,85,101,.6)!important;border-radius:.375rem!important;padding:.125rem .25rem!important;font-weight:500!important}.dark .prose :where(pre):not(:where([class~=\"not-prose\"] *)){background-color:rgba(31,41,55,.95)!important;border:1px solid rgba(75,85,101,.8)!important;border-radius:.5rem!important;color:#f9fafb!important}.dark .prose :where(pre code):not(:where([class~=\"not-prose\"] *)){background-color:transparent!important;border:0!important;color:#f9fafb!important;padding:0!important}.dark button svg.lucide-moon,.dark svg.lucide-moon{color:#fbbf24!important;fill:transparent!important;stroke:#fbbf24!important;opacity:1!important}.dark button:hover svg.lucide-moon{color:#f59e0b!important;stroke:#f59e0b!important}.dark button:not([aria-pressed=true]) svg.lucide-moon,.dark button[aria-pressed=false] svg.lucide-moon{color:#e5e7eb!important;stroke:#e5e7eb!important;stroke-width:2!important;opacity:1!important}.dark button:not([aria-pressed=true]):hover svg.lucide-moon,.dark button[aria-pressed=false]:hover svg.lucide-moon{color:#fff!important;stroke:#fff!important;stroke-width:2.5!important}.dark .prose :where(ol > li)::marker,.dark .prose :where(ul > li)::marker{color:#fff!important;font-weight:700!important}.dark .prose :where(ul > li)::marker{font-size:1.1em!important}.dark .prose :where(li),.dark .prose :where(ol),.dark .prose :where(ul){color:#fff!important}.dark .prose ol li::before,.dark .prose ul li::before{color:#fff!important;font-weight:700!important}.dark .prose ul li::marker,.dark .prose ul>li::marker,.dark li::marker,.dark ul li::marker{color:#fff!important}.dark .prose :where(ul > li):not(:where([class~=\"not-prose\"] *))::marker{color:#fff!important}.dark .prose :where(strong):is(.dark *){color:#fff!important;font-weight:700!important;text-shadow:0 0 1px rgba(255,255,255,.5)!important}.dark\\:text-primary-light:is(.dark *){color:#93c5fd!important}.dark .text-primary-light{color:#93c5fd!important}.dark [class*=text-primary]:not([class*=text-primary-light]){color:#60a5fa!important}.dark .prose :where(a):not(:where([class~=\"not-prose\"] *)){border-bottom:1px solid #60a5fa!important;padding-bottom:1px!important;color:#60a5fa!important;text-decoration:none!important;font-weight:500!important}.dark .prose :where(a):hover:not(:where([class~=\"not-prose\"] *)){border-bottom-color:#93c5fd!important;color:#93c5fd!important;text-decoration:none!important}.dark .prose :where(h1, h2, h3, h4, h5, h6):not(:where([class~=\"not-prose\"] *)){color:#f9fafb!important}.dark #content-area h1,.dark #content-area h2,.dark #content-area h3,.dark #content-area h4,.dark #content-area h5,.dark #content-area h6{color:#f9fafb!important}.nextmatter-welcome{font-family:-apple-system,BlinkMacSystemFont,'Segoe UI','Roboto',sans-serif;line-height:1.6;color:#1f2937;background:0 0;min-height:100vh;transition:color .3s ease;isolation:isolate}.nextmatter-welcome *{box-sizing:border-box}.dark .nextmatter-welcome,.dark .nextmatter-welcome .nm-action-content h3{color:#f3f4f6}.nextmatter-welcome .nm-container{max-width:1200px;margin:0 auto;padding:0 1rem;position:relative;z-index:1}.nextmatter-welcome .nm-hero-section{text-align:center;padding:3rem 2rem;background:rgba(255,255,255,.7);backdrop-filter:blur(10px);border:1px solid rgba(255,255,255,.2);border-radius:24px;margin:2rem 0;position:relative;overflow:hidden;min-height:300px;display:flex;flex-direction:column;justify-content:center;align-items:center;box-shadow:0 8px 32px rgba(0,0,0,.1);transition:all .3s ease}.dark .nextmatter-welcome .nm-hero-section{background:rgba(15,23,42,.6);border:1px solid rgba(148,163,184,.1);box-shadow:0 8px 32px rgba(0,0,0,.3)}.nextmatter-welcome .nm-hero-section::before{content:'';position:absolute;top:-100px;right:-100px;width:400px;height:320px;background:linear-gradient(135deg,#4f46e5 0,#7c3aed 50%,#2563eb 100%);border-radius:50% 40% 60% 30%;opacity:.15;filter:blur(60px);animation:nm-hero-float 8s ease-in-out infinite;z-index:1}.nextmatter-welcome .nm-hero-section::after{content:'';position:absolute;bottom:-80px;left:-80px;width:300px;height:240px;background:linear-gradient(45deg,#06b6d4 0,#3b82f6 50%,#8b5cf6 100%);border-radius:60% 30% 50% 40%;opacity:.12;filter:blur(50px);animation:nm-hero-float 10s ease-in-out infinite reverse;z-index:1}.nextmatter-welcome .nm-hero-content{position:relative;z-index:2}.dark .nextmatter-welcome .nm-hero-title,.nextmatter-welcome .nm-hero-title{-webkit-background-clip:text;-webkit-text-fill-color:transparent;background-clip:text}.nextmatter-welcome .nm-hero-title{font-size:2.5rem;font-weight:800;color:#0f172a;margin-bottom:1.5rem;background:linear-gradient(135deg,#1e293b 0,#4338ca 100%)}.dark .nextmatter-welcome .nm-hero-title{background:linear-gradient(135deg,#f1f5f9 0,#a78bfa 100%)}.nextmatter-welcome .nm-hero-description{font-size:1.2rem;color:#475569;max-width:650px;margin:0 auto;line-height:1.7;font-weight:500}.dark .nextmatter-welcome .nm-hero-description{color:#cbd5e1}.nextmatter-welcome .nm-section-header{text-align:center;margin:4rem 0 2.5rem}.nextmatter-welcome .nm-section-title{font-size:1.75rem;font-weight:700;color:#111827;margin-bottom:.75rem}.dark .nextmatter-welcome .nm-feature-card h3,.dark .nextmatter-welcome .nm-section-title{color:#f9fafb}.nextmatter-welcome .nm-section-subtitle{font-size:1.1rem;color:#6b7280;max-width:650px;margin:0 auto}.dark .nextmatter-welcome .nm-action-content p,.dark .nextmatter-welcome .nm-feature-card p,.dark .nextmatter-welcome .nm-section-subtitle{color:#9ca3af}.nextmatter-welcome .nm-role-cards-container{display:grid;grid-template-columns:repeat(auto-fit,minmax(300px,1fr));gap:1.75rem;margin:2.5rem 0 4rem}.nextmatter-welcome .nm-role-card{background:linear-gradient(135deg,#667eea 0,#764ba2 100%);border:0;color:#fff;padding:1.5rem 2rem 2rem;border-radius:16px;transition:all .4s ease;position:relative;overflow:hidden;display:block;box-shadow:0 4px 20px rgba(102,126,234,.3)}.dark .nextmatter-welcome .nm-role-card{background:linear-gradient(135deg,#4338ca 0,#7c3aed 100%);box-shadow:0 4px 20px rgba(67,56,202,.4)}.nextmatter-welcome .nm-quick-action-card::before,.nextmatter-welcome .nm-role-card::before{content:'';position:absolute;top:0;left:0;right:0;bottom:0;opacity:0;transition:opacity .4s ease;pointer-events:none}.nextmatter-welcome .nm-role-card::before{background:linear-gradient(135deg,rgba(255,255,255,.15) 0,rgba(255,255,255,.05) 100%)}.nextmatter-welcome .nm-quick-action-card:hover::before,.nextmatter-welcome .nm-role-card:hover::before{opacity:1}.nextmatter-welcome .nm-role-card:hover{transform:translateY(-8px) scale(1.02);box-shadow:0 16px 50px rgba(102,126,234,.4)}.dark .nextmatter-welcome .nm-role-card:hover{box-shadow:0 16px 50px rgba(67,56,202,.5)}.nextmatter-welcome .nm-role-link{color:rgba(255,255,255,.9);text-decoration:none;transition:all .3s ease;border-bottom:1px solid transparent}.nextmatter-welcome .nm-role-link:hover{color:#fff;border-bottom:1px solid rgba(255,255,255,.5);text-shadow:0 0 8px rgba(255,255,255,.3)}.nextmatter-welcome .nm-role-card h3 Icon{font-weight:600!important}.nextmatter-welcome .nm-action-icon Icon,.nextmatter-welcome .nm-feature-icon Icon,.nextmatter-welcome .nm-role-card h3 Icon{color:#fff!important;opacity:1!important;filter:drop-shadow(0 1px 2px rgba(0,0,0,.1))!important}.nextmatter-welcome .nm-role-card h3{color:#fff;font-size:1.25rem;font-weight:700;margin-top:1rem;display:flex;align-items:center;gap:.75rem;position:relative;z-index:2}.nextmatter-welcome .nm-role-card p{color:rgba(255,255,255,.9);font-size:.95rem;line-height:1.8;margin:0;position:relative;z-index:2}.nextmatter-welcome .nm-quick-actions-section{background:rgba(255,255,255,.5);backdrop-filter:blur(10px);border:1px solid rgba(255,255,255,.2);border-radius:24px;padding:3.5rem 2rem;margin:4rem 0;position:relative;overflow:hidden;box-shadow:0 8px 32px rgba(0,0,0,.08)}.dark .nextmatter-welcome .nm-quick-actions-section{background:rgba(15,23,42,.4);border:1px solid rgba(148,163,184,.1);box-shadow:0 8px 32px rgba(0,0,0,.2)}.nextmatter-welcome .nm-quick-actions-grid{display:grid;grid-template-columns:repeat(2,1fr);gap:1.25rem;position:relative;z-index:2}.nextmatter-welcome .nm-quick-action-card{background:rgba(255,255,255,.9);backdrop-filter:blur(10px);border:1px solid rgba(255,255,255,.3);border-radius:16px;padding:1.25rem;transition:all .4s ease;position:relative;overflow:hidden;display:flex;align-items:center;gap:1rem;text-decoration:none;color:inherit;cursor:pointer;box-shadow:0 4px 16px rgba(0,0,0,.06)}.dark .nextmatter-welcome .nm-quick-action-card{background:rgba(30,41,59,.7);border:1px solid rgba(148,163,184,.1);box-shadow:0 4px 16px rgba(0,0,0,.2)}.nextmatter-welcome .nm-quick-action-card::before{background:linear-gradient(135deg,rgba(102,126,234,.05) 0,rgba(118,75,162,.05) 100%)}.nextmatter-welcome .nm-quick-action-card:hover{transform:translateY(-6px);box-shadow:0 12px 40px rgba(0,0,0,.15);border-color:#8b5cf6}.dark .nextmatter-welcome .nm-quick-action-card:hover{box-shadow:0 12px 40px rgba(0,0,0,.3);border-color:#a78bfa}.nextmatter-welcome .nm-action-icon{width:48px;height:48px;background:linear-gradient(135deg,#667eea 0,#764ba2 100%);border-radius:12px;display:flex;align-items:center;justify-content:center;font-size:1.25rem;color:#fff;box-shadow:0 4px 16px rgba(102,126,234,.3);transition:transform .3s ease;flex-shrink:0}.dark .nextmatter-welcome .nm-action-icon{background:linear-gradient(135deg,#4338ca 0,#7c3aed 100%);box-shadow:0 4px 16px rgba(67,56,202,.4)}.nextmatter-welcome .nm-quick-action-card:hover .nm-action-icon{transform:scale(1.1) rotate(5deg)}.nextmatter-welcome .nm-action-content{flex:1;position:relative;z-index:2}.nextmatter-welcome .nm-action-content h3{font-size:1.1rem;font-weight:700;color:#1f2937;margin-bottom:.25rem;transition:color .3s ease}.nextmatter-welcome .nm-quick-action-card:hover .nm-action-content h3{color:#8b5cf6}.dark .nextmatter-welcome .nm-quick-action-card:hover .nm-action-arrow,.dark .nextmatter-welcome .nm-quick-action-card:hover .nm-action-content h3{color:#a78bfa}.nextmatter-welcome .nm-action-content p{font-size:.875rem;color:#6b7280;margin:0;line-height:1.4}.nextmatter-welcome .nm-action-arrow{font-size:1.25rem;color:#9ca3af;font-weight:700;transition:all .4s ease;position:relative;z-index:2;flex-shrink:0}.dark .nextmatter-welcome .nm-action-arrow{color:#6b7280}.nextmatter-welcome .nm-quick-action-card:hover .nm-action-arrow{transform:translateX(8px);color:#8b5cf6}.nextmatter-welcome .nm-features-grid{display:grid;grid-template-columns:repeat(auto-fit,minmax(320px,1fr));gap:2rem;margin:2.5rem 0 4rem}.nextmatter-welcome .nm-feature-card{background:rgba(255,255,255,.8);backdrop-filter:blur(10px);border:1px solid rgba(255,255,255,.3);border-radius:18px;padding:2rem;transition:all .4s ease;text-decoration:none;color:inherit;cursor:pointer;box-shadow:0 4px 16px rgba(0,0,0,.06)}.dark .nextmatter-welcome .nm-feature-card{background:rgba(30,41,59,.6);border:1px solid rgba(148,163,184,.1);box-shadow:0 4px 16px rgba(0,0,0,.2)}.nextmatter-welcome .nm-feature-card:hover{transform:translateY(-8px);box-shadow:0 16px 50px rgba(0,0,0,.12);border-color:#8b5cf6}.dark .nextmatter-welcome .nm-feature-card:hover{box-shadow:0 16px 50px rgba(0,0,0,.3);border-color:#a78bfa}.nextmatter-welcome .nm-feature-icon{width:56px;height:56px;background:linear-gradient(135deg,#4338ca 0,#6366f1 100%);border-radius:12px;display:flex;align-items:center;justify-content:center;margin-bottom:1.5rem;font-size:1.5rem;color:#fff;box-shadow:0 6px 20px rgba(67,56,202,.3);transition:transform .3s ease}.dark .nextmatter-welcome .nm-feature-icon{background:linear-gradient(135deg,#5b21b6 0,#7c3aed 100%);box-shadow:0 6px 20px rgba(91,33,182,.4)}.nextmatter-welcome .nm-feature-card:hover .nm-feature-icon{transform:scale(1.1)}.nextmatter-welcome .nm-feature-card h3{font-size:1.3rem;font-weight:700;color:#111827;margin-bottom:1rem}.nextmatter-welcome .nm-feature-card p{font-size:1rem;color:#6b7280;margin:0;line-height:1.6}@media (max-width:768px){.nextmatter-welcome .nm-hero-title{font-size:2rem}.nextmatter-welcome .nm-hero-description{font-size:1.1rem}.nextmatter-welcome .nm-hero-section{min-height:260px;margin:1rem 0}.nextmatter-welcome .nm-section-header{margin:3rem 0 2rem}.nextmatter-welcome .nm-section-title{font-size:1.5rem}.nextmatter-welcome .nm-quick-actions-grid{grid-template-columns:1fr}.nextmatter-welcome .nm-quick-action-card{padding:1.25rem;gap:1rem}.nextmatter-welcome .nm-action-icon{width:48px;height:48px;font-size:1.25rem}.nextmatter-welcome .nm-features-grid,.nextmatter-welcome .nm-role-cards-container{grid-template-columns:1fr;gap:1.5rem}.nextmatter-welcome .nm-hero-section,.nextmatter-welcome .nm-quick-actions-section{padding:2rem 1.5rem}}"}],"page":{"pagePath":"reference/instance/update-instance","slug":"/reference/instance/update-instance","pageMetadata":{"title":"Update instance","description":"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.","deprecated":null,"version":null,"openapi":"/reference/openapi.json put /instances/{id}/","href":"/reference/instance/update-instance","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: \"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.\"\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":"Update instance","description":"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.","deprecated":null,"version":null,"openapi":"/reference/openapi.json put /instances/{id}/","href":"/reference/instance/update-instance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/nextmatter/682c500d26b07884/verification.js","/_mintlify/custom/nextmatter/f9bed9cd3480bd56/datadog.js","/_mintlify/custom/nextmatter/c0b0e244cf78652b/docs/redirects.js"],"openApiReferenceData":{"operation":{"operationId":"instances_update","description":"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.","summary":"Update instance","parameters":["1b9c61ee-7ca2-48fa-8115-cde0b9be75ea"],"tags":["Instance"],"requestBody":"1e1c7271-ce76-43fc-8898-76c2e3c171f1","security":["5b1bbe5e-dbd1-4fac-8239-bcd8e2c1a771"],"responses":{"200":"a50c8350-14a8-48c5-98c3-b0270d9da2e8"},"method":"put","type":"path","servers":["f9b25e41-c589-43d6-910a-c6c22930270e"],"path":"/instances/{id}/","baseUrlOptions":["https://core.nextmatter.com/api/"],"title":"Update instance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1b9c61ee-7ca2-48fa-8115-cde0b9be75ea":{"in":"path","name":"id","schema":{"type":"string","pattern":"^\\d+$","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"deadline":{"oneOf":[{"type":"string","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.1","typeLabel":"null"}],"uniqueKey":"deadline","typeLabel":"string\u003cdate-time> | null"},"priority":{"oneOf":[{"type":"string","description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":["V","H"],"uniqueKey":"priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":[null],"uniqueKey":"priority.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"priority.oneOf.2","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"enum\u003cstring> | any | null"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"A list of string tags seperated by a comma","uniqueKey":"tags","typeLabel":"string[]"},"visibility_teams":{"type":"array","items":{"type":"integer","uniqueKey":"visibility_teams.items.[INDEX]","typeLabel":"integer"},"description":"IDs of the teams that may see this instance. On start, list order is kept, and the field is accepted only when the workflow allows or requires a team selection; omit it to use the workflow's default audience. On update, sending this field sets the audience to exactly these teams and requires permission to manage instance visibility. Teams that were already selected stay in their current order; newly added teams are appended in the order given. Omit the field to leave the teams unchanged. An empty list clears the teams, except for restrictive instances, which must keep at least one.","uniqueKey":"visibility_teams","typeLabel":"integer[]"}},"required":["aborted_time","active_step_ids","completed_time","id","last_updated_time","process","process_snapshot","public_url","stage","started_time","step_assignments","step_deadlines","url","visibility_mode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"","deadline":"2023-11-07T05:31:56Z","tags":[],"visibility_teams":[123]}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"deadline":{"oneOf":[{"type":"string","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.1","typeLabel":"null"}],"uniqueKey":"deadline","typeLabel":"string\u003cdate-time> | null"},"priority":{"oneOf":[{"type":"string","description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":["V","H"],"uniqueKey":"priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":[null],"uniqueKey":"priority.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"priority.oneOf.2","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"enum\u003cstring> | any | null"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"A list of string tags seperated by a comma","uniqueKey":"tags","typeLabel":"string[]"},"visibility_teams":{"type":"array","items":{"type":"integer","uniqueKey":"visibility_teams.items.[INDEX]","typeLabel":"integer"},"description":"IDs of the teams that may see this instance. On start, list order is kept, and the field is accepted only when the workflow allows or requires a team selection; omit it to use the workflow's default audience. On update, sending this field sets the audience to exactly these teams and requires permission to manage instance visibility. Teams that were already selected stay in their current order; newly added teams are appended in the order given. Omit the field to leave the teams unchanged. An empty list clears the teams, except for restrictive instances, which must keep at least one.","uniqueKey":"visibility_teams","typeLabel":"integer[]"}},"required":["aborted_time","active_step_ids","completed_time","id","last_updated_time","process","process_snapshot","public_url","stage","started_time","step_assignments","step_deadlines","url","visibility_mode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"","deadline":"2023-11-07T05:31:56Z","tags":[],"visibility_teams":[123]}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"deadline":{"oneOf":[{"type":"string","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.1","typeLabel":"null"}],"uniqueKey":"deadline","typeLabel":"string\u003cdate-time> | null"},"priority":{"oneOf":[{"type":"string","description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":["V","H"],"uniqueKey":"priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":[null],"uniqueKey":"priority.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"priority.oneOf.2","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"enum\u003cstring> | any | null"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"A list of string tags seperated by a comma","uniqueKey":"tags","typeLabel":"string[]"},"visibility_teams":{"type":"array","items":{"type":"integer","uniqueKey":"visibility_teams.items.[INDEX]","typeLabel":"integer"},"description":"IDs of the teams that may see this instance. On start, list order is kept, and the field is accepted only when the workflow allows or requires a team selection; omit it to use the workflow's default audience. On update, sending this field sets the audience to exactly these teams and requires permission to manage instance visibility. Teams that were already selected stay in their current order; newly added teams are appended in the order given. Omit the field to leave the teams unchanged. An empty list clears the teams, except for restrictive instances, which must keep at least one.","uniqueKey":"visibility_teams","typeLabel":"integer[]"}},"required":["aborted_time","active_step_ids","completed_time","id","last_updated_time","process","process_snapshot","public_url","stage","started_time","step_assignments","step_deadlines","url","visibility_mode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"","deadline":"2023-11-07T05:31:56Z","tags":[],"visibility_teams":[123]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a50c8350-14a8-48c5-98c3-b0270d9da2e8":{"content":{"application/json; version=v1":{"schema":{"type":"object","properties":{"process":{"type":"string","format":"uri","readOnly":true,"description":"The related workflow resource URI","isRequired":true,"uniqueKey":"process","typeLabel":"string\u003curi>"},"step_assignments":{"type":"array","items":{"type":"object","properties":{"step_id":{"type":"integer","description":"The assigned step's ID. You can find the step id in the workflow editor\n by accessing the step and inspecting the URL","isRequired":true,"uniqueKey":"step_assignments.items.[INDEX].step_id","typeLabel":"integer"},"user_id":{"type":"integer","description":"The ID of the user assigned as the step's lead. If you dont know the user ID, get in touch with our Next Matter support team","isRequired":true,"uniqueKey":"step_assignments.items.[INDEX].user_id","typeLabel":"integer"}},"required":["step_id","user_id"],"uniqueKey":"step_assignments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"A list of user assignments per step","isRequired":true,"uniqueKey":"step_assignments","typeLabel":"object[]"},"url":{"type":"string","format":"uri","readOnly":true,"description":"The instance resource URI. For example https://core.nextmatter.com/api/instances/[instance_id]/.","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"id":{"type":"integer","readOnly":true,"isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"started_time":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"started_time","typeLabel":"string\u003cdate-time>"},"completed_time":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"completed_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"completed_time.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completed_time","typeLabel":"string\u003cdate-time> | null"},"aborted_time":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"aborted_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"aborted_time.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"aborted_time","typeLabel":"string\u003cdate-time> | null"},"last_updated_time":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"last_updated_time","typeLabel":"string\u003cdate-time>"},"process_snapshot":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"process_snapshot.additionalProperties","typeLabel":"any"},"readOnly":true,"description":"A snapshot of the workflow structure.\n If you set \"inject_values\" query parameter to \"true\", this will return the input values of the form fields.,\n If you set \"steps_time_frame\" query parameter to \"true\", this will return the completion values of the form fields.","isRequired":true,"uniqueKey":"process_snapshot","typeLabel":"object"},"active_step_ids":{"type":"array","items":{"type":"integer","uniqueKey":"active_step_ids.items.[INDEX]","typeLabel":"integer"},"readOnly":true,"description":"List of active step IDs of the instance","isRequired":true,"uniqueKey":"active_step_ids","typeLabel":"integer[]"},"step_deadlines":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"step_deadlines.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"step_deadlines.items.[INDEX]","typeLabel":"object"},"description":"List of instance step deadlines","readOnly":true,"isRequired":true,"uniqueKey":"step_deadlines","typeLabel":"object[]"},"public_url":{"type":"string","readOnly":true,"description":"The public URL of the instance (for status tracking), if enabled in the workflow settings","isRequired":true,"uniqueKey":"public_url","typeLabel":"string"},"stage":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"stage","typeLabel":"string"},"visibility_mode":{"type":"string","readOnly":true,"description":"Who can see this instance. Set from the workflow when the instance starts and cannot be changed. One of public, involved, involved_plus, or restrictive.","isRequired":true,"uniqueKey":"visibility_mode","typeLabel":"string"},"name":{"oneOf":[{"type":"string","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","default":"","description":"The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.","maxLength":255,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"deadline":{"oneOf":[{"type":"string","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time by which the instance should be completed","uniqueKey":"deadline.oneOf.1","typeLabel":"null"}],"uniqueKey":"deadline","typeLabel":"string\u003cdate-time> | null"},"priority":{"oneOf":[{"type":"string","description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":["V","H"],"uniqueKey":"priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The priority of the instance. If you don't send this parameter, the priority will be \"Regular\". Other options are V - \"Very High\" and H - \"High\".\n\n* `V` - Very high\n* `H` - High","enum":[null],"uniqueKey":"priority.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"priority.oneOf.2","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"enum\u003cstring> | any | null"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"default":[],"description":"A list of string tags seperated by a comma","uniqueKey":"tags","typeLabel":"string[]"},"visibility_teams":{"type":"array","items":{"type":"integer","uniqueKey":"visibility_teams.items.[INDEX]","typeLabel":"integer"},"description":"IDs of the teams that may see this instance. On start, list order is kept, and the field is accepted only when the workflow allows or requires a team selection; omit it to use the workflow's default audience. On update, sending this field sets the audience to exactly these teams and requires permission to manage instance visibility. Teams that were already selected stay in their current order; newly added teams are appended in the order given. Omit the field to leave the teams unchanged. An empty list clears the teams, except for restrictive instances, which must keep at least one.","uniqueKey":"visibility_teams","typeLabel":"integer[]"}},"required":["aborted_time","active_step_ids","completed_time","id","last_updated_time","process","process_snapshot","public_url","stage","started_time","step_assignments","step_deadlines","url","visibility_mode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"process":"\u003cstring>","step_assignments":[{"step_id":123,"user_id":123}],"url":"\u003cstring>","id":123,"started_time":"2023-11-07T05:31:56Z","completed_time":"2023-11-07T05:31:56Z","aborted_time":"2023-11-07T05:31:56Z","last_updated_time":"2023-11-07T05:31:56Z","process_snapshot":{},"active_step_ids":[123],"step_deadlines":[{}],"public_url":"\u003cstring>","stage":"\u003cstring>","visibility_mode":"\u003cstring>","name":"","deadline":"2023-11-07T05:31:56Z","priority":"V","tags":[],"visibility_teams":[123]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"5b1bbe5e-dbd1-4fac-8239-bcd8e2c1a771":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header","x-default":"Api-Key YOUR_NM_API_KEY","description":"\n\nAuthentication is API key based. As an admin, you can generate an API key in Next Matter by going to Company > Next Matter API keys.\n\nWhen sending requests to the API, authenticate by passing the API key in the \"Authorization\"\nHTTP header, prepended with the string \"Api-Key \".\n\nFor example:\n\n Authorization: Api-Key xyzabc.12fsfe242ubdgakew\n\".\n\n","scopes":[],"schemeName":"Bearer"}}},"servers":{"f9b25e41-c589-43d6-910a-c6c22930270e":{"url":"https://core.nextmatter.com/api/","description":"Base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","x-default":"Api-Key YOUR_NM_API_KEY","description":"\n\nAuthentication is API key based. As an admin, you can generate an API key in Next Matter by going to Company > Next Matter API keys.\n\nWhen sending requests to the API, authenticate by passing the API key in the \"Authorization\"\nHTTP header, prepended with the string \"Api-Key \".\n\nFor example:\n\n Authorization: Api-Key xyzabc.12fsfe242ubdgakew\n\".\n\n","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Authorization","type":"string","description":"\n\nAuthentication is API key based. As an admin, you can generate an API key in Next Matter by going to Company > Next Matter API keys.\n\nWhen sending requests to the API, authenticate by passing the API key in the \"Authorization\"\nHTTP header, prepended with the string \"Api-Key \".\n\nFor example:\n\n Authorization: Api-Key xyzabc.12fsfe242ubdgakew\n\".\n\n","isRequired":true,"default":"Api-Key YOUR_NM_API_KEY","typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"reference/openapi.json"},"subdomain":"nextmatter","siteName":"Welcome to Next Matter","title":"Update instance - Welcome to Next Matter","contextualStarterQuestions":[{"_id":"69d8d9f27504dc70ebde72c0","deploymentId":"67c9d20b94ec01dda34d1331","questionText":"Can I update multiple fields at once?","status":"active","generatedBy":"contextual","path":"reference/instance/update-instance","createdAt":"2026-04-10T11:07:30.917Z","updatedAt":"2026-04-10T11:07:30.917Z","__v":0},{"_id":"69d8d9f27504dc70ebde72bf","deploymentId":"67c9d20b94ec01dda34d1331","questionText":"What properties can I modify?","status":"active","generatedBy":"contextual","path":"reference/instance/update-instance","createdAt":"2026-04-10T11:07:30.917Z","updatedAt":"2026-04-10T11:07:30.917Z","__v":0},{"_id":"69d8d9f27504dc70ebde72be","deploymentId":"67c9d20b94ec01dda34d1331","questionText":"How do I update instance properties?","status":"active","generatedBy":"contextual","path":"reference/instance/update-instance","createdAt":"2026-04-10T11:07:30.917Z","updatedAt":"2026-04-10T11:07:30.917Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T11:55:35.273Z","originalFileLocation":"reference/instance/update-instance.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 all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Welcome to Next Matter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_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/nextmatter/HWRRlbOTACW5oTwT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update instance - Welcome to Next Matter\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Welcome to Next Matter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.nextmatter.com/reference/instance/update-instance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nextmatter.mintlify.app/_mintlify/api/og/v2?division=Instance\u0026amp;title=Update+instance\u0026amp;description=Update+all+instance+properties.+Sending+visibility_teams+sets+the+audience+to+exactly+those+teams+and+requires+permission+to+manage+instance+visibility.+visibil\u0026amp;theme=c739d11e6072ad7020346a36\u0026amp;signature=6c748218976a7cfb296f8ebca5d7b4e4250e4b99381870d9e689dd38ccb37d2d\">\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 instance - Welcome to Next Matter\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nextmatter.mintlify.app/_mintlify/api/og/v2?division=Instance\u0026amp;title=Update+instance\u0026amp;description=Update+all+instance+properties.+Sending+visibility_teams+sets+the+audience+to+exactly+those+teams+and+requires+permission+to+manage+instance+visibility.+visibil\u0026amp;theme=c739d11e6072ad7020346a36\u0026amp;signature=6c748218976a7cfb296f8ebca5d7b4e4250e4b99381870d9e689dd38ccb37d2d\">\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/nextmatter/HWRRlbOTACW5oTwT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Welcome to Next Matter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.nextmatter.com/reference/instance/update-instance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/instance/update-instance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.nextmatter.com/#organization\",\"name\":\"Welcome to Next Matter\",\"url\":\"https://help.nextmatter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nextmatter/Z3-w3RiDibcpWWcE/images/Logo_light.png?fit=max\u0026auto=format\u0026n=Z3-w3RiDibcpWWcE\u0026q=85\u0026s=137252a032983d8c466728fb8942866b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.nextmatter.com#website\",\"name\":\"Welcome to Next Matter\",\"url\":\"https://help.nextmatter.com\",\"publisher\":{\"@id\":\"https://help.nextmatter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.nextmatter.com/reference/instance/update-instance#webpage\",\"url\":\"https://help.nextmatter.com/reference/instance/update-instance\",\"name\":\"Update instance\",\"description\":\"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.\",\"dateModified\":\"2026-10-16T11:55:35.273Z\",\"isPartOf\":{\"@id\":\"https://help.nextmatter.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.nextmatter.com/reference/instance/update-instance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.nextmatter.com/reference/instance/update-instance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://help.nextmatter.com/reference/file/upload-file\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Instance\",\"item\":\"https://help.nextmatter.com/reference/instance/create-instance\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update instance\",\"item\":\"https://help.nextmatter.com/reference/instance/update-instance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.nextmatter.com/reference/instance/update-instance#apireference\",\"headline\":\"Update instance\",\"name\":\"Update instance\",\"description\":\"Update all instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.\",\"url\":\"https://help.nextmatter.com/reference/instance/update-instance\",\"mainEntityOfPage\":{\"@id\":\"https://help.nextmatter.com/reference/instance/update-instance#webpage\"},\"dateModified\":\"2026-10-16T11:55:35.273Z\",\"publisher\":{\"@id\":\"https://help.nextmatter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.nextmatter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Welcome to Next Matter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Welcome to Next Matter","nav":{"global":{"anchors":[{"anchor":"Product updates","icon":"gift","href":"https://nextmatter.mintlify.app/changelog/changelog"},{"anchor":"Videos","icon":"video","href":"https://www.youtube.com/playlist?list=PLfgqOsRV3ZEXN2pII9HHQlTHwllZ9uj8r"}]},"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/docs/welcome-to-next-matter"}]},{"tab":"Components","pages":[{"title":"Components","href":"/docs/workflows-and-instances"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/about-integrations"}]},{"tab":"Portals","pages":[{"title":"Portals","href":"/docs/share-workflows-in-portals"}]},{"tab":"Sidebars","pages":[{"title":"Sidebars","href":"/docs/Zendesk-sidebar"}]},{"tab":"Solutions","pages":[{"title":"Solutions","href":"/docs/compliance-with-next-matter"}]},{"tab":"Updates","pages":[{"title":"Updates","href":"/changelog/changelog"}]},{"tab":"APIs","groups":[{"group":"Next Matter API","pages":[{"title":"Get started","href":"/reference/getting-started"}]},{"group":"Endpoints","pages":[{"group":"File","pages":[{"title":"Upload file","deprecated":null,"version":null,"openapi":"/reference/openapi.json post /files/","href":"/reference/file/upload-file"}]},{"group":"Image","pages":[{"title":"Upload image","deprecated":null,"version":null,"openapi":"/reference/openapi.json post /images/","href":"/reference/image/upload-image"}]},{"group":"Instance","pages":[{"title":"Create instance","deprecated":null,"version":null,"openapi":"/reference/openapi.json post /instances/","href":"/reference/instance/create-instance"},{"title":"Get instance","description":"Get the details of an instance","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /instances/{id}/","href":"/reference/instance/get-instance"},{"title":"Update instance","deprecated":null,"version":null,"openapi":"/reference/openapi.json put /instances/{id}/","href":"/reference/instance/update-instance"},{"title":"Partially update instance","description":"Update selected instance properties. Sending visibility_teams sets the audience to exactly those teams and requires permission to manage instance visibility. visibility_mode is read-only.","deprecated":null,"version":null,"openapi":"/reference/openapi.json patch /instances/{id}/","href":"/reference/instance/partially-update-instance"},{"title":"Complete step","deprecated":null,"version":null,"openapi":"/reference/openapi.json post /instances/{id}/complete_step/","href":"/reference/instance/complete-step"},{"title":"Stop instances","deprecated":null,"version":null,"openapi":"/reference/openapi.json post /instances/bulk/abort","href":"/reference/instance/stop-instances"},{"title":"Delete instances","deprecated":null,"version":null,"openapi":"/reference/openapi.json post /instances/bulk/delete","href":"/reference/instance/delete-instances"},{"title":"List workflow instances","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /processes/{process_id}/instances/","href":"/reference/instance/list-workflow-instances"},{"title":"List workflow instances (v2)","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /v2/processes/{process_id}/instances/","href":"/reference/instance/list-workflow-instances-v2"}]},{"group":"Workflow","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /processes/","href":"/reference/workflow/list-workflows"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /processes/{id}/","href":"/reference/workflow/get-workflow"}]},{"group":"Form field","pages":[{"title":"Details of form field","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /processes/{process_id}/steps/{step_id}/actions/{action_id}/","href":"/reference/form-field/details-of-form-field"},{"title":"Details of form field (v2)","deprecated":null,"version":null,"openapi":"/reference/openapi.json get /v2/processes/{process_id}/steps/{step_id}/actions/{action_id}/","href":"/reference/form-field/details-of-form-field-v2"}]}]}]}]},"title":"Update instance - Welcome to Next Matter","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}