Change a signer of a task

patch

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

Change a signer of a task.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

A signer can only be replaced if he has not signed or reviewed the task yet. All the settings from the previous signer will be inherited by the new signer.

To confirm whether a member has permission to change a signer of a specific task, please refer to the access_info.forward parameter in the response from the Get a task API.

Allow authentication via Bearer Token or JWT Code.

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

Body Params

Sign task change signer.

task_id

integer

required

Task ID.

stage_id

integer

required

Stage ID.

reason

string

The reason to change signer.

new_signer

object

verify_info

object

Verify information for identity verification, account protection, and quick sign.

Headers

Authorization

string

OAuth2 Bearer token.

Code

string

JWT code for quick sign authentication. Use it instead of the Authorization bearer token to read or sign a task on behalf of a signer who is not a DottedSign member.

The Get the share link API returns a share_link such as https://www.dottedsign.com/task?code=eyJhbGciOiJIUzUxMiJ9....

JWT code is the value of that URL's code query parameter; it is not returned as a separate field in the response.

Quick sign authentication is only available to signers who do not have a DottedSign account. If the signer is a registered DottedSign member, the request is rejected with the login_required (401_030) error and the signer must sign in to read and sign the task, no matter how the quick sign setting is configured.

Responses

200200

400400

401401

403403

404404