API Reference

Create a template

post
https://api.dottedsign.com/v1/templates

Create a template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

For this action, you can create a template either from a base64 encoded file, a file mission.

📑

Uploading Multiple Files

To create a template from multiple PDF files, please note the following points:

  • Create a file mission first to merge multiple PDF files into one PDF file and get the file_mission_id.
  • Use the file_mission_id to create a template with the merged PDF file.

scope: templates.general.write
available user plans: all

Body Params

Template create.

string

Base64 string of PDF file. Required if task is created from file.

integer

File mission ID returned from the Create a file mission API. Required if task is created from multiple files.

string
required
length ≤ 255

File name.
File name should match the pattern ^(?!.*[\"*:<>\?\/\\|~#%&{}])[^.].*$.

boolean
Defaults to true

Signers should sign sequentially or not.

integer

Watermark ID.
Currently, this only supports the use of watermark_id that have been used in a template.

metadata
object

Metadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

stages
array of objects
required
stages*
template_setting
object

Template setting request body.

Headers
string
required

OAuth2 Bearer token.

Responses

Updated 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago