Update a task

Update a task.

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

For this action, you can update a draft task with all available configurations, except for the original task file.

📘

Reminder

This action only updates the tasks in draft status. For tasks in waiting status or if you only need to update settings, please refer to Update task settings.

🚧

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

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

Body Params

Sign task update.

integer

File mission ID returned from the Create a file mission or Renew a file mission API.

integer
required

Task ID.

string
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.

boolean
Defaults to false

Start the task after creation or not.

stages
array of objects
stages
task_setting
object

Task setting request body.

Headers
string
required

OAuth2 Bearer token.

Responses

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