For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dropbox Sign WebSDKsSign Up
DocumentationAPIChangelog
DocumentationAPIChangelog
  • API Quickstart
  • API Reference
    • Welcome
    • Authentication
    • Account
    • Signature Request
    • Template
      • GETGet Template
      • GETList Templates
      • POSTCreate Template
      • POSTCreate Embedded Template Draft
      • POSTDelete Template
      • GETGet Template Files
      • GETGet Template Files as Data Uri
      • GETGet Template Files as File Url
      • POSTUpdate Template Files
      • POSTAdd User to Template
      • POSTRemove User from Template
    • Bulk Send Job
    • Report
    • Team
    • Unclaimed Draft
    • Embedded
    • API App
    • Fax
    • Fax Line
  • Manual Reference Pages
    • Warnings and Errors
    • Constants
    • Search
    • Premium Branding
    • Expiration
    • Glossary
LogoLogo
Dropbox Sign WebSDKsSign Up
API ReferenceTemplate

Create Template

||View as Markdown|
POST
https://api.hellosign.com/v3/template/create
POST
/v3/template/create
$curl -X POST 'https://api.hellosign.com/v3/template/create' \
>  -u 'YOUR_API_KEY:' \
>  -F 'client_id=YOUR_CLIENT_ID' \
>  -F 'files[0]=@mutual-NDA-example.pdf' \
>  -F 'title=Test Template' \
>  -F 'subject=Please sign this document' \
>  -F 'message=For your approval' \
>  -F 'signer_roles[0][name]=Client' \
>  -F 'signer_roles[0][order]=0' \
>  -F 'signer_roles[0][name]=Witness' \
>  -F 'signer_roles[0][order]=1' \
>  -F 'cc_roles[]=Manager' \
>  -F 'merge_fields[0][name]=Full Name' \
>  -F 'merge_fields[0][type]=text' \
>  -F 'merge_fields[1][name]=Is Registered?' \
>  -F 'merge_fields[1][type]=checkbox' \
>  -F 'field_options[date_format]=DD - MM - YYYY' \
>  -F 'test_mode=1'
1{
2  "template": {
3    "template_id": "f57db65d3f933b5316d398057a36176831451a35",
4    "title": "Mutual NDA",
5    "message": "Please sign this NDA as soon as possible.",
6    "updated_at": 1570471067,
7    "is_creator": true,
8    "is_embedded": false,
9    "can_edit": true,
10    "metadata": {},
11    "is_locked": false,
12    "signer_roles": [
13      {
14        "name": "Outside Vendor",
15        "order": 0
16      },
17      {
18        "name": "Internal Manager",
19        "order": 1
20      }
21    ],
22    "cc_roles": [
23      {
24        "name": "Corporate Attorney"
25      }
26    ],
27    "documents": [
28      {
29        "index": 0,
30        "name": "mutual_nda.pdf",
31        "field_groups": [
32          {
33            "name": "group1",
34            "rule": "require_1-ormore"
35          }
36        ],
37        "form_fields": [
38          {
39            "api_id": "b65e03_10",
40            "name": "DepartmentA",
41            "type": "checkbox",
42            "signer": "1",
43            "x": 117,
44            "y": 19,
45            "width": 15,
46            "height": 15,
47            "required": false,
48            "group": "group1"
49          },
50          {
51            "api_id": "b65e03_11",
52            "name": "DepartmentB",
53            "type": "checkbox",
54            "signer": "2",
55            "x": 118,
56            "y": 41,
57            "width": 15,
58            "height": 15,
59            "required": false,
60            "group": "group1"
61          },
62          {
63            "api_id": "0ec7a7_1",
64            "name": "VendorName",
65            "type": "text",
66            "signer": "1",
67            "x": 160,
68            "y": 141,
69            "width": 80,
70            "height": 30,
71            "required": true,
72            "group": null,
73            "avg_text_length": {
74              "num_lines": 1,
75              "num_chars_per_line": 19
76            },
77            "isMultiline": false,
78            "originalFontSize": 12,
79            "fontFamily": "arial"
80          },
81          {
82            "api_id": "0ec7a7_2",
83            "name": "VendorTitle",
84            "type": "text",
85            "signer": "2",
86            "x": 160,
87            "y": 181,
88            "width": 80,
89            "height": 30,
90            "required": true,
91            "group": null,
92            "avg_text_length": {
93              "num_lines": 1,
94              "num_chars_per_line": 19
95            },
96            "isMultiline": false,
97            "originalFontSize": 12,
98            "fontFamily": "arial"
99          },
100          {
101            "api_id": "0ec7a7_3",
102            "name": "ManagerName",
103            "type": "text",
104            "signer": "2",
105            "x": 160,
106            "y": 221,
107            "width": 80,
108            "height": 30,
109            "required": true,
110            "group": null,
111            "avg_text_length": {
112              "num_lines": 1,
113              "num_chars_per_line": 19
114            },
115            "isMultiline": false,
116            "originalFontSize": 12,
117            "fontFamily": "arial"
118          },
119          {
120            "api_id": "0ec7a7_4",
121            "name": "ManagerTitle",
122            "type": "text",
123            "signer": "2",
124            "x": 160,
125            "y": 251,
126            "width": 80,
127            "height": 30,
128            "required": true,
129            "group": null,
130            "avg_text_length": {
131              "num_lines": 1,
132              "num_chars_per_line": 19
133            },
134            "isMultiline": false,
135            "originalFontSize": 12,
136            "fontFamily": "arial"
137          },
138          {
139            "api_id": "0ec7a7_5",
140            "name": "DateSigned",
141            "type": "date_signed",
142            "signer": "1",
143            "x": 523,
144            "y": 28,
145            "width": 105,
146            "height": 16,
147            "required": true,
148            "group": null
149          }
150        ],
151        "custom_fields": [
152          {
153            "name": "Effective Date",
154            "type": "text",
155            "signer": null,
156            "x": 378,
157            "y": 36,
158            "width": 84,
159            "height": 14,
160            "required": false,
161            "api_id": "78083014-32d8-4b5b-b65e-fe6010f3be64",
162            "group": null,
163            "avg_text_length": {
164              "num_lines": 1,
165              "num_chars_per_line": 22
166            },
167            "isMultiline": false,
168            "originalFontSize": 12,
169            "fontFamily": "arial"
170          }
171        ]
172      }
173    ],
174    "accounts": [
175      {
176        "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
177        "email_address": "me@dropboxsign.com",
178        "is_locked": false,
179        "is_paid_hs": true,
180        "is_paid_hf": false,
181        "quotas": {
182          "templates_left": null,
183          "documents_left": 3600000,
184          "api_signature_requests_left": 0,
185          "sms_verifications_left": 300000
186        }
187      }
188    ]
189  }
190}
Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
Was this page helpful?
Previous

