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
packageId
string
required
Body
application/json
title
string
The package's title, shown to recipients.
Minimum string length: 1
Example:
"Employment agreement for Jane Ahu"
description
string
A description of the package. An empty string clears it.
Example:
"Jane's signed agreement ahead of her 12 October start."
signingMode
enum<string>
How recipients are walked through signing. WORKFLOW is a 422 unless the draft already has a workflow, since a workflow is drawn in the app or comes from a template. A recipient's delay is only kept while this is SEQUENTIAL.
Available options:
PARALLEL,
SEQUENTIAL,
WORKFLOW
Example:
"SEQUENTIAL"
emailSubject
string
The subject line of the invitation email. An empty string restores the default.
Example:
"Please sign your employment agreement"
emailMessage
string
A message from the sender included in the invitation email.
Example:
"Kia ora Jane, please review and sign before your start date. Tom"
recipients
object[]
Replaces the recipients, in signing order. Carry a recipient's id to keep them and the fields assigned to them; a recipient left out is removed along with their fields' assignment. An id the package does not have is a 422.
Required array length: 1 - 100 elements
Show child attributes
accessCode
string | null
A password every signing recipient must enter before signing, 4 to 64 characters. Null removes it; leaving it out keeps the current one.
Required string length: 4 - 64
Example:
"harbour-4821"
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
tags
string[]
Replaces the package's tags. Tags the organisation does not have yet are created.
Minimum string length: 1
Example:
["HR", "Onboarding"]
metadata
object
Custom field values keyed by custom field key, merged over the current values. Every key must be a live custom field that applies to this package; an unknown key is a 422. An empty string clears a value.
Values for the package's merge fields, keyed by merge field key. Each is checked against the field's type and list options, and a bad value is a 422.
Show child attributes
Example:
{ "start_date": "2026-10-12" }
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/packages/edit-a-draft-package","slug":"/api-reference/endpoints/packages/edit-a-draft-package","pageMetadata":{"title":"Edit a draft package","description":"Changes a DRAFT package's details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/packages/{packageId}","href":"/api-reference/endpoints/packages/edit-a-draft-package","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: \"Changes a DRAFT package’s details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.\"\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":"Edit a draft package","description":"Changes a DRAFT package's details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/packages/{packageId}","href":"/api-reference/endpoints/packages/edit-a-draft-package","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"putPackagesByPackageId","summary":"Edit a draft package","description":"Changes a DRAFT package's details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.","tags":["Packages"],"parameters":["4b239516-9d89-44df-b25b-d340a9f62bbb","88961c14-609f-4df3-b5ed-0e87bba0fb90","bb3596b8-baf4-44c4-af0c-4370549b82ec"],"requestBody":"db1bf871-a306-4553-adb2-84994926e6f4","responses":{"200":"315c036a-6c4c-4029-b300-8453283a9e4a","400":"90444338-d5b5-4dcd-bb6f-5b424cd6cfe8","401":"c9a47b85-4034-48ca-943e-2a34b172a5c0","402":"9f12b577-de62-45a6-bf44-860066b423b2","403":"2e9a622e-9254-4c72-96eb-f808f6034d91","404":"cf71ad0a-d0c9-47de-9134-12f19760bb00","409":"ebf29f58-78a5-4bc7-87ca-6f6c4df3b5af","422":"02ea7ae1-0bcf-4edb-a672-0e7463caf689","429":"8a30c9ee-0f40-41bf-b8e4-7ee9d716b50d"},"method":"put","type":"path","servers":["88b07dc8-099a-4b91-9c83-959cd32a8304"],"security":["833badbd-18f8-4c1a-9f7f-9783e1b26489"],"path":"/api/v1/packages/{packageId}","baseUrlOptions":["https://my.flowsign.app"],"title":"Edit a draft package","codeSamples":[],"requestExampleLanguages":["bash","javascript","typescript","node","python","csharp","dotnet","powershell"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.title":"Employment agreement for Jane Ahu","body.description":"Jane's signed agreement ahead of her 12 October start.","body.signingMode":"SEQUENTIAL","body.emailSubject":"Please sign your employment agreement","body.emailMessage":"Kia ora Jane, please review and sign before your start date. Tom","body.recipients.items.0.name":"Jane Ahu","body.recipients.items.0.email":"jane.ahu@example.co.nz","body.recipients.items.0.actionType":"SIGNER","body.recipients.items.0.delivery":"EMAIL","body.recipients.items.0.hostRole":"SENDER","body.recipients.items.0.hostUserIds.items.0":"8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f","body.recipients.items.0.hostGroupIds.items.0":"cmg1hd3x10002v8p9f6r8bt4n","body.recipients.items.0.delay":60,"body.recipients.items.0.id":"cmg4v8q2k0002s7xh6k4m1p9c","body.accessCode.oneOf.0":"harbour-4821","body.reminderIntervalDays.oneOf.0":3,"body.expirationDays.oneOf.0":30,"body.expiryWarningDays.oneOf.0":5,"body.tags.items.0":"HR","body.tags.items.1":"Onboarding","body.metadata.cost_centre":"CC-4410","body.metadata.region":"Auckland","body.mergeValues.start_date":"2026-10-12"}],"urlDisplay":"full"},"dependencies":{"parameters":{"4b239516-9d89-44df-b25b-d340a9f62bbb":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"packageId","in":"path"},"88961c14-609f-4df3-b5ed-0e87bba0fb90":{"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"},"bb3596b8-baf4-44c4-af0c-4370549b82ec":{"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":{"title":{"type":"string","minLength":1,"description":"The package's title, shown to recipients.","example":"Employment agreement for Jane Ahu","uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","description":"A description of the package. An empty string clears it.","example":"Jane's signed agreement ahead of her 12 October start.","uniqueKey":"description","typeLabel":"string"},"signingMode":{"type":"string","description":"How recipients are walked through signing. WORKFLOW is a 422 unless the draft already has a workflow, since a workflow is drawn in the app or comes from a template. A recipient's `delay` is only kept while this is SEQUENTIAL.","enum":["PARALLEL","SEQUENTIAL","WORKFLOW"],"example":"SEQUENTIAL","uniqueKey":"signingMode","typeLabel":"enum\u003cstring>"},"emailSubject":{"type":"string","description":"The subject line of the invitation email. An empty string restores the default.","example":"Please sign your employment agreement","uniqueKey":"emailSubject","typeLabel":"string"},"emailMessage":{"type":"string","description":"A message from the sender included in the invitation email.","example":"Kia ora Jane, please review and sign before your start date. Tom","uniqueKey":"emailMessage","typeLabel":"string"},"recipients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The recipient's name.","example":"Jane Ahu","isRequired":true,"uniqueKey":"recipients.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"The recipient's email address. Required unless `delivery` is IN_PERSON.","example":"jane.ahu@example.co.nz","uniqueKey":"recipients.items.[INDEX].email","typeLabel":"string\u003cemail>"},"actionType":{"type":"string","enum":["SIGNER","VIEWER","CC"],"description":"What the recipient 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.","example":"SIGNER","uniqueKey":"recipients.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"delivery":{"type":"string","enum":["EMAIL","IN_PERSON"],"description":"How the recipient receives the package. EMAIL sends them an invitation; IN_PERSON sends no email, and a host opens the session and hands the device over.","example":"EMAIL","uniqueKey":"recipients.items.[INDEX].delivery","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":"recipients.items.[INDEX].hostRole","typeLabel":"enum\u003cstring>"},"hostUserIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"recipients.items.[INDEX].hostUserIds.items.[INDEX]","typeLabel":"string"},"maxItems":5,"description":"The members who may host, when `hostRole` is SPECIFIC_USER. Up to 5.","example":["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],"uniqueKey":"recipients.items.[INDEX].hostUserIds","typeLabel":"string[]"},"hostGroupIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"recipients.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":"recipients.items.[INDEX].hostGroupIds","typeLabel":"string[]"},"delay":{"type":"integer","minimum":0,"description":"Minutes to wait after this recipient's turn begins before their invitation is sent. Only accepted when `signingMode` is SEQUENTIAL.","example":60,"uniqueKey":"recipients.items.[INDEX].delay","typeLabel":"integer"},"id":{"type":"string","minLength":1,"description":"The id of a recipient the package already has, to keep them (and the fields assigned to them) while changing their details. Leave it out for a new recipient; details a kept recipient leaves out keep their current value.","example":"cmg4v8q2k0002s7xh6k4m1p9c","uniqueKey":"recipients.items.[INDEX].id","typeLabel":"string"}},"required":["name"],"description":"A person the package goes to, as sent when editing a draft.","uniqueKey":"recipients.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":100,"description":"Replaces the recipients, in signing order. Carry a recipient's `id` to keep them and the fields assigned to them; a recipient left out is removed along with their fields' assignment. An `id` the package does not have is a 422.","uniqueKey":"recipients","typeLabel":"object[]"},"accessCode":{"oneOf":[{"type":"string","minLength":4,"maxLength":64,"description":"A password every signing recipient must enter before signing, 4 to 64 characters. Null removes it; leaving it out keeps the current one.","example":"harbour-4821","uniqueKey":"accessCode.oneOf.0","typeLabel":"string"},{"type":"null","minLength":4,"maxLength":64,"description":"A password every signing recipient must enter before signing, 4 to 64 characters. Null removes it; leaving it out keeps the current one.","example":"harbour-4821","uniqueKey":"accessCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessCode","typeLabel":"string | null"},"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"},"tags":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Replaces the package's tags. Tags the organisation does not have yet are created.","example":["HR","Onboarding"],"uniqueKey":"tags","typeLabel":"string[]"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500,"description":"A custom field value of up to 500 characters. An empty string clears the value.","example":"CC-4410","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Custom field values keyed by custom field `key`, merged over the current values. Every key must be a live custom field that applies to this package; an unknown key is a 422. An empty string clears a value.","example":{"cost_centre":"CC-4410","region":"Auckland"},"uniqueKey":"metadata","typeLabel":"object"},"mergeValues":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"mergeValues.additionalProperties","typeLabel":"string"},"description":"Values for the package's merge fields, keyed by merge field key. Each is checked against the field's type and list options, and a bad value is a 422.","example":{"start_date":"2026-10-12"},"uniqueKey":"mergeValues","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Employment agreement for Jane Ahu","description":"Jane's signed agreement ahead of her 12 October start.","signingMode":"SEQUENTIAL","emailSubject":"Please sign your employment agreement","emailMessage":"Kia ora Jane, please review and sign before your start date. Tom","recipients":[{"name":"Jane Ahu","email":"jane.ahu@example.co.nz","actionType":"SIGNER","delivery":"EMAIL","hostRole":"SENDER","hostUserIds":["8f1c2a4e-6b3d-4c9a-9e7f-2d5b1a3c4e6f"],"hostGroupIds":["cmg1hd3x10002v8p9f6r8bt4n"],"delay":60,"id":"cmg4v8q2k0002s7xh6k4m1p9c"}],"accessCode":"harbour-4821","reminderIntervalDays":3,"expirationDays":30,"expiryWarningDays":5,"tags":["HR","Onboarding"],"metadata":{"cost_centre":"CC-4410","region":"Auckland"},"mergeValues":{"start_date":"2026-10-12"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"315c036a-6c4c-4029-b300-8453283a9e4a":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The package's id.","example":"cmg4v8q2k0001s7xh3b9d2f6a","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.warnings.items.[INDEX]","typeLabel":"string"},"description":"Parts of the package's workflow that no longer apply after the change and were dropped, such as a card naming a removed recipient. Empty when nothing was dropped.","example":[],"isRequired":true,"uniqueKey":"data.warnings","typeLabel":"string[]"}},"required":["id","warnings"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"cmg4v8q2k0001s7xh3b9d2f6a","warnings":[]}}}},"exampleType":"generated"}},"exampleType":"generated"},"90444338-d5b5-4dcd-bb6f-5b424cd6cfe8":{"description":"The body is not valid JSON, a host is not a member who may host, or the recipient count is over the plan's limit","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"},"c9a47b85-4034-48ca-943e-2a34b172a5c0":{"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"},"9f12b577-de62-45a6-bf44-860066b423b2":{"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"},"2e9a622e-9254-4c72-96eb-f808f6034d91":{"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"},"cf71ad0a-d0c9-47de-9134-12f19760bb00":{"description":"No package with that id that the caller can edit","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"},"ebf29f58-78a5-4bc7-87ca-6f6c4df3b5af":{"description":"The package is not a DRAFT, or another member is editing it in the app right now","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"},"02ea7ae1-0bcf-4edb-a672-0e7463caf689":{"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"},"8a30c9ee-0f40-41bf-b8e4-7ee9d716b50d":{"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":"Edit a draft package - Flowsign","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T08:09:34.454Z","originalFileLocation":"api-reference/endpoints/packages/edit-a-draft-package.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=\"Changes a DRAFT package\u0026#x27;s details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.\">\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=\"Edit a draft package - Flowsign\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes a DRAFT package\u0026#x27;s details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.\">\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/packages/edit-a-draft-package\">\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=Packages\u0026amp;title=Edit+a+draft+package\u0026amp;description=Changes+a+DRAFT+package%27s+details%2C+keeping+the+current+value+of+any+field+left+out.+Requires+canSendPackages+and+edit+access+to+the+draft.\u0026amp;theme=58562699d93b4bf7ebdfda8d\u0026amp;signature=1d1ca4476973ea7f00e964bae3ad8032a0c391df573d15ba2439e30ceebfe3f5\">\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=\"Edit a draft package - Flowsign\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes a DRAFT package\u0026#x27;s details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://doc-a97e5290.mintlify.site/_mintlify/api/og/v2?division=Packages\u0026amp;title=Edit+a+draft+package\u0026amp;description=Changes+a+DRAFT+package%27s+details%2C+keeping+the+current+value+of+any+field+left+out.+Requires+canSendPackages+and+edit+access+to+the+draft.\u0026amp;theme=58562699d93b4bf7ebdfda8d\u0026amp;signature=1d1ca4476973ea7f00e964bae3ad8032a0c391df573d15ba2439e30ceebfe3f5\">\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/packages/edit-a-draft-package\">\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/packages/edit-a-draft-package.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/packages/edit-a-draft-package#webpage\",\"url\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package\",\"name\":\"Edit a draft package\",\"description\":\"Changes a DRAFT package's details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.\",\"dateModified\":\"2026-11-10T08:09:34.454Z\",\"isPartOf\":{\"@id\":\"https://docs.flowsign.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package#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\":\"Packages\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/packages/list-packages\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Edit a draft package\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package#apireference\",\"headline\":\"Edit a draft package\",\"name\":\"Edit a draft package\",\"description\":\"Changes a DRAFT package's details, keeping the current value of any field left out. Requires canSendPackages and edit access to the draft.\",\"url\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/edit-a-draft-package#webpage\"},\"dateModified\":\"2026-11-10T08:09:34.454Z\",\"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/packages/edit-a-draft-package.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","description":"Returns the package with its recipients, documents, signing sessions, custom field values and newest 100 audit events.","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","description":"Permanently deletes the package and its documents. Requires canDeletePackages.","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","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","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":"Edit a draft package - 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"]}