HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions


## Updating a Package

You can use the [PATCH /packages/:id](🔗) to update an existing package.

#### Cancel a Package

You can use the PATCH API to update the package status to `CANCELLED`. This will remove any open tasks for the recipients. A package can be cancelled at any time.

#### Mark a Package as Papered Out

You can use the PATCH API to set a `paperedAt` date for a package. This will not cancel the package. The package will still remain available for the borrower in their Blend follow-ups list, providing them the option to complete it electronically.

#### Change or Set the Due Date

For packages of type `DOCUMENT_PACKAGE` you can change the `dueDate`. This field simply shows the recipient when the task should be completed. There is no logic behind this field.

## Track Package Status

### Status Breakdown

There are three levels of statuses to pay attention to.

#### Package

The package's status is derived from the status of it's envelopes.

Column Title
Column Title
CreatedThe package has been issued but no borrowers have provided e-consent.
DeliveredThe package has been issued in Blend and a borrower has e-consented.
ViewedA borrower has viewed the package.
SignedA borrower has signed the package. This is only applicable if an envelope on the package requires signatures.
CompletedAll recipients have completed all their actions.
DeclinedA recipient has declined the package.
CancelledThe package has been cancelled by the lender.
Failed to CreateThe package was never issued due to an error.

#### Envelope

The envelope's status is derived from the status of it's recipients.

Column Title
Column Title
Has Not ViewedNo borrower has viewed the envelope.
ViewedA borrower has viewed the envelope.
SignedA borrower has signed the envelope. This is only applicable if the envelope requires signatures.
CompletedAll recipients have completed all their actions.
DeclinedA recipient has declined the envelope.

#### Envelope Recipient

Column Title
Column Title
Has Not ViewedThe recipient has not viewed the envelope.
ViewedThe recipient has viewed the envelope.
SignedThe recipient has signed the envelope. This is only applicable if the envelope requires signatures.
DeclinedThe recipient has declined the envelope.

### Events

Blend offers events to keep you up to date on the latest status of your package. Please see the [Package Events](🔗) for details.

### APIs

You can use the [GET /packages/:id](🔗) to get all the status information for a package. You can also use [GET /packages](🔗) to get all the packages for a given application.

## Metadata in GET /packages

For each different kind of envelope created for a package, the contents of the `metadata` in the envelope will follow a different schema. The schema for this metadata is based on the `providerType`.

#### ESIGN

E-sign envelopes contain documents that need to be electronically viewed and signed through Blend's esign provider.

In order to create an envelope of this type, document IDs and their corresponding tabs are expected to passed in via https://developers.blend.com/blend/reference#post-a-package. That information will be store in the `metadata` field and then can be retrieved via GET requests (https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package).



#### Wetsign

Wet-sign envelopes contain documents that recipients need to physically sign and then re-upload.

Similar to other envelopes, the WETSIGN envelope contains metadata created via https://developers.blend.com/blend/reference#post-a-package and can be retrieved via GET requests (https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package)



#### Review

Review envelopes contain documents for recipients where recipients need to only view electronically.

Similar to other envelopes, the REVIEW envelope contains metadata created via https://developers.blend.com/blend/reference#post-a-package and can be retrieved via GET requests (https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package)