Change the state of a signature request.

post

https://api.woleet.io/v1/signatureRequest/{requestId}/transition

Use this operation to transition a stateful signature request to a new state.

Possible transitions are:

from DRAFT to PENDING: start the signature request: the platform wait for the activation date (if any) and transition to IN_PROGRESS
from PENDING to DRAFT: suspend the signature request: allow it to be updated
from PENDING to CANCELED: cancel the signature request without waiting for the activation date
from IN_PROGRESS to CLOSED: close the signature request without waiting for all signatures to be colleted
from IN_PROGRESS to CANCELED: cancel the signature request before all signatures get colleted

Note that stateless signature requests can only be transitioned to CLOSED, allowing to trigger the generation of the audit trail and the signature attestation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

requestId

string

required

Identifier of the signature request.

Body Params

New state of the signature request.

State of the signature request.

If not set, the signature request is stateless and can be updated at any time (eg. to add new signers on the fly).

If set to 'DRAFT' at creation time, the signature request is stateful and its state can be transitioned using the dedicated endpoint.

Available states:

DRAFT: the signature request is being edited (only DRAFT signature requests can be updated)
PENDING: the signature request is awaiting for its activation date
IN_PROGRESS: the activation date has been reached, the signature request emails have been sent to the signers (if applicable) and the signatures are being collected
COMPLETED: all signatures have been collected
CLOSED: the signature request has been closed by the owner before all signatures could be collected
CANCELED: the signature request has been canceled by the owner before all signatures could be collected
EXPIRED: the deadline of the signature request has been reached before all signatures could be collected

Responses

400

Invalid request. More details are returned in the response body as a JSON object.

403

Forbidden. Invalid transition.

404

Signature request not found.

200The transitioned signature request.