Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Actions

Change the kind of the package

This endpoint is used to "re-trigger", i.e. change the particular kind of the package. Here are the conditions for trigger:\ - For LIVE packages, the status must be LIVE or SCHEDULED - For STANDARD packages, the status must be SENT, and - For IN_PERSON packages, the status must be ACTIVE or PREPARED

post/e-signature-packages/{eSignaturePackageId}/actions/switch-kind

Request body

titlestring

Updated

descriptionstring

Description of the eSignature package

kind'IN_PERSON' | 'LIVE' | 'STANDARD'
orderedSignersboolean

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