Skip to main content
View Markdown

Changelog

Current Version: 2.22.0 (2026-10-26)

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 manner for the foreseeable future.

2.22.0 October 26, 2026​

New

  • Added optional allow_add_signers on POST /bundles/preparation_session/. Defaults to true. Set to false to hide Add Signer and Add Recipient and reject a new top-level packet in the embedded signer step. Adding a member to an existing signer group is still allowed.
  • Added optional allow_decline_to_sign on POST /bundles/, POST /bundles/create_from_envelope_template/, and PATCH /bundles/{bundleSlug}/. When false, signers cannot decline to sign. On POST /bundles/, omitting the field copies the team envelope default when that default is applied to new Bundles, otherwise the account envelope default when that default is applied, otherwise true. On create-from-envelope-template, omitting the field copies the envelope template's value. On PATCH, omitting the field leaves the current value unchanged.
  • Added webhook event types packet_sent and bundle_expired.

2.21.0 October 16, 2026​

New

  • Added optional send_button on POST /bundles/preparation_session/ to customize the embedded preparation Send button label (text, up to 30 characters; a blank or whitespace-only value is rejected) and colors (color, background_color as #RRGGBB). Omit the object, pass null, or omit text to keep the default green "Send" button. The dashboard Send button is not affected.

2.20.0 September 18, 2026​

New

  • Added webhook event types doc_template_created, doc_template_updated, and doc_template_deleted. Each event payload includes template_id.
  • Added DELETE /templates/{templateId}/ to soft-delete a Document Template (returns 204). The template is disabled and removed from account libraries, but remains retrievable by ID. Returns 403 for globally shared templates.
  • Added optional allowed_data_flow_tags on POST /templates/preparation_session/. Entries are exact tag names or namespace-prefix patterns such as acme:*. An empty list allows no tags; omit the field to leave the session unfiltered.

Documentation Updates

  • Recorded bundle_signer_reassigned on the Webhooks page (shipped with 2.18.0; previously omitted from the event-type list).
  • Documented the template_id payload for Document Template webhook events, and included those events (plus bundle_signer_reassigned and packet_declined) on the webhook list filters.

2.19.0 September 11, 2026​

New

  • Added max_reminders (read-only) on Bundle — the maximum number of automated reminder emails allowed per packet for the account, or null when unlimited.
  • Added adobe_field_assignments on DocumentRequest to assign converted Adobe fields to specific signers by exact PDF field name.
  • Added owner_name and owner_email (read-only) on Bundle — the name and email of the Bundle owner (empty string when unset).

2.18.2 August 21, 2026​

Updates

  • PATCH /bundles/{bundleSlug}/ emits additional bundle_modified audit events for post-send configuration changes. These appear in the dashboard / event log and are excluded from the Certificate of Evidence. No new request or response fields; no new webhook event type.

Documentation Updates

  • Recorded that packet_declined webhook payloads include bundle_status (shipped with 2.18.0; previously omitted from this changelog).

2.18.1 August 4, 2026​

Fixes

  • PATCH /bundles/{bundleSlug}/ now returns 400 instead of 500 when the expires value cannot be parsed.
  • PATCH /bundles/{bundleSlug}/ now validates that the resulting expiration datetime is in the future when updating an in-progress (Sent) Bundle.

Documentation Updates

  • Corrected SDK code samples for add/remove tags, retrieve Packet, embedded signing URL, and envelope templates; restored the generateInterimFiles hash redirect to Get Bundle Files.

2.18.0 July 21, 2026​

New

  • Added Stamp field support (kind: stp) for capturing stamp images on documents. Talk to Blueink Support if this feature is not active on your account.
  • Added bundle_status to the packet_declined webhook payload.
  • Added allow_signer_reassign and allow_chained_signer_reassign on Bundle (settable via PATCH only; returned on Bundle responses) so signers can reassign signing responsibility.
  • Added packet status value ra (REASSIGNED) when a signer has reassigned.
  • Added webhook event type bundle_signer_reassigned.

2.17.0 July 2, 2026​

New

  • Added expires and signing_brand to POST /bundles/ so both can be set at Bundle creation time (previously only via PATCH).

2.16.0 June 11, 2026​

New

  • Added developer-controlled metadata on Document Templates — attach arbitrary string key/value pairs to tag, organize, and filter templates. Set via the new PATCH /templates/{id}/ endpoint and on template preparation sessions; filter with GET /templates/?metadata[key]=value. See the Templates reference.
  • Added teams field on Document Templates — read-only array of team UUIDs indicating which teams the template is assigned to (filtered to teams accessible to the authenticated user).
  • Added data_flow_tag field on Document Template fields — read-only string (lowercase letters, digits, and underscores; max 40 characters) that links a template field to a named data-flow slot in your integration.
  • Added tag_values field on Bundle creation (POST /bundles/) — a map of Data Flow Tag names to values that pre-fills matching fields in the Bundle.
  • Added embedded preparation session endpoints that return a time-limited iframe URL for the Bundle preparation (POST /bundles/preparation_session/) and Document Template authoring (POST /templates/preparation_session/) experiences.

2.15.0 June 4, 2026​

New

  • Added MS Office document upload support when creating a Bundle — POST /bundles/ (multipart/form-data) now accepts .doc, .docx, .ppt, .pptx, .xls, and .xlsx files via file_index and converts them to PDF server-side before fields are placed and the Bundle is sent. Talk to Blueink Support if this feature is not active on your account.
  • Added public POST /verify/ endpoint that accepts a SHA-256 hash and reports whether the document was produced by Blueink (signed_pdf, combined_pdf, or coe_pdf) along with limited envelope metadata (bundle slug, status, and sent/completed timestamps). Does not require authentication; subject to anonymous rate limiting.
  • Added embedded preparation session endpoints: POST /bundles/preparation_session/ (hosts the Bundle document-preparation experience in an iframe) and POST /templates/preparation_session/ (hosts the Document Template authoring experience in an iframe; returns 403 when not active on the account). Talk to Blueink Support if this feature is not active on your account.

Fixes

  • Fixed Team envelope defaults not being applied when creating a Bundle with a team.

2.14.0 May 13, 2026​

New

  • Added requires_witness (boolean, read-only) on Packet to indicate that a Signer requires a witness to be present and co-sign.
  • Added witness_nominated_by (string enum, read-only) on Packet to identify who nominates the witness: sgn (Signer nominates at signing time), snd (Sender nominates up front), or "" (no witness required).

2.13.1 June 4, 2026​

New

  • Added doc_status to the Bundle schema indicating the state of document generation: no (None), pe (Pending), di (Dirty), in (Interim), or fi (Final).

Documentation Updates

  • PUT /bundles/{bundleSlug}/files/ ("Generate Interim Bundle Files") was listed in this entry in error and has been removed from the API reference — the endpoint was never released in APIv2. Use GET /bundles/{bundleSlug}/files/ to retrieve Bundle files.

2.13.0 April 9, 2026​

New

  • Added HTML-to-PDF document creation on DocumentRequest (POST /bundles/): file_html (HTML string rendered to PDF), html_fields_mode (blueink by default to detect HTML form elements and data-blu-* annotations, or none to skip field detection), and filename (max 50 characters).
  • Added regex-based field validation via v_regex (RE2 syntax, max 200 characters) and v_regex_msg (max 200 characters) on FieldRequest and inline field updates within UpdateableDocument. v_regex cannot be combined with v_pattern; when v_regex is set, v_min and v_max are ignored. Talk to Blueink Support if this feature is not active on your account.

Documentation Updates

  • Added the Generate PDFs from HTML guide covering page layout, supported form elements, data-blu-* field annotations, label detection, and the JavaScript-stripping security model.
  • Added section-intro descriptions to each tag in the API Reference (Bundles, Packet, Templates, Envelope Templates, Person, Webhook, WebhookEvent, WebhookExtraHeader, WebhookSecret, and Rate Limiting), with cross-links to the relevant guides.
  • Added an operation-level description to POST /bundles/ (Create Bundle) covering the document-source rules (file, file_url, file_b64, file_index, file_html).

2.12.0 March 11, 2026​

New

  • Added nullable signing_brand UUID field on BundlePatchRequest (PATCH /bundles/{bundleSlug}/) to set a Bundle's signing brand (must belong to the same account) or pass null to clear it.
  • Added v_pattern, v_min, v_max, v_attachment_types, format, and initial_value to AutoPlacementRequestField so auto-placement fields support the same validation, format, and initial-value options as regular fields.

Documentation Updates

  • Documented partial Bundle updates via PATCH /bundles/{bundleSlug}/ in the API Reference, including supported request schema fields and field-level constraints.
  • Documented format support on date-oriented field kinds (dat and tms), clarifying allowed values and that other field kinds return a validation error.
  • Removed sdt (Signing Date Short) from the documented kind enum on FieldRequest, UpdateableFieldRequest, and AutoPlacementRequestField.
  • Removed deprecated parse_tags and Field Tags references from DocumentRequest and related connector schema docs.

2.11.0 November 12, 2025​

New

  • Added the packet_declined webhook event type so applications can subscribe to real-time notifications when a signer declines to sign their packet.

2.10.0 October 24, 2025​

New

  • Added the include query parameter on GET /bundles/{bundleSlug}/ to fetch related data in a single request (data, events, files, or combined as ?include=data,events,files).

2.9.0 July 3, 2025​

New

  • Added signing_complete_redirect on PacketRequest (via POST /bundles/ or PUT /packets/{packetId}/) to customize the URL signers are redirected to after completing signing.

2.8.0 June 9, 2025​

Updates

  • Limited delivery for test Bundles (is_test: true) to verified primary email addresses of Users on the account. Contact Blueink Support for exceptions.

2.7.0 April 25, 2025​

New

  • Added converted_adobe_fields_to on DocumentRequest to convert uploaded Adobe PDF form fields into Blueink fields and assign them to the specified signer key.

2.6.0 April 2, 2025​

New

  • Added POST /bundles/create_from_envelope_template/ to create a new Bundle from an Envelope Template.

2.5.2 February 26, 2025​

New

  • Added auth_secrets to PacketRequest to support secret-based signer authentication.

2.5.1 December 13, 2024​

Updates

  • Improved error messages when sending Draft Bundles via POST /bundles/{bundleId}/send/ and in the errors array returned by GET /bundles/{bundleId}/.

2.5.0 November 11, 2024​

New

  • Added payment field on BundleRequest and Bundle to support collecting Payments when creating Bundles.

2.4.1 September 6, 2024​

New

  • Added date-range filtering query parameters on GET /bundles/: created_after, created_before, sent_after, sent_before, completed_after, and completed_before.

Fixes

  • Fixed a corner-case bug when creating a Bundle without initial_values.

2.4.0 August 15, 2024​

New

  • Added auto-placement to dynamically position fields on a document relative to a text search pattern.

2.3.0 May 22, 2023​

New

  • Added signer notification suppression flags on POST /bundles/ and PUT /packets/{packetId}/: suppress_signing, suppress_reminder, suppress_docs_ready, and suppress_all.

2.2.0 December 28, 2022​

New

  • Added Draft Bundle support: is_draft on POST /bundles/, POST /bundles/{bundleId}/send/ to send a Draft Bundle, and PUT /bundles/{bundleId}/validate/ to validate whether a Draft Bundle is ready to send.

2.1.1 October 12, 2022​

Updates

  • Added validation checks and clearer error messages for Base64 document upload errors.

2.1.0 August 30, 2022​

New

  • Added support for creating checkbox groups (kind: cbg).
  • Added /webhooks/ endpoints for creating and managing webhooks.

2.0.0 June 12, 2022​

New

  • Initial general-availability launch of Blueink APIv2.

2.0.0-beta.3 May 2, 2022​

Updates

  • Updated available error codes for Error response objects.

2.0.0-beta.2 April 23, 2022​

New

  • Added DocumentTemplate.is_shared to responses.
  • Added support for reading and updating Person metadata.
  • Added GET /bundles/{bundleId}/data/ to retrieve Bundle field data.

Updates

  • Removed DocumentTemplate.account from responses.

2.0.0-beta April 4, 2022​

New

  • Initial beta release of Blueink APIv2.