Creates a template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.
POST
/
createNewTemplate
Create a template (API key auth). Optionally instantiate and send to recipients.
{"docsConfig":{"theme":"mint","$schema":"https://docs.useinkless.com/docs.json","name":"Inkless API docs","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/inkless/DSfu6zFEKFNF7JkJ/logo/logo.png?fit=max\u0026auto=format\u0026n=DSfu6zFEKFNF7JkJ\u0026q=85\u0026s=a1a2ce0d6d978cf88c7c18704673319a","dark":"https://mintcdn.com/inkless/DSfu6zFEKFNF7JkJ/logo/logo.png?fit=max\u0026auto=format\u0026n=DSfu6zFEKFNF7JkJ\u0026q=85\u0026s=a1a2ce0d6d978cf88c7c18704673319a","href":"https://useinkless.com/"},"favicon":"https://mintcdn.com/inkless/DSfu6zFEKFNF7JkJ/favicon.png?fit=max\u0026auto=format\u0026n=DSfu6zFEKFNF7JkJ\u0026q=85\u0026s=9b54289e6eff9050efb294089177ee8a","navbar":{"links":[{"href":"mailto:hello@useinkless.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.useinkless.com"}},"footer":{"socials":{}},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://useinkless.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"inkless","hasAudioNarration":false,"actualSubdomain":"inkless","customDomains":["docs.useinkless.com"],"gitSource":{"type":"github","owner":"with-fluid","repo":"inkless-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92776ce2e4391f29e344f:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Endpoints","count":6},{"language":"default","tag":"API Documentation","count":3},{"language":"default","tag":"Get Started","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/createNewTemplate","slug":"/api-reference/endpoint/createNewTemplate","pageMetadata":{"title":"Create a new template","openapi":"POST /createNewTemplate","description":"Creates a template from an uploaded PDF or DOCX and template fields. If `recipients` are provided, a PDF instance is immediately created from the template and recipient notifications are sent. [See the guide for implementing createNewTemplate](/api-reference/createNewTemplate).","href":"/api-reference/endpoint/createNewTemplate"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a template from an uploaded PDF or DOCX and template fields. If \", _jsx(_components.code, {\n children: \"recipients\"\n }), \" are provided, a PDF instance is immediately created from the template and recipient notifications are sent. \", _jsx(_components.a, {\n href: \"/api-reference/createNewTemplate\",\n children: \"See the guide for implementing createNewTemplate\"\n }), \".\"]\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":"Create a new template","openapi":"POST /createNewTemplate","description":"Creates a template from an uploaded PDF or DOCX and template fields. If `recipients` are provided, a PDF instance is immediately created from the template and recipient notifications are sent. [See the guide for implementing createNewTemplate](/api-reference/createNewTemplate).","href":"/api-reference/endpoint/createNewTemplate"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createNewTemplate","summary":"Create a template (API key auth). Optionally instantiate and send to recipients.","description":"Creates a template from an uploaded PDF or DOCX and template fields. If `recipients` are provided, a PDF instance is immediately created from the template and recipient notifications are sent. [See the guide for implementing createNewTemplate](/api-reference/createNewTemplate).","security":["5ecf5ce0-3c42-4d1d-b425-f17535eb5e9e"],"requestBody":"f9db19d1-6f9f-4e19-bd3a-2fd841881994","responses":{"200":"b344411f-12ef-43f6-8018-1ac9bc03f77a","400":"db998b64-932a-49c5-9495-423b66bf6942","401":"a59480f0-cf1e-4e86-867a-5521c85e909f","500":"ab069f90-ab65-4fde-8d86-c66979e5c1fe"},"method":"post","type":"path","servers":["e9b66e9e-57d3-4db1-9c01-4234de7928ae"],"path":"/createNewTemplate","baseUrlOptions":["https://api.useinkless.com"],"title":"Create a template (API key auth). Optionally instantiate and send to recipients.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["pdf","templateName","fields"],"properties":{"templateName":{"type":"string","description":"Name for the template.","isRequired":true,"uniqueKey":"templateName","typeLabel":"string"},"fields":{"type":"array","description":"Template fields grouped by recipient index. Each inner array corresponds to the fields for a recipient. Sent as JSON within multipart.","items":{"type":"array","items":{"type":"object","required":["id","x","y","page","type","recipient"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].items.[INDEX].id","typeLabel":"string"},"x":{"type":"number","isRequired":true,"uniqueKey":"fields.items.[INDEX].items.[INDEX].x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"fields.items.[INDEX].items.[INDEX].y","typeLabel":"number"},"page":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"fields.items.[INDEX].items.[INDEX].page","typeLabel":"integer"},"type":{"type":"string","description":"Field type (e.g., Signature, Text)","isRequired":true,"uniqueKey":"fields.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"recipient":{"type":"integer","description":"Index of the recipient group this field belongs to.","isRequired":true,"uniqueKey":"fields.items.[INDEX].items.[INDEX].recipient","typeLabel":"integer"}},"example":{"id":"sig-1","x":144,"y":418,"page":1,"type":"Signature","recipient":1},"uniqueKey":"fields.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields.items.[INDEX]","typeLabel":"object[]"},"isRequired":true,"uniqueKey":"fields","typeLabel":"object[][]"},"document":{"type":"string","format":"binary","description":"The template PDF file to upload. Note that you can also upload a DOCX file here but will be converted to a PDF.","uniqueKey":"document","typeLabel":"file"},"emailSubject":{"type":"string","description":"Optional custom subject for the email sent to recipients.","uniqueKey":"emailSubject","typeLabel":"string"},"recipients":{"type":"array","description":"Optional. If provided, immediately creates a document instance and notifies recipients.","items":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"recipients.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"recipients.items.[INDEX].email","typeLabel":"string\u003cemail>"},"phone":{"oneOf":[{"type":"string","uniqueKey":"recipients.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"recipients.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].phone","typeLabel":"string | null"}},"uniqueKey":"recipients.items.[INDEX]","typeLabel":"object"},"uniqueKey":"recipients","typeLabel":"object[]"},"autoReleaseSignatures":{"type":"boolean","description":"Optional. Default false if omitted.","uniqueKey":"autoReleaseSignatures","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"encoding":{"pdf":{"contentType":"application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/msword"},"fields":{"contentType":"application/json"},"recipients":{"contentType":"application/json"}},"examples":{"Example":{"title":"Example","value":{"templateName":"\u003cstring>","fields":[[{"id":"sig-1","x":144,"y":418,"page":1,"type":"Signature","recipient":1}]],"document":"\u003cstring>","emailSubject":"\u003cstring>","recipients":[{"name":"\u003cstring>","email":"jsmith@example.com","phone":"\u003cstring>"}],"autoReleaseSignatures":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b344411f-12ef-43f6-8018-1ac9bc03f77a":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["message","template_id","s3_url","fields"],"properties":{"message":{"type":"string","example":"Template created successfully","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"template_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.template_id","typeLabel":"string\u003cuuid>"},"s3_url":{"type":"string","description":"S3 key/path for the uploaded template PDF.","isRequired":true,"uniqueKey":"oneOf.0.s3_url","typeLabel":"string"},"fields":{"type":"array","items":{"type":"array","items":{"type":"object","required":["id","x","y","page","type","recipient"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX].id","typeLabel":"string"},"x":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX].x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX].y","typeLabel":"number"},"page":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX].page","typeLabel":"integer"},"type":{"type":"string","description":"Field type (e.g., Signature, Text)","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"recipient":{"type":"integer","description":"Index of the recipient group this field belongs to.","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX].recipient","typeLabel":"integer"}},"example":{"id":"sig-1","x":144,"y":418,"page":1,"type":"Signature","recipient":1},"uniqueKey":"oneOf.0.fields.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.fields.items.[INDEX]","typeLabel":"object[]"},"isRequired":true,"uniqueKey":"oneOf.0.fields","typeLabel":"object[][]"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["message","template_id","pdf_id","s3_url","fields","recipients"],"properties":{"message":{"type":"string","example":"Template created and PDF created successfully","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"template_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.template_id","typeLabel":"string\u003cuuid>"},"pdf_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.pdf_id","typeLabel":"string\u003cuuid>"},"s3_url":{"type":"string","description":"S3 key/path for the uploaded template PDF.","isRequired":true,"uniqueKey":"oneOf.1.s3_url","typeLabel":"string"},"fields":{"type":"array","description":"Flattened list of fields with recipient info applied to each field.","items":{"type":"object","required":["id","x","y","page","type","recipient"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].id","typeLabel":"string"},"x":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].y","typeLabel":"number"},"page":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].page","typeLabel":"integer"},"type":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].type","typeLabel":"string"},"recipient":{"type":"object","properties":{"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].recipient.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].recipient.name","typeLabel":"string"}},"required":["email","name"],"isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].recipient","typeLabel":"object"}},"uniqueKey":"oneOf.1.fields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.fields","typeLabel":"object[]"},"recipients":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"oneOf.1.recipients.items.[INDEX]","typeLabel":"string\u003cemail>"},"isRequired":true,"uniqueKey":"oneOf.1.recipients","typeLabel":"string\u003cemail>[]"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"templateOnly":{"title":"templateOnly","value":{"message":"Template created successfully","template_id":"b4e2e25f-3a43-4e6c-9df9-3c6c1a2f13a1","s3_url":"templates/final.pdf","fields":[[{"id":"sig-1","x":144,"y":418,"page":1,"type":"Signature","recipient":1}]]}},"withRecipients":{"title":"withRecipients","value":{"message":"Template created and PDF created successfully","template_id":"b4e2e25f-3a43-4e6c-9df9-3c6c1a2f13a1","pdf_id":"fdb3c602-ef01-43c7-9874-ff096443ff48","s3_url":"templates/final.pdf","fields":[{"id":"sig-1","x":144,"y":418,"page":1,"type":"Signature","recipient":{"email":"michaeluo@gmail.com","name":"michael_api_test"}}],"recipients":["michaeluo@gmail.com"]}}},"exampleType":"examples"}},"exampleType":"examples"},"db998b64-932a-49c5-9495-423b66bf6942":{"description":"Bad request (missing file, invalid fields JSON, missing templateName, invalid recipients)","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingFile":{"title":"missingFile","value":{"message":"No file uploaded."}},"missingName":{"title":"missingName","value":{"message":"Template name is required."}},"invalidFields":{"title":"invalidFields","value":{"message":"Invalid fields data."}},"invalidRecipients":{"title":"invalidRecipients","value":{"message":"Recipients must be an array."}}},"exampleType":"examples"}},"exampleType":"examples"},"a59480f0-cf1e-4e86-867a-5521c85e909f":{"description":"Unauthorized (missing or invalid API key)","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingApiKey":{"title":"missingApiKey","value":{"message":"API key is required."}},"invalidApiKey":{"title":"invalidApiKey","value":{"message":"Invalid or expired API key."}}},"exampleType":"examples"}},"exampleType":"examples"},"ab069f90-ab65-4fde-8d86-c66979e5c1fe":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5ecf5ce0-3c42-4d1d-b425-f17535eb5e9e":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"e9b66e9e-57d3-4db1-9c01-4234de7928ae":{"url":"https://api.useinkless.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"inkless","siteName":"Inkless API docs","title":"Create a new template - Inkless API docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-09T20:26:16.527Z","originalFileLocation":"api-reference/endpoint/createNewTemplate.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 template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Inkless API docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_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/inkless/fL_SSsQKRk8Ta264/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new template - Inkless API docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Inkless API docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://inkless.mintlify.site/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Create+a+new+template\u0026amp;description=Creates+a+template+from+an+uploaded+PDF+or+DOCX+and+template+fields.+If+%60recipients%60+are+provided%2C+a+PDF+instance+is+immediately+created+from+the+template+and+r\u0026amp;theme=9fa4961019155d2a7c7585d9\u0026amp;signature=d7bcd6815b24baa4f13775e886641b5cb1b239210b03d4b6a7f3766d1d5bfd70\">\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=\"Create a new template - Inkless API docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://inkless.mintlify.site/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Create+a+new+template\u0026amp;description=Creates+a+template+from+an+uploaded+PDF+or+DOCX+and+template+fields.+If+%60recipients%60+are+provided%2C+a+PDF+instance+is+immediately+created+from+the+template+and+r\u0026amp;theme=9fa4961019155d2a7c7585d9\u0026amp;signature=d7bcd6815b24baa4f13775e886641b5cb1b239210b03d4b6a7f3766d1d5bfd70\">\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/inkless/fL_SSsQKRk8Ta264/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Inkless API docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/createNewTemplate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useinkless.com/#organization\",\"name\":\"Inkless API docs\",\"url\":\"https://docs.useinkless.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/inkless/DSfu6zFEKFNF7JkJ/logo/logo.png?fit=max\u0026auto=format\u0026n=DSfu6zFEKFNF7JkJ\u0026q=85\u0026s=a1a2ce0d6d978cf88c7c18704673319a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useinkless.com#website\",\"name\":\"Inkless API docs\",\"url\":\"https://docs.useinkless.com\",\"publisher\":{\"@id\":\"https://docs.useinkless.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate#webpage\",\"url\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate\",\"name\":\"Create a new template\",\"description\":\"Creates a template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.\",\"dateModified\":\"2025-08-09T20:26:16.527Z\",\"isPartOf\":{\"@id\":\"https://docs.useinkless.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Inkless API docs\",\"item\":\"https://docs.useinkless.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a new template\",\"item\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate#apireference\",\"headline\":\"Create a new template\",\"name\":\"Create a new template\",\"description\":\"Creates a template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.\",\"url\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useinkless.com/api-reference/endpoint/createNewTemplate#webpage\"},\"dateModified\":\"2025-08-09T20:26:16.527Z\",\"publisher\":{\"@id\":\"https://docs.useinkless.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useinkless.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Inkless API docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Inkless API docs","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://useinkless.com/blog"}]},"tabs":[{"tab":"Guides","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Creating a new template via API","href":"/api-reference/createNewTemplate"},{"title":"Webhooks","description":"How to use webhooks with the e-sign API","href":"/api-reference/webhooks"}]},{"group":"Endpoints","pages":[{"title":"Create a new template","openapi":"POST /createNewTemplate","href":"/api-reference/endpoint/createNewTemplate"},{"title":"Create New Document To Sign From a Template","openapi":"POST /createFromTemplate","description":"Sends a message using a predefined template to one or more recipients. We recommend selecting 'Auto-release signatures when complete' when creating your template on Inkless.","href":"/api-reference/endpoint/create"},{"title":"Get all document details on the account","openapi":"GET /getAllDocuments","href":"/api-reference/endpoint/getAllDocuments"},{"title":"Get document details for one specific document ID","openapi":"GET /getDocumentDetails","href":"/api-reference/endpoint/getDocumentDetails"},{"title":"Register a webhook to get events","openapi":"POST /registerWebhook","href":"/api-reference/endpoint/registerWebhook"},{"title":"Delete a webhook","openapi":"POST /deleteWebhook","href":"/api-reference/endpoint/deleteWebhook"}]}]}]},"basePath":"","title":"Create a new template - Inkless API docs","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}