API Reference
Quick create a task from template.

For this action, all task files and attributes are directly inherited from the template. Only the parameters specified in the request body will override the attributes in the template.

The scope of parameters that can override includes:

  • parameters under task_setting
  • signer attributes specified in stages parameters
  • the default option specified in stage.field_settings parameters

🚧

Read-Only Template

Please be aware that when using a read-only template, some attributes within task_setting cannot be overridden, which include:

  • cc_infos
  • message
  • completed_message
  • references
  • completed_references

scope: sign_tasks.general.write
available user plans: pro, business, and enterprise

Log in to see full request history
Body Params
string
required
length ≤ 255

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

integer
required

Template ID. Required if task is created from template.

task_setting
object

Task setting request body.

stages
array of objects
required
stages*
boolean
Defaults to false

Start the task after creation or not.

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.

Headers
string
required

OAuth2 Bearer token.

Responses

Response body
object
data
object
integer

Task ID.

Headers
object
string
integer

Language