Changelog
Current Version: 2.9.0 (2025-07-03)
Note on Version Numbers
Blueink's APIv2 uses semantic versioning.
The version number of each release follows the pattern
MAJOR.MINOR.PATCH
.
All releases of APIv2 have the MAJOR version number of 2
.
- Releases with the same
MAJOR
version are backwards compatible. - The
MINOR
version is incremented when new, backwards-compatible functionality is added.- E.g. new optional fields, new endpoints
- The
PATCH
version is incremented when backwards-compatible bug fixes are made.- E.g. bug fixes, improving error messages, correcting unexpected behavior
Blueink is committed to the long-term support of Blueink APIv2 and will continue to support it in a backward-compatible mannerfor the foreseeable future.
2.9.0 (2025-07-03)
- Added support for
signing_complete_redirect
field onPacketRequest
to set a redirect URL on a Packet- This allows customizing the URL that signers are redirected to after completing signing
signing_complete_redirect
can be set when creating a Bundle (POST/bundles/
) or via the update Packet request (PUT/packets/[packetId]/
)
2.8.0 (2025-06-09)
- Limiting delivery for test Bundles (where
is_test
isTrue
) to verified email adresses.- A verified email address is one that is the primary email address for a User on the account, which has also been verified (by clicking a verification link in an email).
- Exceptions available by contacting Blueink support.
2.7.0 (2025-04-25)
- Added support for converting Adobe fields to Blueink fields on an uploaded document
- This allows for the auto-placement of fields based on Adobe form fields
- Added optional
converted_adobe_fields_to
field onDocumentRequest
, which is a signer key that specifies the signer that any converted fields should be assigned to
2.6.0 (2025-04-02)
- Added support for creating a new Bundle from an Envelope Template
- Added new endpoint
POST /bundles/create_from_envelope_template/
- Added new endpoint
2.5.2 (2025-02-26)
- Added
auth_secrets
toPacketRequest
to support secret-based authentication
2.5.1 (2024-12-13)
- Improved error messages when sending Bundles. This affects:
- Errors responses when calling
POST /bundles/{bundleId}/send/
on a Draft Bundle, - Errors returned in the
errors
array when retrieving a Bundle viaGET /bundles/{bundleId}/
- Errors responses when calling
2.5.0 (2024-11-11)
- Added support for Payments when creating Bundles
- Added
payment
field toBundleRequest
- Added
payment
field toBundle
- Added
2.4.1 (2024-09-06)
- Added additional filtering options when listing Bundles (GET /bundles/)
- New querystring parameters:
created_after
/created_before
,sent_after
/sent_before
,completed_after
/completed_before
- New querystring parameters:
- Fixed bug that occurred in some corner cases when creating a Bundle without
initial_values
2.4.0 (2024-08-15)
- Added auto-placement feature to dynamically place fields on a document relative to a text pattern
2.3.0 (2023-05-22)
- Added options to suppress notifications sent to signers.
- The following fields are now supported when creating a Bundle (POST /bundles/) and when updating a Packet (PUT /packets/[packetId]/):
suppress_signing
to suppress the initial signing notificationsuppress_reminder
to suppress reminder notificationssuppress_docs_ready
to suppress "Documents Ready" notificationssuppress_all
to suppress all notifications
2.2.0 (2022-12-28)
- Added support for creating Draft Bundles via APIv2
- Added
is_draft
optional field when creating a Bundle (POST /bundles/) - Added new
/send/
endpoint to send a Draft Bundle (POST /bundles/[bundleId]/send/) - Added new
/validate/
endpoint to validate is a Draft Bundle can be sent (PUT /bundles/[bundleId]/validate/)
- Added
2.1.1 (2022-10-12)
- Added additional checks and better validation messages for Base64 upload errors
2.1.0 (2022-08-30)
- Added support for creating checkbox groups
- Added support for creating / managing webhooks (/webhooks/ endpoints)
2.0.0 (2022-06-12)
- Initial launch of official APIv2
2.0.0-beta.3 (2022-05-02)
- Modifying available error codes for Error objects
2.0.0-beta.2 (2022-04-23)
- Removing DocumentTemplate.account from responses
- Adding DocumentTemplate.is_shared to responses
- Added support for reading / updating person metadata
- Adding
/bundles/{bundleId}/data/
endpoint to retrieve Bundle data
2.0.0-beta (2022-04-04)
- Initial beta release of APIv2