OpenSign/docs/docs/API-docs/createtemplate.api.mdx

---
id: createtemplate
title: "Template Creation API"
description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template."
sidebar_label: "Template Creation API"
hide_title: true
hide_table_of_contents: true
api: eJztVt9v4zYM/ld0upddkSbp3T3l6bquKIIVbdCk2ENaDLLNxGplyZPk/FiQ/32kbCeOkxsaYI/rFT2bpEjqI/nRG+7F3PHBlHvIciU8OP7a4Qm42MrcS6P5gE9SYJNKzW4sCJKz69GQCaXM0rHCgXXMGxaTElhcOG8y+beIFLCd4w5bpjJOGRovgAnHIlVAbqX2js2MZXPQYNG3nrPExEUGpFhKn7LcQgIzqSFhztsi9oUF12XPOabhijgG52aF2kUq08AcO8xj6pSoBTyjHROs0PKvAtjFRW09TC4u0E54FgvNIqDbJHSZKh9oZBMJ0mFU8utyiOVMknHlqss73OThEkYPE4SuBKTWo9oCRnf+V5Os+WDDY6M9eqZHkedKxuFo780R8Bvu4hQyQU9+nQP6M9EbxB795JYCeYn1Qu2DyKBhhSAhimiFsGbCNyWwEphLMAoPu9z5tsMfjD/bzUgBgoIALyQsmdBYIjkngKTbAUe+f2u21HkhdnVttiW6fH66P9dV6n3uBr3e2hRWZmIO3dhk5IuSxiZu+BPWinXz8JS/Gfgxz4RU4VQH31PdEODgrDJFLnSox85phy8tlhewI7B9AcNJvJM7lfw+VQpWvVXhTjtHb156dSDaEgoqAUtNeB5CqzcXias7sRoFN4cxW+3cCN3WbOkwTimOqCt79Gu/T/+1qOVgZGm+d+Os1p8wsf9oQGKTNDsbOQfmYJtQoOjb13CjYNIGDRUZ5oUdc0J3hNPnz8hXolD+GKL6xk8VNhVU3/vfj9EZ6oVQMgkMNjHvoD+FWBn41BC75MaFqwqf4lvviGwC01JTTze8sKrR/4hlF/HR1DFKRI46DIWyt7ji21c6GeOA+PWY8C0hRO2f77BuTkgufwcakerWq0uUXHpKFIWSbpCCwC4MWVPJnvbsd1t3XM1eR4RU89HHKKbFMKdJo+KMn9BAgwU+Muv7CTsYGrr5zASYqsI/ItBjypjqiAAf71e8CP6Sur5PuWNpLbZOH+4gUpL8W/eq3kflhHTZi37RY5OFfUbbUUn97gYv+pJNH2doJoVif0DkkIpef6kBWS6XR33xJZy5w0VcRFiE3OzN50EYmqd5avfyBe/qwWbucTbGXpRxzcE/CdULxr1q7kUc5h4IdJqfUvSjfYggR2IAGqb9CF7fje4Rlj762rf+B1Lu3Q9vbh/Gt+SVhqcs0VW3j65QRCOXCd0IdPLLqF3jxqb//3PqnM+pimo8rHwPhTIs/lDQTcV70/buwdFMiRhRs9lQiGertlsSY6YWCWyKjwthJeFJb+ix4ikiysBx/KYs1+WE4pM5ghsor7WDtp36xDUCl/t/tX1tcPfocTxB46j6EMzCguJWLOkjEf8O+Av+Cx+U5CFQcJBvuBJ6XoRNxEu/9PMPphMdww==
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1
  className={"openapi__heading"}
>
  Template Creation API
</h1>

<MethodEndpoint
  method={"post"}
  path={"/createtemplate"}
>
  
</MethodEndpoint>



The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.

## Request

<MimeTabs
  className={"openapi-tabs__mime"}
>
  <TabItem
    label={"application/json"}
    value={"application/json-schema"}
  >
    <details
      style={{}}
      className={"openapi-markdown__details mime"}
      data-collapsed={false}
      open={true}
    >
      <summary
        style={{}}
        className={"openapi-markdown__details-summary-mime"}
      >
        <h3
          className={"openapi-markdown__details-summary-header-body"}
        >
          Body
        </h3>
      </summary><div
        style={{"textAlign":"left","marginLeft":"1rem"}}
      >
        
      </div><ul
        style={{"marginLeft":"1rem"}}
      >
        <SchemaItem
          collapsible={false}
          name={"Name"}
          required={false}
          schemaName={"string"}
          qualifierMessage={undefined}
          schema={{"type":"string","format":"string","example":"sample template"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"Note"}
          required={false}
          schemaName={"string"}
          qualifierMessage={undefined}
          schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"Description"}
          required={false}
          schemaName={"string"}
          qualifierMessage={undefined}
          schema={{"type":"string","format":"string","example":"template description"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"URL"}
          required={false}
          schemaName={"string"}
          qualifierMessage={undefined}
          schema={{"type":"string","format":"string","example":"https://yourimage.com"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"signers"}
          required={false}
          schemaName={"signers[]"}
          qualifierMessage={undefined}
          schema={{"type":"array","example":["joe@gmail.com","john@gmail.com"],"xml":{"name":"signers","wrapped":true},"items":{"type":"string","example":"joe@example.com","xml":{"name":"signers"},"title":"signers"}}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"folderId"}
          required={false}
          schemaName={"string"}
          qualifierMessage={undefined}
          schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
        >
          
        </SchemaItem>
      </ul>
    </details>
  </TabItem>
</MimeTabs><div>
  <div>
    <ApiTabs>
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          Template created successfully!
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"int32"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","format":"int32"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"type"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"message"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"code\": 0,\n  \"type\": \"string\",\n  \"message\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"404"}
        value={"404"}
      >
        <div>
          
          
          Invalid API Token!
          
          
        </div><div>
          
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>