Modify Status Of A Package

The following guide demonstrates how to modify the status of a package.

If you have sent your package (transaction in the UI) for signing and wish to make some edits, you can do so by changing the status of your package to draft.

The Code

Changing the package status to draft is done using the OneSpan Sign client and passing your PackageId object as a parameter. The PackageId object is returned to you during package creation using the OneSpan Sign client.

EslClient client = new EslClient(api_key, api_url);
client.changePackageStatusToDraft(packageId);

Running Your Code

Once you’ve run your code, if you login to your OneSpan Sign account, you will find your package in the DRAFT tab, as shown in the screenshot below.

Capture

Get the Code

If you have sent your package (transaction in the UI) for signing and wish to make some edits, you can do so by changing the status of your package to draft.

The Code

Changing the package status to draft is done using the OneSpan Sign client and passing your PackageId object as a parameter. The PackageId object is returned to you during package creation using the OneSpan Sign client.

EslClient client = new EslClient(api_key, api_url);
client.ChangePackageStatusToDraft(packageId);

Running Your Code

Once you’ve run your code, if you login to your OneSpan Sign account, you will find your package in the DRAFT tab, as shown in the screenshot below.

Capture

Get the Code

If you have sent your package (transaction in the UI) for signing and wish to make some edits, you can do so by changing the status of your package to draft.

The Code

Changing the package status to draft is done by making the following request:

HTTP Request
PUT /api/packages/{packageId}

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

{
   "status": "DRAFT"
}

For a complete description of each field, take a look at the JSON Properties section below.

The package id is returned to you as a response from eSignLive during package creation.

Running Your Code

Once you’ve run your code, if you login to your eSignLive account, you will find your package in the DRAFT tab, as shown in the screenshot below.

Capture

Get the Code

JSON Properties

Property Type Editable Required Default Sample Value(s)
status string Yes No DRAFT DRAFT / SENT / COMPLETED / ARCHIVED / DECLINED / OPTED_OUT / EXPIRED

If you have sent your package (transaction in the UI) for signing and wish to make some edits, you can do so by changing the status of your package to draft.

The Code

Changing the package status to draft is done using the Apex SDK client and passing your package ID as a parameter. The package ID is returned to you during package creation.

ESignLiveSDK sdk = new ESignLiveSDK();
sdk.setStatus('packageID', ESignLiveAPIObjects.PackageStatus.ARCHIVED); // complete --> archive
sdk.setStatus('packageID', ESignLiveAPIObjects.PackageStatus.COMPLETED); // sent/archive --> completed
sdk.setStatus('packageID', ESignLiveAPIObjects.PackageStatus.DRAFT); // sent --> draft
sdk.setStatus('packageID', ESignLiveAPIObjects.PackageStatus.SENT); // draft --> sent

Similarly, this function can also be used to ARCHIVE and undo archive (COMPLETE) a package.

Running Your Code

Once you’ve run your code, if you login to your OneSpan Sign account, you will find your package in the DRAFT tab, as shown in the screenshot below.

Capture

Get the Code