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.
Body
application/json
templateId
string
required
The id of the template to launch.
Minimum string length: 1
Example:
"K7dQm2xPz9Lw"
recipients
object[]
required
One recipient per template role. At least one and at most 100.
Required array length: 1 - 100 elements
Show child attributes
externalId
string
Your own reference for the package, up to 255 characters and unique within the organisation. Repeating it returns the existing package instead of creating another, and sends it when it is still a DRAFT and status is "sent", so a retry after a failed send completes it.
Required string length: 1 - 255
Example:
"crm-deal-48213"
status
enum<string>
default:draft
"draft" leaves the package unsent; "sent" dispatches it to recipients immediately. Defaults to "draft".
Available options:
draft,
sent
Example:
"sent"
scheduledAt
string<date-time>
An ISO 8601 time to send the package automatically. Leaves it SCHEDULED, and cannot be combined with status: "sent".
Example:
"2026-10-01T20:00:00.000Z"
fields
object
Merge field values keyed by merge field key. Each is checked against its field's type and list options, and a bad or missing required value is rejected with 422 under fields.<key>. A blank value takes the field's default. Keys the template does not ask the sender for are rejected under unknownFields.
The sender's answers to the template's workflow questions, keyed by question id. port names the picked answer for a choice question; value carries the typed input for an open one. Omit it when nothing branches: only the default documents are included.
Answers to the questions the template's documents ask, keyed by document id and then question id, so two documents asking a question with the same id are answered apart. They decide which conditional content each document includes. A document question the workflow also asks is answered once, here or in workflowAnswers; giving it two different answers is refused.
Custom field values keyed by custom field key, set over the template's defaults. Every key must be a live custom field that applies to this package. An empty string clears a value. Unknown keys are rejected with 422, and so are missing required values when the package is sent or scheduled.
{"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/launch-a-package-from-a-template","slug":"/api-reference/endpoints/packages/launch-a-package-from-a-template","pageMetadata":{"title":"Launch a package from a template","description":"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.","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","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: \"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.\"\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":"Launch a package from a template","description":"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postPackagesFrom-template","summary":"Launch a package from a template","description":"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.","tags":["Packages"],"parameters":["3c2f184f-d7e1-4c57-b141-ef2760af767a","341236ec-0e66-46f1-a36a-05f0e359fc87"],"requestBody":"a6f19126-4447-4566-be60-88f5095d2825","responses":{"201":"f22f1275-ab90-4a41-9022-27f4dade874c","400":"df8478ca-0eef-4e62-9947-d37067da7ed6","401":"363484d1-f054-422a-8b6d-64eb630567c2","402":"f226772f-7618-4547-8e76-e5211f8fac0e","403":"007f5515-d504-42f5-994d-517add3f6972","404":"0101f497-54d3-47b0-bc8c-89af50dae893","409":"f12c8340-99f0-4f76-a7a9-eb51a11c6878","422":"1febfcd4-104c-4ef4-8c13-a878b5f6f4ca","429":"ab049eb8-0591-4da6-a94d-5740c47363e3"},"method":"post","type":"path","servers":["88b07dc8-099a-4b91-9c83-959cd32a8304"],"security":["833badbd-18f8-4c1a-9f7f-9783e1b26489"],"path":"/api/v1/packages/from-template","baseUrlOptions":["https://my.flowsign.app"],"title":"Launch a package from a template","codeSamples":[],"requestExampleLanguages":["bash","javascript","typescript","node","python","csharp","dotnet","powershell"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.templateId":"K7dQm2xPz9Lw","body.recipients.items.0.role":"Employee","body.recipients.items.0.name":"Jane Ahu","body.recipients.items.0.email":"jane.ahu@example.co.nz","body.externalId":"crm-deal-48213","body.status":"sent","body.scheduledAt":"2026-10-01T20:00:00.000Z","body.fields.employee_name":"Jane Ahu","body.fields.start_date":"2026-10-12","body.fields.salary":"78000","body.workflowAnswers.q_probation.port":"yes","body.workflowAnswers.q_notice_weeks.value.oneOf.1":4,"body.documentAnswers.cmg3k5r1c0003s7p4h2m8tb7k.employment_type":"full_time","body.metadata.cost_centre":"CC-4410","body.metadata.region":"Auckland"}],"urlDisplay":"full"},"dependencies":{"parameters":{"3c2f184f-d7e1-4c57-b141-ef2760af767a":{"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"},"341236ec-0e66-46f1-a36a-05f0e359fc87":{"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":{"templateId":{"type":"string","minLength":1,"description":"The id of the template to launch.","example":"K7dQm2xPz9Lw","isRequired":true,"uniqueKey":"templateId","typeLabel":"string"},"recipients":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","minLength":1,"description":"The name of the template role this person fills. Every role on the template must be filled, and a name the template does not have is rejected with 422.","example":"Employee","isRequired":true,"uniqueKey":"recipients.items.[INDEX].role","typeLabel":"string"},"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, where the invitation is sent.","example":"jane.ahu@example.co.nz","isRequired":true,"uniqueKey":"recipients.items.[INDEX].email","typeLabel":"string\u003cemail>"}},"required":["role","name","email"],"additionalProperties":false,"uniqueKey":"recipients.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":100,"description":"One recipient per template role. At least one and at most 100.","isRequired":true,"uniqueKey":"recipients","typeLabel":"object[]"},"externalId":{"type":"string","minLength":1,"maxLength":255,"description":"Your own reference for the package, up to 255 characters and unique within the organisation. Repeating it returns the existing package instead of creating another, and sends it when it is still a DRAFT and `status` is \"sent\", so a retry after a failed send completes it.","example":"crm-deal-48213","uniqueKey":"externalId","typeLabel":"string"},"status":{"type":"string","enum":["draft","sent"],"default":"draft","description":"\"draft\" leaves the package unsent; \"sent\" dispatches it to recipients immediately. Defaults to \"draft\".","example":"sent","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"scheduledAt":{"type":"string","format":"date-time","description":"An ISO 8601 time to send the package automatically. Leaves it SCHEDULED, and cannot be combined with `status: \"sent\"`.","example":"2026-10-01T20:00:00.000Z","uniqueKey":"scheduledAt","typeLabel":"string\u003cdate-time>"},"fields":{"type":"object","additionalProperties":{"type":"string","description":"The merge field's value. A blank value takes the field's default.","example":"Jane Ahu","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"default":{},"description":"Merge field values keyed by merge field key. Each is checked against its field's type and list options, and a bad or missing required value is rejected with 422 under `fields.\u003ckey>`. A blank value takes the field's default. Keys the template does not ask the sender for are rejected under `unknownFields`.","example":{"employee_name":"Jane Ahu","start_date":"2026-10-12","salary":"78000"},"uniqueKey":"fields","typeLabel":"object"},"workflowAnswers":{"type":"object","additionalProperties":{"type":"object","properties":{"port":{"type":"string","description":"The id of the chosen answer, for a choice question.","example":"yes","uniqueKey":"workflowAnswers.additionalProperties.port","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"The typed answer, text or a number, for an open question.","example":3,"uniqueKey":"workflowAnswers.additionalProperties.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"The typed answer, text or a number, for an open question.","example":3,"uniqueKey":"workflowAnswers.additionalProperties.value.oneOf.1","typeLabel":"number"}],"uniqueKey":"workflowAnswers.additionalProperties.value","typeLabel":"string | number"}},"additionalProperties":false,"uniqueKey":"workflowAnswers.additionalProperties","typeLabel":"object"},"description":"The sender's answers to the template's workflow questions, keyed by question id. `port` names the picked answer for a choice question; `value` carries the typed input for an open one. Omit it when nothing branches: only the default documents are included.","example":{"q_probation":{"port":"yes"},"q_notice_weeks":{"value":4}},"uniqueKey":"workflowAnswers","typeLabel":"object"},"documentAnswers":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string","description":"The chosen answer.","example":"full_time","uniqueKey":"documentAnswers.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"documentAnswers.additionalProperties","typeLabel":"object"},"default":{},"description":"Answers to the questions the template's documents ask, keyed by document id and then question id, so two documents asking a question with the same id are answered apart. They decide which conditional content each document includes. A document question the workflow also asks is answered once, here or in `workflowAnswers`; giving it two different answers is refused.","example":{"cmg3k5r1c0003s7p4h2m8tb7k":{"employment_type":"full_time"}},"uniqueKey":"documentAnswers","typeLabel":"object"},"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`, set over the template's defaults. Every key must be a live custom field that applies to this package. An empty string clears a value. Unknown keys are rejected with 422, and so are missing required values when the package is sent or scheduled.","example":{"cost_centre":"CC-4410","region":"Auckland"},"uniqueKey":"metadata","typeLabel":"object"}},"required":["templateId","recipients"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"templateId":"K7dQm2xPz9Lw","recipients":[{"role":"Employee","name":"Jane Ahu","email":"jane.ahu@example.co.nz"}],"externalId":"crm-deal-48213","status":"sent","scheduledAt":"2026-10-01T20:00:00.000Z","fields":{"employee_name":"Jane Ahu","start_date":"2026-10-12","salary":"78000"},"workflowAnswers":{"q_probation":{"port":"yes"},"q_notice_weeks":{"value":4}},"documentAnswers":{"cmg3k5r1c0003s7p4h2m8tb7k":{"employment_type":"full_time"}},"metadata":{"cost_centre":"CC-4410","region":"Auckland"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f22f1275-ab90-4a41-9022-27f4dade874c":{"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"},"externalId":{"oneOf":[{"type":"string","description":"Your own reference for the package, unique within the organisation. Repeating it returns the existing package instead of creating another.","example":"crm-deal-48213","isRequired":true,"uniqueKey":"data.externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your own reference for the package, unique within the organisation. Repeating it returns the existing package instead of creating another.","example":"crm-deal-48213","isRequired":true,"uniqueKey":"data.externalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.externalId","typeLabel":"string | null"},"status":{"type":"string","description":"The package's status: DRAFT, SCHEDULED when `scheduledAt` was given, IN_PROGRESS when `status` was \"sent\". A package matched on `externalId` returns its current status.","enum":["PREPARING","DRAFT","SCHEDULED","IN_PROGRESS","COMPLETED","DECLINED","ON_HOLD","VOID"],"example":"IN_PROGRESS","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The recipient's id, which library documents map their roles onto.","example":"cmg4v8q2k0002s7xh6k4m1p9c","isRequired":true,"uniqueKey":"data.recipients.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The recipient's name.","example":"Jane Ahu","isRequired":true,"uniqueKey":"data.recipients.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","description":"The recipient's email address.","example":"jane.ahu@example.co.nz","isRequired":true,"uniqueKey":"data.recipients.items.[INDEX].email","typeLabel":"string"},"role":{"oneOf":[{"type":"string","description":"The template role the recipient fills. Null only for a package matched on `externalId` that was not launched from a template.","example":"Employee","isRequired":true,"uniqueKey":"data.recipients.items.[INDEX].role.oneOf.0","typeLabel":"string"},{"type":"null","description":"The template role the recipient fills. Null only for a package matched on `externalId` that was not launched from a template.","example":"Employee","isRequired":true,"uniqueKey":"data.recipients.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.recipients.items.[INDEX].role","typeLabel":"string | null"}},"required":["id","name","email","role"],"uniqueKey":"data.recipients.items.[INDEX]","typeLabel":"object"},"description":"The package's recipients in signing order, with the ids fields and library documents are assigned to.","isRequired":true,"uniqueKey":"data.recipients","typeLabel":"object[]"}},"required":["id","externalId","status","recipients"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"cmg4v8q2k0001s7xh3b9d2f6a","externalId":"crm-deal-48213","status":"IN_PROGRESS","recipients":[{"id":"cmg4v8q2k0002s7xh6k4m1p9c","name":"Jane Ahu","email":"jane.ahu@example.co.nz","role":"Employee"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"df8478ca-0eef-4e62-9947-d37067da7ed6":{"description":"The body is not valid JSON, or `status` is \"sent\" and the template's workflow still has an unanswered sender question","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"},"363484d1-f054-422a-8b6d-64eb630567c2":{"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"},"f226772f-7618-4547-8e76-e5211f8fac0e":{"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"},"007f5515-d504-42f5-994d-517add3f6972":{"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"},"0101f497-54d3-47b0-bc8c-89af50dae893":{"description":"No template with that id that the caller can use","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"},"f12c8340-99f0-4f76-a7a9-eb51a11c6878":{"description":"The template is not ACTIVE (a DRAFT must be published in the app first), the template's workflow cannot run as configured, `status` is \"sent\" and a document's file is missing, or a package the caller cannot see already has this `externalId`","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"},"1febfcd4-104c-4ef4-8c13-a878b5f6f4ca":{"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"},"ab049eb8-0591-4da6-a94d-5740c47363e3":{"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":"Launch a package from a template - Flowsign","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T08:09:34.375Z","originalFileLocation":"api-reference/endpoints/packages/launch-a-package-from-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=\"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.\">\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=\"Launch a package from a template - Flowsign\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.\">\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/launch-a-package-from-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=Packages\u0026amp;title=Launch+a+package+from+a+template\u0026amp;description=Creates+a+package+from+an+ACTIVE+template%2C+mapping+each+recipient+onto+the+role+of+that+name.+Requires+canSendPackages.\u0026amp;theme=58562699d93b4bf7ebdfda8d\u0026amp;signature=d071c089c808cc11d1de694a9e1d3f54e294f3db3871c886174c5b00ab5e6866\">\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=\"Launch a package from a template - Flowsign\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://doc-a97e5290.mintlify.site/_mintlify/api/og/v2?division=Packages\u0026amp;title=Launch+a+package+from+a+template\u0026amp;description=Creates+a+package+from+an+ACTIVE+template%2C+mapping+each+recipient+onto+the+role+of+that+name.+Requires+canSendPackages.\u0026amp;theme=58562699d93b4bf7ebdfda8d\u0026amp;signature=d071c089c808cc11d1de694a9e1d3f54e294f3db3871c886174c5b00ab5e6866\">\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/launch-a-package-from-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/packages/launch-a-package-from-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/packages/launch-a-package-from-a-template#webpage\",\"url\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template\",\"name\":\"Launch a package from a template\",\"description\":\"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.\",\"dateModified\":\"2026-11-10T08:09:34.375Z\",\"isPartOf\":{\"@id\":\"https://docs.flowsign.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-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\":\"Packages\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/packages/list-packages\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Launch a package from a template\",\"item\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template#apireference\",\"headline\":\"Launch a package from a template\",\"name\":\"Launch a package from a template\",\"description\":\"Creates a package from an ACTIVE template, mapping each recipient onto the role of that name. Requires canSendPackages.\",\"url\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template#webpage\"},\"dateModified\":\"2026-11-10T08:09:34.375Z\",\"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/launch-a-package-from-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","description":"Creates a DRAFT package, or a SCHEDULED one when `scheduledAt` is set. Requires canSendPackages.","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","description":"Sends each listed package that is still a draft, one at a time, and reports every id in `results`. Requires canSendPackages.","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","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":"Launch a package from 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"]}