List Templates

Next

Create Embedded Template Draft

Built with

Creates a template that can be used in future signature requests.

If client_id is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new edit_url with /embedded/edit_url/{template_id}.

Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A template_created event indicates the template is ready to use, while a template_error event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.

Authentication

AuthorizationBasic

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. ✅ Supported by Try it console (calls sent in test_mode only).

OR
AuthorizationBearer
You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

Request

This endpoint expects an object.
form_fields_per_documentlist of objectsRequired

The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.)

NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types.

  • Text Field use SubFormFieldsPerDocumentText
  • Dropdown Field use SubFormFieldsPerDocumentDropdown
  • Hyperlink Field use SubFormFieldsPerDocumentHyperlink
  • Checkbox Field use SubFormFieldsPerDocumentCheckbox
  • Radio Field use SubFormFieldsPerDocumentRadio
  • Signature Field use SubFormFieldsPerDocumentSignature
  • Date Signed Field use SubFormFieldsPerDocumentDateSigned
  • Initials Field use SubFormFieldsPerDocumentInitials
  • Text Merge Field use SubFormFieldsPerDocumentTextMerge
  • Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
Variant:
signer_roleslist of objectsRequired
An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
fileslist of stringsOptional

Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

file_urlslist of stringsOptional

Use file_urls[] to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

allow_reassignbooleanOptionalDefaults to false

Allows signers to reassign their signature requests to other signers if set to true. Defaults to false.

NOTE: Only available for Premium plan and higher.

attachmentslist of objectsOptional
A list describing the attachments
cc_roleslist of stringsOptional
The CC roles that must be assigned when using the template to send a signature request
client_idstringOptional
Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
field_optionsobjectOptional
This allows the requester to specify field options for a signature request.
form_field_groupslist of objectsOptional

Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.

form_field_ruleslist of objectsOptional

Conditional Logic rules for fields defined in form_fields_per_document.

merge_fieldslist of objectsOptional

Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the custom_fields parameter. If the signature request using that template does not pass a value into a merge field, then an empty field remains in the document.

messagestringOptional<=5000 characters
The default template email message.
metadatamap from strings to anyOptional

Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer’s order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.

subjectstringOptional<=200 characters

The template title (alias).

test_modebooleanOptionalDefaults to false

Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.

titlestringOptional
The title you want to assign to the SignatureRequest.
use_preexisting_fieldsbooleanOptionalDefaults to false

Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false).

Response headers

X-RateLimit-Limitinteger
The maximum number of requests per hour that you can make.
X-RateLimit-Remaininginteger
The number of requests remaining in the current rate limit window.
X-Ratelimit-Resetinteger
The Unix time at which the rate limit will reset to its maximum.

Response

successful operation
templateobject

Template object with parameters: template_id.

warningslist of objects
A list of warnings.

Errors

4XX
Client Request Error

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See Authentication for more information. ❌ Not supported by Try it console.