v7.20.1

What's Changed

Added

• Beta document endpoints let you pull the full document text in plain text or Markdown, and request summaries at three levels (detailed, short, or headline). When content or a summary is still being prepared, the API responds with 202 and a Retry-After hint so clients can poll safely. Successful responses include ETag and Vary so caches stay correct when you change format or type.

GET /public/beta/documents/{document_id}/content

• endpoint added

GET /public/beta/documents/{document_id}/summary

• endpoint added

Full Changelog: v7.19.1...v7.20.1

v7.19.1

What's Changed

Documented: Log endpoints return a maximum of 10,000 entries per request

• The count query parameter is capped at 10000. If you need to fetch large volumes of logs, use the available query parameters to narrow your results:
  • since / to — filter by time range
  • statuses — filter by response status
  • methods — filter by HTTP method
  • search — filter by search term

Affects:

GET /public/v1/logs

• ⚠️ for the 'query' request parameter 'count', the max was set to '1000.00'

GET /public/v2/logs

• ⚠️ for the 'query' request parameter 'count', the max was set to '1000.00'
  
  

Full Changelog: v7.19.0...v7.19.1

v7.19.0

What's Changed

Added

• Enhanced notarization request details to include termination information. You can now retrieve details and reasons for a notarization session's termination, providing more comprehensive insights into session outcomes.

GET /public/v2/notary/notarization-requests/{session_request_id}

• added the optional property 'termination_details' to the response with the '200' status
• added the optional property 'termination_reason' to the response with the '200' status

Full Changelog: v7.18.3...v7.19.0

v7.18.3

What's Changed

Added

Added endpoint to programmatically delete documents (bulk), enabling you to manage and remove documents via the API.

Enhanced markdown document creation with fields_mapping property, allowing custom field mapping when uploading markdown content via the API.

DELETE /public/v1/documents

• endpoint added

POST /public/v1/documents?upload-markdown

• added the new optional request property 'data/fields_mapping'

Full Changelog: v7.18.2...v7.18.3

v7.18.2

Added

• Added a new endpoint to create documents by uploading Markdown content, enabling you to programmatically generate rich-text documents from Markdown.

[BETA] POST /public/v1/documents?upload-markdown

• endpoint added

Changed

• Implemented minimum value constraints for document field layout properties (offset_x, offset_y, height, width) to ensure valid positioning and sizing when programmatically updating document fields.

POST /public/v1/documents/{id}/fields

• ⚠️ the 'fields/items/layout/position/offset_x' request property's min was set to '0.00'
• ⚠️ the 'fields/items/layout/position/offset_y' request property's min was set to '0.00'
• ⚠️ the 'fields/items/layout/style/height' request property's min was set to '0.00'
• ⚠️ the 'fields/items/layout/style/width' request property's min was set to '0.00'

Full Changelog: v7.18.1...v7.18.2

v7.18.1

Changed

• Increased the maximum length for email reminder subject lines, allowing you to create more descriptive and comprehensive subjects for your document reminders.

POST /public/v1/documents/{document_id}/send-reminder

• ⚠️ the 'result/items/email_customization/subject' response property's maxLength was increased from '300' to '512' for the response status '200'
• the 'reminders/items/email_customization/subject' request property's maxLength was increased from '300' to '512'

Full Changelog: v7.18.0...v7.18.1

v7.18.0

Added

Enhanced quote update functionality with new summary fields, allowing you to include overall and section-specific summary details when updating a quote.

PUT /public/v1/documents/{document_id}/quotes/{quote_id}

• added the new optional request property 'sections/items/summary'
• added the new optional request property 'summary'

Full Changelog: v7.17.0...v7.18.0

v7.17.0

Added

• Added endpoints to retrieve API logs: list all logs or fetch a single log by ID for auditing and debugging.

GET /public/v2/logs

• endpoint added

GET /public/v2/logs/{id}

• endpoint added

Deprecated

• The v1 API log endpoints are deprecated in favor of the v2 log endpoints. Please migrate to GET /public/v2/logs and GET /public/v2/logs/{id}.

GET /public/v1/logs

• endpoint deprecated

GET /public/v1/logs/{id}

• endpoint deprecated

Full Changelog: v7.16.2...v7.17.0

v7.16.2

Added

Document details now include approval execution info, folder UUID, and document version.

GET /public/v1/documents/{id}/details

• added the optional property 'approval_execution' to the response with the '200' status
• added the optional property 'folder_uuid' to the response with the '200' status
• added the optional property 'version' to the response with the '200' status

Changed

Send-reminder email customization now supports longer subject lines (up to 300 characters instead of 78) in both the request and the response.

POST /public/v1/documents/{document_id}/send-reminder

• the 'result/items/email_customization/subject' response property's maxLength was increased from '78' to '300' for the response status '200'
• the 'reminders/items/email_customization/subject' request property's maxLength was increased from '78' to '300'

Document details: the text field merge field can now be null.

GET /public/v1/documents/{id}/details

• the response property 'fields/items/anyOf[subschema #10: Text]/allOf[subschema #2]/merge_field' became nullable for the status '200'
• the 'fields/items/anyOf[subschema #10: Text]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #1: Checkbox]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #2: Collect File]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #3: Date]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #4: Dropdown]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #5: Initials]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #6: Payment Details]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #7: Radio Buttons]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #8: Signature]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'
• the 'fields/items/anyOf[subschema #9: Stamp]/allOf[#/components/schemas/BaseField]/assigned_to/anyOf[subschema #1: Recipient]/allOf[subschema #2]/phone' response's property pattern '^+[1-9]\d{0,4}\d{2,14}$' was removed for the status '200'

Full Changelog: v7.16.1...v7.16.2

v7.16.1

Previously, the currency field was added at the incorrect nesting level. This update moves it to the top level of the request body.

• PUT /public/v1/documents/{document_id}/quotes/{quote_id}`

  • ⚠️ removed the request property 'sections/items/currency'
  • added the new optional request property 'currency'

Full Changelog: v7.16.0...v7.16.1