Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
ESignature Packages

Update an eSignature package

Update an eSignature package, which must be in DRAFT status.

put/e-signature-packages/{id}

Request body

titlestring

The title of the eSignature package.

descriptionstring

Description of of the eSignature package.

ownerstring

Pactima ID of the owner of the package. Defaults to the id of the requester; when using as Team Integration API Key, the request can specify any team member

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

Determine if signers are ordered, only for STANDARD eSignature kinds

eNotaryPackageIdstring

Submit empty string, i.e. '', to remove eNotary link to this eSignature package

customBrandItemIdstring

ID of the custom brand item to use for the package. Owner must have own the specified the custom brand item.

Response

Returns the object if successfully updated. Returns an error if the update parameters are invalid.

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