Create a task

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

Create a task.

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

When creating a task from a template, only the files will be inherited. All other parameters must be provided in the request body.

📘
Reminder
This action represents a complete task creation process, including all available configurations, which is highly complex. For a simpler and faster way to create a task, please refer Quick create a task.

🚧
Read-Only Template
Please be aware that when using a read-only template, some attributes cannot be overridden, which include:

cc_infos, message, completed_message, references, and completed_references in task_setting

the signer count and sequence in stages

attachment_settings in stages

field_settings in stages (only the default option can be overridden)

review_settings in stages

📑
Uploading Multiple Files
To create a task 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 task with the merged PDF file.

If you choose to start the task after creation, the task will automatically start once the merged PDF file is ready.

scope: sign_tasks.general.write
available user plans: all (template and certain verify_type and field_type restrictions apply)

Body Params

template_id

integer

Template ID. Required if task is created from template.

base64_file

string

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

file_mission_id

integer

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

file_name

string

required

length ≤ 255

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

has_order

boolean

Defaults to true

Signers should sign sequentially or not.

watermark_id

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.

start

boolean

Defaults to false

Start the task after creation or not.

stages

array of objects

required

stages*

task_setting

object

Task setting request body.

Headers

Authorization

string

required

OAuth2 Bearer token.

Responses

Language


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.dottedsign.com/v1/sign_tasks \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "has_order": true,
8
  "start": false,
9
  "task_setting": {
10
    "receiver_lang": "en",
11
    "owner_informable": false
12
  }
13
}
14
'


xxxxxxxxxx
 
1
{
2
  "data": {
3
    "task_id": 60
4
  }
5
}

Create a task

📘
Reminder

🚧
Read-Only Template

📑
Uploading Multiple Files

Content-Type
Content-Length

200200

400400

404404