Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Actions

Trigger a DRAFT eSignature package for signing

Once an eSignature package have been fully drafted, it has to be triggered to start the signing. For STANDARD eSignature packages, move to SENT; LIVE eSignature packages move to SCHEDULED; and IN_PERSON move to PREPARED.

post/e-signature-packages/{eSignaturePackageId}/actions/trigger

Request body

titlestring

Title of the eSignature package, if provided, will update current title

descriptionstring

Description of the eSignature package, if provided, will update current description

onBehalfOfstring

Public id of the teammate that this is triggered for. This user will be the new owner of the package

Response

Returns the eSignature package object if the action was successfully performed.

idstring required
isTestModeboolean
titlestring required
descriptionstring
orderedSignersboolean

Signers are sent by order

status'ACTIVE' | 'CANCELLED' | 'COMPLETED' | 'DECLINED' | 'DRAFT' | 'LIVE' | 'LIVE_EDITING' | 'PREPARED' | 'PROCESSING' | 'SENT' | 'SCHEDULING' | 'SCHEDULED' | 'LOCKED_FOR_REVIEW'
kind'IN_PERSON' | 'LIVE' | 'STANDARD'
recordedLiveESignatureboolean
packageFolderIdstring

Package folder that the esp is part of

eNotaryPackageIdstring

Id of the applicable eNotaryPackage

customBrandItemIdstring

Id of the applicable custom brand item to apply to this eSignature package