Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
x-workspace-id
string
One of the workspaces the key was issued for, as returned by GET /api/v1/workspaces. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.
x-act-as
string
Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.
Path Parameters
templateId
string
required
Body
application/json
name
string
The template's name.
Minimum string length: 1
Example:
"Employment agreement"
description
string
Free-text description of what the template is for.
Example:
"Standard individual employment agreement for new hires."
status
enum<string>
New lifecycle state: DRAFT, ACTIVE or ARCHIVED. Moving to ACTIVE for the first time stamps the publish time; moving to ARCHIVED stamps the archive time and moving out of it clears it. An update that leaves a WORKFLOW template ACTIVE is refused with 400 while its questions break a workflow rule.
Available options:
DRAFT,
ACTIVE,
ARCHIVED
Example:
"ACTIVE"
tags
string[]
Replaces the template's tags with this set. A tag that does not exist yet is created.
Example:
["HR", "Onboarding"]
reminderIntervalDays
integer | null
Days between automatic reminders to each recipient who hasn't finished, counted from their invitation. Null or absent sends none.
Required range: x >= 1
Example:
3
expirationDays
integer | null
Days the package stays open for signing, counted from when it is sent. Null or absent means it never expires.
Required range: x >= 1
Example:
30
expiryWarningDays
integer | null
Days before expiry at which recipients who haven't finished are warned. MUST be fewer than expirationDays.
Required range: x >= 1
Example:
5
emailSubject
string | null
Subject of the invitation email. {{key}} placeholders are filled from the package's merge field values.
Example:
"Your employment agreement with Ashcombe Advisory Limited"
emailMessage
string | null
Body of the invitation email. {{key}} placeholders are filled from the package's merge field values.
Example:
"Kia ora {{employee_name}}, please review and sign your agreement."
signingMode
enum<string>
How recipients are walked through signing. PARALLEL invites every recipient at once; SEQUENTIAL invites one at a time in order; WORKFLOW follows the template's workflow, asking recipients its questions as they open the package.
Available options:
PARALLEL,
SEQUENTIAL,
WORKFLOW
Example:
"SEQUENTIAL"
brandColor
string | null
Accent colour for the signing experience and emails, as a six-digit hex code. Needs a plan with custom branding, otherwise 402. Null clears it.
Pattern: ^#[0-9a-fA-F]{6}$
Example:
"#1a2b3c"
roles
object[]
Replaces the roles. A role carrying its id keeps that id and the fields placed for it; a role left out is removed with its fields, and removing one the workflow uses is a 409. The recipient cap still applies. Omit to keep the current roles.
Show child attributes
questions
object[]
Replaces the workflow's questions wholesale. Needs signingMode WORKFLOW, set here or already on the template, or it is a 422. Questions reference each other by position in this array; an action's targetDocumentId is a document id from GET /api/v1/templates/:templateId. Omit to keep the current questions.
Show child attributes
metadata
any | null
Not accepted. A template's default custom field values are set in the app; sending this is refused with 400 and nothing is saved.
documentConfig
object[]
Changes to documents' variables and question wording: a DYNAMIC document's variables, or a STANDARD PDF's merge fields. Variables can't be added or removed here: a DYNAMIC document's come from its content, and a PDF's are added in the app. A PDF merge field keeps its key, and takes the SENDER, AUTHOR or MAPPED source only. A change that leaves a document's config invalid (a duplicate key, a MAPPED variable without a binding, another source on a PDF) is a 422. A document linked from the library is edited in the library, so changing one here is a 409.
Show child attributes
mergeFields
object[]
Replaces every merge field. Blank at launch means the field's default. Omit to keep the current merge fields.
Show child attributes
Response
Success
data
object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flowsign","description":"Flowsign documentation: product guides, REST API reference, webhooks and integrations.","colors":{"primary":"#2b7fe0","light":"#4a9eff","dark":"#2b7fe0"},"logo":{"light":"https://mintcdn.com/doc-a97e5290/EK-Ntl9NxEsFqj8A/logo/light.png?fit=max\u0026auto=format\u0026n=EK-Ntl9NxEsFqj8A\u0026q=85\u0026s=35b953b45d6c407f9dd7b1178249e9e4","dark":"https://mintcdn.com/doc-a97e5290/EK-Ntl9NxEsFqj8A/logo/dark.png?fit=max\u0026auto=format\u0026n=EK-Ntl9NxEsFqj8A\u0026q=85\u0026s=defd96407d6a7d573e66eaa5c70bfeaf","href":"https://flowsign.app"},"favicon":"https://mintcdn.com/doc-a97e5290/CtLjU_PfJfA-w8X1/favicon.png?fit=max\u0026auto=format\u0026n=CtLjU_PfJfA-w8X1\u0026q=85\u0026s=216c61b4266ca9224360bc741516576f","api":{"playground":{"display":"simple"},"examples":{"languages":["curl","javascript","typescript","node","python","csharp","dotnet","powershell"],"prefill":true},"url":"full"},"background":{"color":{"light":"#ffffff","dark":"#0f1011"}},"navbar":{"links":[{"href":"mailto:support@flowsign.app?subject=Flowsign%20docs%20feedback","label":"Report a problem"},{"href":"https://status.flowsign.app","label":"Status"},{"href":"https://my.flowsign.app/login","label":"Log in"}],"primary":{"type":"button","label":"Sign up","href":"https://my.flowsign.app/signup"}},"footer":{"socials":{"website":"https://flowsign.app","linkedin":"https://www.linkedin.com/company/flowsign-app"},"links":[{"header":"Flowsign","items":[{"label":"flowsign.app","href":"https://flowsign.app"},{"label":"Pricing","href":"https://flowsign.app/pricing"},{"label":"Contact support","href":"mailto:support@flowsign.app"},{"label":"System status","href":"https://status.flowsign.app"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"https://flowsign.app/legal/terms"},{"label":"Privacy Policy","href":"https://flowsign.app/legal/privacy"},{"label":"Security","href":"https://flowsign.app/resources/security"}]}]},"search":{"prompt":"Search the Flowsign docs"},"seo":{"metatags":{"og:site_name":"Flowsign Docs","twitter:card":"summary_large_image"},"organization":{"name":"Flowsign","url":"https://flowsign.app","logo":"https://docs.flowsign.app/logo/light.png","sameAs":["https://www.linkedin.com/company/flowsign-app"]}},"fonts":{"family":"Satoshi","source":"fonts/Satoshi-Variable.woff2","format":"woff2"},"icons":{"library":"lucide"},"banner":{"content":"New to Flowsign? [Get started](/getting-started) walks you through your first package.","dismissible":true,"type":"info"},"errors":{"404":{"redirect":false,"title":"Page not found","description":"That page has moved or never existed. Try the search above, check [system status](https://status.flowsign.app), or [contact support](mailto:support@flowsign.app)."}},"contextual":{"options":["copy","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"markdown":{"instructions":["Flowsign is one word with a lowercase s.","The REST API base URL is https://my.flowsign.app and every endpoint lives under /api/v1.","When answering API questions, cite the HTTP method and endpoint path.","API access needs the Enterprise plan and an API key with the API access permission."]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"sparkles","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"doc-a97e5290","hasAudioNarration":false,"actualSubdomain":"doc-a97e5290","customDomains":["docs.flowsign.app"],"gitSource":{"type":"github","owner":"studio-phoenix-nz","repo":"flowsign","deployBranch":"master","contentDirectory":"apps/public-docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af2d13184c63df725979798","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Guides","count":80},{"language":"default","tag":"Product guides","count":69},{"language":"default","tag":"API","count":63},{"language":"default","tag":"Endpoints","count":52},{"language":"default","tag":"Packages","count":33},{"language":"default","tag":"Templates","count":18},{"language":"default","tag":"Settings","count":15},{"language":"default","tag":"Integrations","count":14},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Signing groups","count":8}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:Satoshi;src:url(\"/fonts/Satoshi-Variable.woff2\") format(\"woff2\");font-weight:300 900;font-display:swap}:root{--fs-accent: rgb(var(--primary));--fs-chevron: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 18 18' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M6.5 2.75L12.75 9L6.5 15.25'/%3E%3C/svg%3E\")}:root.dark{--fs-accent: rgb(var(--primary-light))}html,body,.antialiased{-webkit-font-smoothing:auto!important;-moz-osx-font-smoothing:auto!important}#page-title{letter-spacing:-0.01em}#content-area :is(h2,h3,h4){letter-spacing:normal}#table-of-contents-content a,#footer a,#content-area td,.callout [data-component-part=\"callout-content\"],.api-section .prose-sm,[data-component-part=\"field-content\"],[data-component-part=\"update-content\"],[data-component-part=\"update-description\"],[data-component-part=\"frame-caption\"],#chat-assistant-textarea,#chat-assistant-textarea::placeholder,[data-component-part=\"expandable-button\"],[role=\"menu\"] [role=\"menuitem\"],#search-bar-entry{font-weight:500}.callout [data-component-part=\"callout-content\"]{font-size:0.9375rem}::selection{background-color:rgb(43 127 224 / 0.24);color:inherit}.dark ::selection{background-color:rgb(74 158 255 / 0.28);color:inherit}#navigation-items li>a:not(.nav-anchor)>div:first-child:has(>svg[style*=\"mask-image\"]){display:none}#navigation-items button:has(svg[style*=\"mask-image\"])+ul>li>a{padding-left:2.75rem!important}#navigation-items :is(li>a,button){font-size:0.9375rem;font-weight:500}#navigation-items .method-nav-pill{width:2.875rem}#navigation-items .method-nav-pill>span{padding:3px 5px;font-size:0.65rem;letter-spacing:0.02em}#navigation-items button[aria-expanded]>div:last-child{margin-inline-start:-8px}#navigation-items button[aria-expanded] svg[stroke]{rotate:90deg;translate:0 1px;transition:none}#navigation-items button[aria-expanded=\"true\"] svg[stroke]{rotate:270deg}#navigation-items :is(li>a:not([aria-current]),button):is(:hover,:focus-visible){background-color:transparent;color:var(--fs-accent)}#navigation-items :is(li>a:not([aria-current]),button):is(:hover,:focus-visible) svg[style*=\"mask-image\"]{background-color:var(--fs-accent)}#navigation-items button:is(:hover,:focus-visible) svg[stroke]{color:var(--fs-accent)}#navigation-items .nav-anchor:is(:hover,:focus-visible){color:var(--fs-accent)}#navigation-items .nav-anchor:is(:hover,:focus-visible)>div:first-child{background-color:rgb(var(--background-light))!important;box-shadow:0 0 0 1px color-mix(in srgb, var(--fs-accent) 40%, transparent)!important}.dark #navigation-items .nav-anchor:is(:hover,:focus-visible)>div:first-child{background-color:rgb(var(--background-dark))!important}#navigation-items .sidebar-group-header{font-size:0.9375rem}.nav-tabs-item{transition:color 0.15s ease}.nav-tabs-item:not([data-active=\"true\"]):is(:hover,:focus-visible){color:var(--fs-accent)}.nav-tabs-item>div:last-child{background-color:var(--fs-accent);transform:scaleX(0);transform-origin:left center;transition:transform 0.35s ease}.nav-tabs-item:is([data-active=\"true\"],:hover,:focus-visible)>div:last-child{background-color:var(--fs-accent);transform:scaleX(1)}.navbar-link a{transition:color 0.2s ease,\n background-color 0.2s ease}.navbar-link a:is(:hover,:focus-visible){color:var(--fs-accent)}.navbar-link a[href$=\"/login\"]{margin-inline:-8px;padding:8px 14px;border-radius:9999px}.navbar-link a[href$=\"/login\"]:is(:hover,:focus-visible){background-color:var(--fs-accent);color:#fff}#topbar-cta-button a{padding-inline:14px 10px}#topbar-cta-button a>span:first-child{border-radius:9999px}#topbar-cta-button svg{transition:transform 0.2s ease}#topbar-cta-button a:is(:hover,:focus-visible) svg{transform:translateX(3px)}#table-of-contents-content li:not([data-active])>a{transition:color 0.15s ease}#table-of-contents-content li:not([data-active])>a:is(:hover,:focus-visible){color:var(--fs-accent)}#pagination [data-component-part=\"pagination-title\"]{transition:color 0.15s ease}#pagination a:is(:hover,:focus-visible) [data-component-part=\"pagination-title\"]{color:var(--fs-accent)}#pagination [data-component-part=\"pagination-chevron\"]{display:none}#pagination a[rel=\"prev\"]::before,#pagination a[rel=\"next\"]::after{content:\"\";flex:none;width:1.125rem;height:1.125rem;background-color:rgb(var(--gray-400));-webkit-mask:var(--fs-chevron) center / contain no-repeat;mask:var(--fs-chevron) center / contain no-repeat;transition:background-color 0.15s ease,\n translate 0.2s ease}#pagination a[rel=\"prev\"]::before{margin-inline-end:-8px;scale:-1 1}#pagination a[rel=\"next\"]::after{margin-inline-start:-8px}#pagination a[rel=\"prev\"]:is(:hover,:focus-visible)::before,#pagination a[rel=\"next\"]:is(:hover,:focus-visible)::after{background-color:var(--fs-accent)}#pagination a[rel=\"prev\"]:is(:hover,:focus-visible)::before{translate:-3px 0}#pagination a[rel=\"next\"]:is(:hover,:focus-visible)::after{translate:3px 0}#footer a{transition:color 0.15s ease}#footer a:is(:hover,:focus-visible){color:var(--fs-accent)}@media (prefers-reduced-motion: reduce){.nav-tabs-item,.nav-tabs-item>div:last-child,.navbar-link a,#topbar-cta-button svg,#table-of-contents-content li>a,#pagination [data-component-part=\"pagination-title\"],#pagination a[rel=\"prev\"]::before,#pagination a[rel=\"next\"]::after,#footer a{transition:none}}"}],"page":{"pagePath":"api-reference/endpoints/templates/update-a-template","slug":"/api-reference/endpoints/templates/update-a-template","pageMetadata":{"title":"Update a template","description":"Updates the fields given and leaves the rest as they are. Requires CREATE template access.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/templates/{templateId}","href":"/api-reference/endpoints/templates/update-a-template","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: \"Updates the fields given and leaves the rest as they are. Requires CREATE template access.\"\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 a template","description":"Updates the fields given and leaves the rest as they are. Requires CREATE template access.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/templates/{templateId}","href":"/api-reference/endpoints/templates/update-a-template","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"patchTemplatesByTemplateId","summary":"Update a template","description":"Updates the fields given and leaves the rest as they are. Requires CREATE template access.","tags":["Templates"],"parameters":["48cf4ce5-4009-41dd-967d-240f096d5cba","50021703-a32d-473c-8221-335734dc5be6","08ff12e9-0080-44c5-8821-6828c25c1d95"],"requestBody":"7f204a38-9ae4-42ed-9924-0fa65c8d2e8c","responses":{"200":"7bed135f-281c-4dc0-8c80-c175ce98f963","400":"ebe80650-e93b-4f6d-bf4c-0f54ff4c1b87","401":"9ef89775-6d25-444b-9809-d7b042621e98","402":"897818bf-fc70-4fde-a105-ce1907774a08","403":"034c361f-ae66-4967-9334-a43aa0ac5d6e","404":"04b86108-96ed-4bfa-9c67-eb3870de8a65","409":"48d74947-c201-4fcf-bd4d-cb88fc83ba95","422":"e942d33c-df31-47fe-a309-8e69e6558ff2","429":"cdf0a139-baed-4603-b005-69da6bb2eca9"},"method":"patch","type":"path","servers":["88b07dc8-099a-4b91-9c83-959cd32a8304"],"security":["833badbd-18f8-4c1a-9f7f-9783e1b26489"],"path":"/api/v1/templates/{templateId}","baseUrlOptions":["https://my.flowsign.app"],"title":"Update a template","codeSamples":[],"requestExampleLanguages":["bash","javascript","typescript","node","python","csharp","dotnet","powershell"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name":"Employment agreement","body.description":"Standard individual employment agreement for new hires.","body.status":"ACTIVE","body.tags.items.0":"HR","body.tags.items.1":"Onboarding","body.reminderIntervalDays.oneOf.0":3,"body.expirationDays.oneOf.0":30,"body.expiryWarningDays.oneOf.0":5,"body.emailSubject.oneOf.0":"Your employment agreement with Ashcombe Advisory Limited","body.emailMessage.oneOf.0":"Kia ora {{employee_name}}, please review and sign your agreement.","body.signingMode":"SEQUENTIAL","body.brandColor.oneOf.0":"#1a2b3c","body.roles.items.0.name":"Employee","body.roles.items.0.order":0,"body.roles.items.0.id":"cmg3k2v8a0001s7p4d9x1qz2h","body.roles.items.0.actionType":"SIGNER","body.roles.items.0.deliveryDefault":"EMAIL","body.roles.items.0.hostRole":"SENDER","body.roles.items.0.hostUserIds.items.0":"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f","body.roles.items.0.hostGroupIds.items.0":"cmg1hd3x10002v8p9f6r8bt4n","body.questions.items.0.question":"Does the role include a company vehicle?","body.questions.items.0.order":0,"body.questions.items.0.type":"TOGGLE","body.questions.items.0.dependsOnQuestionIndex":0,"body.questions.items.0.dependsOnOptionIndex":0,"body.questions.items.0.options.items.0.label":"Yes","body.questions.items.0.options.items.0.order":0,"body.questions.items.0.options.items.0.isDefault":true,"body.questions.items.0.options.items.0.actions.items.0.type":"INCLUDE_DOCUMENT","body.questions.items.0.options.items.0.actions.items.0.targetDocumentId.oneOf.0":"cmg3k5r1c0003s7p4h2m8tb7k","body.questions.items.0.options.items.0.actions.items.0.targetFieldId.oneOf.0":"cmg3k7q9e0004s7p4b1z6lc3n","body.metadata.oneOf.0":"\u003cunknown>","body.documentConfig.items.0.documentId":"cmg3k5r1c0003s7p4h2m8tb7k","body.documentConfig.items.0.variables.items.0.ref":"v_3kq9x","body.documentConfig.items.0.variables.items.0.key":"start_date","body.documentConfig.items.0.variables.items.0.label":"Start date","body.documentConfig.items.0.variables.items.0.type":"TEXT","body.documentConfig.items.0.variables.items.0.source":"SENDER","body.documentConfig.items.0.variables.items.0.defaultValue.oneOf.0":"2026-10-01","body.documentConfig.items.0.variables.items.0.isRequired":true,"body.documentConfig.items.0.questions.items.0.id":"cmg3k9y2h0006s7p4e4k7nq1t","body.documentConfig.items.0.questions.items.0.question":"Is a company car included?","body.documentConfig.items.0.questions.items.0.options.items.0.id":"cmg3k9y2h0007s7p4g8d3rp6v","body.documentConfig.items.0.questions.items.0.options.items.0.label":"Yes","body.mergeFields.items.0.key":"start_date","body.mergeFields.items.0.label":"Start date","body.mergeFields.items.0.order":0,"body.mergeFields.items.0.description":"The employee's first day of work.","body.mergeFields.items.0.source":"SENDER","body.mergeFields.items.0.type":"DATE","body.mergeFields.items.0.options.items.0":"Full time","body.mergeFields.items.0.options.items.1":"Part time","body.mergeFields.items.0.defaultValue":"2026-10-01","body.mergeFields.items.0.isRequired":true}],"urlDisplay":"full"},"dependencies":{"parameters":{"48cf4ce5-4009-41dd-967d-240f096d5cba":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"templateId","in":"path"},"50021703-a32d-473c-8221-335734dc5be6":{"schema":{"type":"string","description":"One of the workspaces the key was issued for, as returned by `GET /api/v1/workspaces`. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"x-workspace-id","in":"header"},"08ff12e9-0080-44c5-8821-6828c25c1d95":{"schema":{"type":"string","description":"Required on a key that acts for members, refused on any other key. Names the member the call runs as, as `key=value`: `email=jane@acme.com`, `employee_id=E-1001`, `scim_external_id=…` or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"x-act-as","in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The template's name.","example":"Employment agreement","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"Free-text description of what the template is for.","example":"Standard individual employment agreement for new hires.","uniqueKey":"description","typeLabel":"string"},"status":{"type":"string","description":"New lifecycle state: DRAFT, ACTIVE or ARCHIVED. Moving to ACTIVE for the first time stamps the publish time; moving to ARCHIVED stamps the archive time and moving out of it clears it. An update that leaves a WORKFLOW template ACTIVE is refused with 400 while its questions break a workflow rule.","enum":["DRAFT","ACTIVE","ARCHIVED"],"example":"ACTIVE","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Replaces the template's tags with this set. A tag that does not exist yet is created.","example":["HR","Onboarding"],"uniqueKey":"tags","typeLabel":"string[]"},"reminderIntervalDays":{"oneOf":[{"type":"integer","minimum":1,"description":"Days between automatic reminders to each recipient who hasn't finished, counted from their invitation. Null or absent sends none.","example":3,"uniqueKey":"reminderIntervalDays.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Days between automatic reminders to each recipient who hasn't finished, counted from their invitation. Null or absent sends none.","example":3,"uniqueKey":"reminderIntervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"reminderIntervalDays","typeLabel":"integer | null"},"expirationDays":{"oneOf":[{"type":"integer","minimum":1,"description":"Days the package stays open for signing, counted from when it is sent. Null or absent means it never expires.","example":30,"uniqueKey":"expirationDays.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Days the package stays open for signing, counted from when it is sent. Null or absent means it never expires.","example":30,"uniqueKey":"expirationDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"expirationDays","typeLabel":"integer | null"},"expiryWarningDays":{"oneOf":[{"type":"integer","minimum":1,"description":"Days before expiry at which recipients who haven't finished are warned. MUST be fewer than `expirationDays`.","example":5,"uniqueKey":"expiryWarningDays.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Days before expiry at which recipients who haven't finished are warned. MUST be fewer than `expirationDays`.","example":5,"uniqueKey":"expiryWarningDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiryWarningDays","typeLabel":"integer | null"},"emailSubject":{"oneOf":[{"type":"string","description":"Subject of the invitation email. {{key}} placeholders are filled from the package's merge field values.","example":"Your employment agreement with Ashcombe Advisory Limited","uniqueKey":"emailSubject.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subject of the invitation email. {{key}} placeholders are filled from the package's merge field values.","example":"Your employment agreement with Ashcombe Advisory Limited","uniqueKey":"emailSubject.oneOf.1","typeLabel":"null"}],"uniqueKey":"emailSubject","typeLabel":"string | null"},"emailMessage":{"oneOf":[{"type":"string","description":"Body of the invitation email. {{key}} placeholders are filled from the package's merge field values.","example":"Kia ora {{employee_name}}, please review and sign your agreement.","uniqueKey":"emailMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Body of the invitation email. {{key}} placeholders are filled from the package's merge field values.","example":"Kia ora {{employee_name}}, please review and sign your agreement.","uniqueKey":"emailMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"emailMessage","typeLabel":"string | null"},"signingMode":{"type":"string","description":"How recipients are walked through signing. PARALLEL invites every recipient at once; SEQUENTIAL invites one at a time in `order`; WORKFLOW follows the template's workflow, asking recipients its questions as they open the package.","enum":["PARALLEL","SEQUENTIAL","WORKFLOW"],"example":"SEQUENTIAL","uniqueKey":"signingMode","typeLabel":"enum\u003cstring>"},"brandColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"Accent colour for the signing experience and emails, as a six-digit hex code. Needs a plan with custom branding, otherwise 402. Null clears it.","example":"#1a2b3c","uniqueKey":"brandColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-fA-F]{6}$","description":"Accent colour for the signing experience and emails, as a six-digit hex code. Needs a plan with custom branding, otherwise 402. Null clears it.","example":"#1a2b3c","uniqueKey":"brandColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"brandColor","typeLabel":"string | null"},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The role's name, unique within the template. A role is a named slot a person fills when a package is launched: each recipient in `POST /api/v1/packages/from-template` is matched onto a role by this exact name.","example":"Employee","isRequired":true,"uniqueKey":"roles.items.[INDEX].name","typeLabel":"string"},"order":{"type":"integer","minimum":0,"description":"Zero-based position of the role. In SEQUENTIAL signing mode roles are invited one at a time in this order; in PARALLEL mode it only orders the list.","example":0,"isRequired":true,"uniqueKey":"roles.items.[INDEX].order","typeLabel":"integer"},"id":{"type":"string","minLength":1,"description":"The role's id. Carry the id from `GET /api/v1/templates/:templateId` to keep a role and the fields placed for it; a role left out of `roles` is removed with its fields. A new role may take an id of your own choosing, which a merge field's `binding.roleId` in the same request can name; the saved role gets a server id.","example":"cmg3k2v8a0001s7p4d9x1qz2h","uniqueKey":"roles.items.[INDEX].id","typeLabel":"string"},"actionType":{"type":"string","description":"What the person filling this role does with the package. SIGNER completes fields and signs; VIEWER can open and read the package while it is out but has no fields; CC only receives the finished copy by email and never gets a signing session. Defaults to SIGNER.","enum":["SIGNER","VIEWER","CC"],"example":"SIGNER","uniqueKey":"roles.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"deliveryDefault":{"type":"string","description":"How the recipient filling this role receives the package by default. EMAIL (the default) sends an invitation; IN_PERSON is hosted on someone's device.","enum":["EMAIL","IN_PERSON"],"example":"EMAIL","uniqueKey":"roles.items.[INDEX].deliveryDefault","typeLabel":"enum\u003cstring>"},"hostRole":{"type":"string","enum":["SENDER","SPECIFIC_USER","MEMBER_GROUP"],"description":"Who may host an IN_PERSON recipient's session. SENDER is whoever sent the package; SPECIFIC_USER is one of `hostUserIds`; MEMBER_GROUP is any member of `hostGroupIds`.","example":"SENDER","uniqueKey":"roles.items.[INDEX].hostRole","typeLabel":"enum\u003cstring>"},"hostUserIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"roles.items.[INDEX].hostUserIds.items.[INDEX]","typeLabel":"string"},"maxItems":5,"description":"The members who may host an IN_PERSON recipient when `hostRole` is SPECIFIC_USER. Up to 5.","example":["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],"uniqueKey":"roles.items.[INDEX].hostUserIds","typeLabel":"string[]"},"hostGroupIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"roles.items.[INDEX].hostGroupIds.items.[INDEX]","typeLabel":"string"},"maxItems":3,"description":"The member groups whose members may host when `hostRole` is MEMBER_GROUP. Up to 3.","example":["cmg1hd3x10002v8p9f6r8bt4n"],"uniqueKey":"roles.items.[INDEX].hostGroupIds","typeLabel":"string[]"}},"required":["name","order"],"uniqueKey":"roles.items.[INDEX]","typeLabel":"object"},"description":"Replaces the roles. A role carrying its `id` keeps that id and the fields placed for it; a role left out is removed with its fields, and removing one the workflow uses is a 409. The recipient cap still applies. Omit to keep the current roles.","uniqueKey":"roles","typeLabel":"object[]"},"questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","minLength":1,"description":"The question as it is asked.","example":"Does the role include a company vehicle?","isRequired":true,"uniqueKey":"questions.items.[INDEX].question","typeLabel":"string"},"order":{"type":"integer","minimum":0,"description":"Zero-based position of the question among the template's questions.","example":0,"isRequired":true,"uniqueKey":"questions.items.[INDEX].order","typeLabel":"integer"},"type":{"type":"string","enum":["TOGGLE","CHOICE"],"description":"How the answers are offered. TOGGLE is a yes/no pair; CHOICE is a named list. Presentational only: the options are stored as given either way.","example":"TOGGLE","uniqueKey":"questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"dependsOnQuestionIndex":{"type":"integer","minimum":0,"description":"Zero-based index into `questions` of the question whose answer reveals this one. Give it together with `dependsOnOptionIndex`; a pair that names nothing is ignored.","example":0,"uniqueKey":"questions.items.[INDEX].dependsOnQuestionIndex","typeLabel":"integer"},"dependsOnOptionIndex":{"type":"integer","minimum":0,"description":"Zero-based index into that question's `options` of the answer that reveals this question.","example":0,"uniqueKey":"questions.items.[INDEX].dependsOnOptionIndex","typeLabel":"integer"},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"description":"The answer as it is shown to the person answering.","example":"Yes","isRequired":true,"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"},"order":{"type":"integer","minimum":0,"description":"Zero-based position of the option among the question's options.","example":0,"isRequired":true,"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].order","typeLabel":"integer"},"isDefault":{"type":"boolean","description":"Whether this option is preselected. When no option sets it, the last option is the default.","example":true,"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].isDefault","typeLabel":"boolean"},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["INCLUDE_DOCUMENT","EXCLUDE_DOCUMENT","SHOW_FIELD","HIDE_FIELD"],"description":"What picking this option does. INCLUDE_DOCUMENT attaches the document in `targetDocumentId` to the package and EXCLUDE_DOCUMENT drops it. SHOW_FIELD and HIDE_FIELD are accepted but not applied by this endpoint.","example":"INCLUDE_DOCUMENT","isRequired":true,"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"targetDocumentId":{"oneOf":[{"type":"string","description":"The template document the action applies to, by document id. A reference the template does not recognise is dropped and reported in `warnings`.","example":"cmg3k5r1c0003s7p4h2m8tb7k","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].targetDocumentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The template document the action applies to, by document id. A reference the template does not recognise is dropped and reported in `warnings`.","example":"cmg3k5r1c0003s7p4h2m8tb7k","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].targetDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].targetDocumentId","typeLabel":"string | null"},"targetFieldId":{"oneOf":[{"type":"string","description":"Reserved for SHOW_FIELD and HIDE_FIELD, which this endpoint does not currently apply.","example":"cmg3k7q9e0004s7p4b1z6lc3n","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].targetFieldId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reserved for SHOW_FIELD and HIDE_FIELD, which this endpoint does not currently apply.","example":"cmg3k7q9e0004s7p4b1z6lc3n","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].targetFieldId.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX].targetFieldId","typeLabel":"string | null"}},"required":["type"],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions.items.[INDEX]","typeLabel":"object"},"description":"What happens to the package's documents when this option is picked.","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].actions","typeLabel":"object[]"}},"required":["label","order"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"description":"The answers on offer, each with the actions it triggers.","uniqueKey":"questions.items.[INDEX].options","typeLabel":"object[]"}},"required":["question","order"],"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"description":"Replaces the workflow's questions wholesale. Needs `signingMode` WORKFLOW, set here or already on the template, or it is a 422. Questions reference each other by position in this array; an action's `targetDocumentId` is a document id from `GET /api/v1/templates/:templateId`. Omit to keep the current questions.","uniqueKey":"questions","typeLabel":"object[]"},"metadata":{"oneOf":[{"description":"Not accepted. A template's default custom field values are set in the app; sending this is refused with 400 and nothing is saved.","uniqueKey":"metadata.oneOf.0","typeLabel":"any"},{"description":"Not accepted. A template's default custom field values are set in the app; sending this is refused with 400 and nothing is saved.","type":"null","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"any | null"},"documentConfig":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","minLength":1,"description":"A document on the template: a DYNAMIC document, or a STANDARD PDF with merge fields.","example":"cmg3k5r1c0003s7p4h2m8tb7k","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].documentId","typeLabel":"string"},"variables":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","minLength":1,"description":"The variable's ref, the stable identity its placeholders in the content carry. Minted when the content is converted or edited; it cannot be chosen here.","example":"v_3kq9x","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].ref","typeLabel":"string"},"key":{"type":"string","pattern":"^\\w+$","description":"The placeholder name the content and merge values use. Letters, digits and _ only.","example":"start_date","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","description":"The name shown to whoever supplies the value.","example":"Start date","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","description":"The kind of value a merge field or document variable holds, which decides how its default and launch values are validated: TEXT, NUMBER, DATE (ISO 8601 date) or CURRENCY.","enum":["TEXT","NUMBER","DATE","CURRENCY"],"example":"TEXT","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"source":{"type":"string","enum":["AUTHOR","SENDER","SIGNEE","WORKFLOW","MAPPED"],"description":"Who supplies a document variable's value. SENDER asks the sender at launch; AUTHOR fixes it to `defaultValue`; SIGNEE asks the recipient while signing; WORKFLOW lets a workflow answer set it; MAPPED reads a recipient's details through `binding`.","example":"SENDER","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"defaultValue":{"oneOf":[{"type":"string","description":"The value used when none is given, or null.","example":"2026-10-01","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].defaultValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value used when none is given, or null.","example":"2026-10-01","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].defaultValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].defaultValue","typeLabel":"string | null"},"isRequired":{"type":"boolean","description":"Whether a value must be given.","example":true,"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].isRequired","typeLabel":"boolean"},"dropdownOptions":{"type":"array","items":{"type":"string","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].dropdownOptions.items.[INDEX]","typeLabel":"string"},"description":"Allowed values for a list variable. Empty when any value of `type` is accepted.","example":[],"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].dropdownOptions","typeLabel":"string[]"},"binding":{"type":"object","description":"Where a MAPPED variable reads its value from, or null for any other source. On a document linked from the library it is also null until its library role is mapped to a template role.","required":["kind","roleId","attribute"],"properties":{"kind":{"type":"string","enum":["recipient"],"description":"Where the value is read from. `recipient` reads one of a role's recipient details.","example":"recipient","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].binding.kind","typeLabel":"enum\u003cstring>"},"roleId":{"type":"string","minLength":1,"description":"The template role whose recipient the value is read from.","example":"cmg3k2v8a0001s7p4d9x1qz2h","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].binding.roleId","typeLabel":"string"},"attribute":{"type":"string","enum":["name","email"],"description":"Which of the recipient's details fills the value.","example":"name","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].binding.attribute","typeLabel":"enum\u003cstring>"}},"uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX].binding","typeLabel":"object"}},"required":["ref"],"description":"Changes to one variable, found by `ref`. Fields left out keep their value; a ref the document does not have is ignored.","uniqueKey":"documentConfig.items.[INDEX].variables.items.[INDEX]","typeLabel":"object"},"description":"Changes to the document's variables, or to a PDF's merge fields.","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].variables","typeLabel":"object[]"},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"A question id from `documentQuestions`.","example":"cmg3k9y2h0006s7p4e4k7nq1t","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX].id","typeLabel":"string"},"question":{"type":"string","description":"New wording for the question.","example":"Is a company car included?","uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX].question","typeLabel":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"An option id.","example":"cmg3k9y2h0007s7p4g8d3rp6v","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX].options.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","description":"New wording for the option.","example":"Yes","isRequired":true,"uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"description":"New wording for some of the question's options.","uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX].options","typeLabel":"object[]"}},"required":["id"],"uniqueKey":"documentConfig.items.[INDEX].questions.items.[INDEX]","typeLabel":"object"},"description":"Changes to the wording of the document's questions.","uniqueKey":"documentConfig.items.[INDEX].questions","typeLabel":"object[]"}},"required":["documentId","variables"],"uniqueKey":"documentConfig.items.[INDEX]","typeLabel":"object"},"description":"Changes to documents' variables and question wording: a DYNAMIC document's variables, or a STANDARD PDF's merge fields. Variables can't be added or removed here: a DYNAMIC document's come from its content, and a PDF's are added in the app. A PDF merge field keeps its key, and takes the SENDER, AUTHOR or MAPPED source only. A change that leaves a document's config invalid (a duplicate key, a MAPPED variable without a binding, another source on a PDF) is a 422. A document linked from the library is edited in the library, so changing one here is a 409.","uniqueKey":"documentConfig","typeLabel":"object[]"},"mergeFields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Placeholder name, written as {{key}} in the email subject and message and in document text, and used as the key in `fields` when launching a package. Trimmed and unique within the template: a repeated or blank key is skipped.","example":"start_date","isRequired":true,"uniqueKey":"mergeFields.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","minLength":1,"description":"Human-readable name shown to the sender when the value is asked for.","example":"Start date","isRequired":true,"uniqueKey":"mergeFields.items.[INDEX].label","typeLabel":"string"},"order":{"type":"integer","minimum":0,"description":"Zero-based display position among the template's merge fields.","example":0,"isRequired":true,"uniqueKey":"mergeFields.items.[INDEX].order","typeLabel":"integer"},"description":{"type":"string","description":"Help text shown to the sender alongside the field.","example":"The employee's first day of work.","uniqueKey":"mergeFields.items.[INDEX].description","typeLabel":"string"},"source":{"type":"string","enum":["SENDER","AUTHOR","MAPPED","WORKFLOW"],"description":"Who supplies a merge field's value. SENDER asks the sender at launch; AUTHOR fixes it to `defaultValue`; MAPPED reads it from a recipient's details through `binding`; WORKFLOW lets a workflow answer set it.","example":"SENDER","uniqueKey":"mergeFields.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"binding":{"type":"object","properties":{"kind":{"type":"string","enum":["recipient"],"description":"Where the value is read from. `recipient` reads one of a role's recipient details.","example":"recipient","isRequired":true,"uniqueKey":"mergeFields.items.[INDEX].binding.kind","typeLabel":"enum\u003cstring>"},"roleId":{"type":"string","minLength":1,"description":"The template role whose recipient the value is read from.","example":"cmg3k2v8a0001s7p4d9x1qz2h","isRequired":true,"uniqueKey":"mergeFields.items.[INDEX].binding.roleId","typeLabel":"string"},"attribute":{"type":"string","enum":["name","email"],"description":"Which of the recipient's details fills the value.","example":"name","isRequired":true,"uniqueKey":"mergeFields.items.[INDEX].binding.attribute","typeLabel":"enum\u003cstring>"}},"required":["kind","roleId","attribute"],"description":"Where a MAPPED merge field reads its value from.","uniqueKey":"mergeFields.items.[INDEX].binding","typeLabel":"object"},"type":{"type":"string","enum":["TEXT","NUMBER","DATE","CURRENCY"],"description":"Value type, which decides how the default and launch values are validated: TEXT (free text), NUMBER, DATE (ISO 8601 date) or CURRENCY. Defaults to TEXT.","example":"DATE","uniqueKey":"mergeFields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"options":{"type":"array","items":{"type":"string","uniqueKey":"mergeFields.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"description":"Allowed values for a list field. Entries are trimmed and blanks dropped. When set, the default and any launch value must be one of them.","example":["Full time","Part time"],"uniqueKey":"mergeFields.items.[INDEX].options","typeLabel":"string[]"},"defaultValue":{"type":"string","description":"The value the package uses when the sender leaves the field blank at launch. Checked against `type` and `options`; a bad default is rejected with 422 under `mergeFields.\u003ckey>.defaultValue`.","example":"2026-10-01","uniqueKey":"mergeFields.items.[INDEX].defaultValue","typeLabel":"string"},"isRequired":{"type":"boolean","description":"Whether a value must exist at launch, from the sender or from `defaultValue`. Defaults to false.","example":true,"uniqueKey":"mergeFields.items.[INDEX].isRequired","typeLabel":"boolean"}},"required":["key","label","order"],"uniqueKey":"mergeFields.items.[INDEX]","typeLabel":"object"},"description":"Replaces every merge field. Blank at launch means the field's default. Omit to keep the current merge fields.","uniqueKey":"mergeFields","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Employment agreement","description":"Standard individual employment agreement for new hires.","status":"ACTIVE","tags":["HR","Onboarding"],"reminderIntervalDays":3,"expirationDays":30,"expiryWarningDays":5,"emailSubject":"Your employment agreement with Ashcombe Advisory Limited","emailMessage":"Kia ora {{employee_name}}, please review and sign your agreement.","signingMode":"SEQUENTIAL","brandColor":"#1a2b3c","roles":[{"name":"Employee","order":0,"id":"cmg3k2v8a0001s7p4d9x1qz2h","actionType":"SIGNER","deliveryDefault":"EMAIL","hostRole":"SENDER","hostUserIds":["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],"hostGroupIds":["cmg1hd3x10002v8p9f6r8bt4n"]}],"questions":[{"question":"Does the role include a company vehicle?","order":0,"type":"TOGGLE","dependsOnQuestionIndex":0,"dependsOnOptionIndex":0,"options":[{"label":"Yes","order":0,"isDefault":true,"actions":[{"type":"INCLUDE_DOCUMENT","targetDocumentId":"cmg3k5r1c0003s7p4h2m8tb7k","targetFieldId":"cmg3k7q9e0004s7p4b1z6lc3n"}]}]}],"metadata":"\u003cunknown>","documentConfig":[{"documentId":"cmg3k5r1c0003s7p4h2m8tb7k","variables":[{"ref":"v_3kq9x","key":"start_date","label":"Start date","type":"TEXT","source":"SENDER","defaultValue":"2026-10-01","isRequired":true,"dropdownOptions":[]}],"questions":[{"id":"cmg3k9y2h0006s7p4e4k7nq1t","question":"Is a company car included?","options":[{"id":"cmg3k9y2h0007s7p4g8d3rp6v","label":"Yes"}]}]}],"mergeFields":[{"key":"start_date","label":"Start date","order":0,"description":"The employee's first day of work.","source":"SENDER","type":"DATE","options":["Full time","Part time"],"defaultValue":"2026-10-01","isRequired":true}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7bed135f-281c-4dc0-8c80-c175ce98f963":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the updated template.","example":"kX9dQ2mB7pLw","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.warnings.items.[INDEX]","typeLabel":"string"},"description":"Present only when a question dependency or document reference could not be applied, which the rest of the update is saved without, or when the questions break a workflow rule a DRAFT is allowed to hold.","example":["Question 2 depends on an answer that does not exist and was left unconditional"],"uniqueKey":"data.warnings","typeLabel":"string[]"}},"required":["id"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"kX9dQ2mB7pLw","warnings":["Question 2 depends on an answer that does not exist and was left unconditional"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"ebe80650-e93b-4f6d-bf4c-0f54ff4c1b87":{"description":"The body is not valid JSON, or the update leaves a WORKFLOW template ACTIVE while its questions break a workflow rule","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"9ef89775-6d25-444b-9809-d7b042621e98":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"897818bf-fc70-4fde-a105-ce1907774a08":{"description":"Caller's plan does not include this feature (publicApi / webhooks)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"034c361f-ae66-4967-9334-a43aa0ac5d6e":{"description":"API key present but caller lacks the required permission","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"04b86108-96ed-4bfa-9c67-eb3870de8a65":{"description":"No template with that id in the workspace","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"48d74947-c201-4fcf-bd4d-cb88fc83ba95":{"description":"The template is open for editing in the app by another user, `roles` drops a role the workflow uses, or `documentConfig` changes a document linked from the library","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e942d33c-df31-47fe-a309-8e69e6558ff2":{"description":"Request failed schema validation; details keyed by field","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"cdf0a139-baed-4603-b005-69da6bb2eca9":{"description":"Rate limit exceeded; see `Retry-After`","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in plain words.","example":"Missing permission: canSendPackages","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.additionalProperties","typeLabel":"string[]"},"description":"Validation problems keyed by field path. Present only on 422 responses.","example":{"recipients.0.email":["Invalid email"]},"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing permission: canSendPackages","details":{"recipients.0.email":["Invalid email"]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"833badbd-18f8-4c1a-9f7f-9783e1b26489":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"fsk_*","scopes":[],"schemeName":"ApiKey"}}},"servers":{"88b07dc8-099a-4b91-9c83-959cd32a8304":{"url":"https://my.flowsign.app","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"fsk_*","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"doc-a97e5290","siteName":"Flowsign","title":"Update a template - Flowsign","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T08:09:34.932Z","originalFileLocation":"api-reference/endpoints/templates/update-a-template.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=\"Updates the fields given and leaves the rest as they are. Requires CREATE template access.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flowsign\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_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/doc-a97e5290/3ZJB4Fh4higjYGz2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a template - Flowsign\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates the fields given and leaves the rest as they are. Requires CREATE template access.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flowsign Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://doc-a97e5290.mintlify.site/_mintlify/api/og/v2?division=Templates\u0026amp;title=Update+a+template\u0026amp;description=Updates+the+fields+given+and+leaves+the+rest+as+they+are.+Requires+CREATE+template+access.\u0026amp;theme=58562699d93b4bf7ebdfda8d\u0026amp;signature=8a04adf05e140966e97c2a9c5068aa928b6eb649064005ac4ffde01866ee59c9\">\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 template - Flowsign\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates the fields given and leaves the rest as they are. Requires CREATE template access.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://doc-a97e5290.mintlify.site/_mintlify/api/og/v2?division=Templates\u0026amp;title=Update+a+template\u0026amp;description=Updates+the+fields+given+and+leaves+the+rest+as+they+are.+Requires+CREATE+template+access.\u0026amp;theme=58562699d93b4bf7ebdfda8d\u0026amp;signature=8a04adf05e140966e97c2a9c5068aa928b6eb649064005ac4ffde01866ee59c9\">\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/doc-a97e5290/3ZJB4Fh4higjYGz2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flowsign\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2b7fe0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/templates/update-a-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://flowsign.app/#organization\",\"name\":\"Flowsign\",\"url\":\"https://flowsign.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.flowsign.app/logo/light.png\"},\"sameAs\":[\"https://www.linkedin.com/company/flowsign-app\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flowsign.app#website\",\"name\":\"Flowsign\",\"url\":\"https://docs.flowsign.app\",\"publisher\":{\"@id\":\"https://flowsign.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template#webpage\",\"url\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template\",\"name\":\"Update a template\",\"description\":\"Updates the fields given and leaves the rest as they are. Requires CREATE template access.\",\"dateModified\":\"2026-11-10T08:09:34.932Z\",\"isPartOf\":{\"@id\":\"https://docs.flowsign.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/account/get-the-account-behind-a-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Templates\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/templates/list-templates\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a template\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template#apireference\",\"headline\":\"Update a template\",\"name\":\"Update a template\",\"description\":\"Updates the fields given and leaves the rest as they are. Requires CREATE template access.\",\"url\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/templates/update-a-template#webpage\"},\"dateModified\":\"2026-11-10T08:09:34.932Z\",\"publisher\":{\"@id\":\"https://flowsign.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flowsign.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flowsign\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Flowsign\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/templates/update-a-template.md","siteName":"Flowsign","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"sparkles","href":"/changelog"}]},"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API","icon":"code","groups":[{"group":"Start here","pages":[{"title":"Introduction","icon":"info","href":"/api-reference/introduction"},{"title":"Developer quickstart","icon":"code","href":"/developers"}]},{"group":"Concepts","pages":[{"title":"Authentication","icon":"key-round","href":"/api-reference/authentication"},{"title":"Workspaces","icon":"building-2","href":"/api-reference/workspaces"},{"title":"Errors and rate limits","icon":"circle-alert","href":"/api-reference/errors"},{"title":"Pagination","icon":"list-ordered","href":"/api-reference/pagination"},{"title":"Use with AI","icon":"bot","href":"/api-reference/use-with-ai"}]},{"group":"Using the API","pages":[{"title":"Trying the API","icon":"play","href":"/api-reference/trying-the-api"},{"title":"API specification","icon":"file-code","href":"/api-reference/specification"},{"title":"Endpoint pages","icon":"layout-list","href":"/api-reference/endpoint-pages"},{"title":"Troubleshooting","icon":"wrench","href":"/api-reference/troubleshooting"}]},{"group":"Endpoints","icon":"braces","pages":[{"group":"Account","pages":[{"title":"Get the account behind a key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/account","href":"/api-reference/endpoints/account/get-the-account-behind-a-key"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/workspaces","href":"/api-reference/endpoints/workspaces/list-workspaces"}]},{"group":"Packages","pages":[{"title":"List packages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages","href":"/api-reference/endpoints/packages/list-packages"},{"title":"Create a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages","href":"/api-reference/endpoints/packages/create-a-package"},{"title":"Launch a package from a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/from-template","href":"/api-reference/endpoints/packages/launch-a-package-from-a-template"},{"title":"Send draft packages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/send","href":"/api-reference/endpoints/packages/send-draft-packages"},{"title":"Count packages by status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/stats","href":"/api-reference/endpoints/packages/count-packages-by-status"},{"title":"Find a package by external id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/by-external-id/{externalId}","href":"/api-reference/endpoints/packages/find-a-package-by-external-id"},{"title":"Get package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}","href":"/api-reference/endpoints/packages/get-package"},{"title":"Edit a draft package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/packages/{packageId}","href":"/api-reference/endpoints/packages/edit-a-draft-package"},{"title":"Delete a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/packages/{packageId}","href":"/api-reference/endpoints/packages/delete-a-package"},{"title":"Act on a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/packages/{packageId}","href":"/api-reference/endpoints/packages/act-on-a-package"},{"title":"List a package's audit events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}/audit-events","href":"/api-reference/endpoints/packages/list-a-packages-audit-events"},{"title":"Duplicate a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/{packageId}/duplicate","href":"/api-reference/endpoints/packages/duplicate-a-package"},{"title":"Attach library documents to a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/{packageId}/library-documents","href":"/api-reference/endpoints/packages/attach-library-documents-to-a-package"},{"title":"Get a preview link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/{packageId}/share-link","href":"/api-reference/endpoints/packages/get-a-preview-link"},{"title":"Get a recipient's signing URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/{packageId}/signing-url","href":"/api-reference/endpoints/packages/get-a-recipients-signing-url"},{"title":"Send a recipient's invitation now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/{packageId}/sessions/{sessionId}/trigger","href":"/api-reference/endpoints/packages/send-a-recipients-invitation-now"},{"title":"List a package's documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}/documents","href":"/api-reference/endpoints/packages/list-a-packages-documents"},{"title":"Add documents to a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/packages/{packageId}/documents","href":"/api-reference/endpoints/packages/add-documents-to-a-package"},{"title":"Get a package document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}/documents/{documentId}","href":"/api-reference/endpoints/packages/get-a-package-document"},{"title":"Remove a document from a package","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/packages/{packageId}/documents/{documentId}","href":"/api-reference/endpoints/packages/remove-a-document-from-a-package"},{"title":"Save a package document's fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/packages/{packageId}/fields","href":"/api-reference/endpoints/packages/save-a-package-documents-fields"},{"title":"Download a package as one PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}/download","href":"/api-reference/endpoints/packages/download-a-package-as-one-pdf"},{"title":"Download a package as a zip","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}/download/zip","href":"/api-reference/endpoints/packages/download-a-package-as-a-zip"},{"title":"Download a package's certificate of completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/packages/{packageId}/download/certificate","href":"/api-reference/endpoints/packages/download-a-packages-certificate-of-completion"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/webhooks","href":"/api-reference/endpoints/webhooks/list-webhook-endpoints"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks","href":"/api-reference/endpoints/webhooks/register-a-webhook-endpoint"},{"title":"Get webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/webhooks/{endpointId}","href":"/api-reference/endpoints/webhooks/get-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/webhooks/{endpointId}","href":"/api-reference/endpoints/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/webhooks/{endpointId}","href":"/api-reference/endpoints/webhooks/update-a-webhook-endpoint"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{endpointId}/rotate-secret","href":"/api-reference/endpoints/webhooks/rotate-a-webhook-signing-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{endpointId}/test","href":"/api-reference/endpoints/webhooks/send-a-test-event"},{"title":"Retry an exhausted delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/{endpointId}/deliveries/{deliveryId}/retry","href":"/api-reference/endpoints/webhooks/retry-an-exhausted-delivery"}]},{"group":"Library","pages":[{"title":"List library documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/library/documents","href":"/api-reference/endpoints/library/list-library-documents"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/templates","href":"/api-reference/endpoints/templates/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/templates","href":"/api-reference/endpoints/templates/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/templates/{templateId}","href":"/api-reference/endpoints/templates/get-a-template"},{"title":"Delete a template","description":"Permanently removes the template; packages launched from it are unaffected. Requires CREATE template access.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/templates/{templateId}","href":"/api-reference/endpoints/templates/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/templates/{templateId}","href":"/api-reference/endpoints/templates/update-a-template"},{"title":"Add documents to a template","description":"Adds documents to a template and returns an upload URL for each file. Requires CREATE template access.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/templates/{templateId}/documents","href":"/api-reference/endpoints/templates/add-documents-to-a-template"},{"title":"Convert a dynamic template document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/templates/{templateId}/documents/{documentId}/convert","href":"/api-reference/endpoints/templates/convert-a-dynamic-template-document"},{"title":"Save a template document's fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/templates/{templateId}/fields","href":"/api-reference/endpoints/templates/save-a-template-documents-fields"}]},{"group":"Custom fields","pages":[{"title":"List custom fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/custom-fields","href":"/api-reference/endpoints/custom-fields/list-custom-fields"}]},{"group":"Signing groups","pages":[{"title":"List signing groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/signing-groups","href":"/api-reference/endpoints/signing-groups/list-signing-groups"},{"title":"Create a signing group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/signing-groups","href":"/api-reference/endpoints/signing-groups/create-a-signing-group"},{"title":"Get a signing group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/signing-groups/{groupId}","href":"/api-reference/endpoints/signing-groups/get-a-signing-group"},{"title":"Delete a signing group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/signing-groups/{groupId}","href":"/api-reference/endpoints/signing-groups/delete-a-signing-group"},{"title":"Update a signing group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/signing-groups/{groupId}","href":"/api-reference/endpoints/signing-groups/update-a-signing-group"},{"title":"List signing group members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/signing-groups/{groupId}/members","href":"/api-reference/endpoints/signing-groups/list-signing-group-members"},{"title":"Add signing group members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/signing-groups/{groupId}/members","href":"/api-reference/endpoints/signing-groups/add-signing-group-members"},{"title":"Remove a signing group member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/signing-groups/{groupId}/members/{userId}","href":"/api-reference/endpoints/signing-groups/remove-a-signing-group-member"}]}]},{"group":"Resources","pages":[{"group":"Support","pages":[{"title":"Contact support","icon":"life-buoy","href":"/support/contact"},{"title":"Report a problem","icon":"bug","href":"/support/report-a-problem"}]},{"group":"Privacy","pages":[{"title":"Privacy","icon":"shield","href":"/privacy/overview"},{"title":"The API and your data","icon":"database","href":"/privacy/api-and-data"}]}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations"}]}]},"basePath":"","title":"Update a template - Flowsign","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-Dlc3Qr3h.js","dist-D2J8knkn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-Dq9TQuNi.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","AssistantPageLink-BgZ2ThuU.js"]}