Added

  • Enhanced document search results with a comprehensive set of new extra_fields, providing detailed metadata such as clm_metadata, completion_rate, various date fields, document_type, recipients, tags, and more. This allows for richer data retrieval and more granular analysis of search outcomes.

GET /public/beta/documents/search

  • added the optional property results/items/extra_fields/clm_metadata to the response with the 200 status
  • added the optional property results/items/extra_fields/completion_rate to the response with the 200 status
  • added the optional property results/items/extra_fields/date_completed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_expiration to the response with the 200 status
  • added the optional property results/items/extra_fields/date_expired to the response with the 200 status
  • added the optional property results/items/extra_fields/date_first_signed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_first_viewed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_last_signed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_last_viewed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_modified to the response with the 200 status
  • added the optional property results/items/extra_fields/date_of_last_action to the response with the 200 status
  • added the optional property results/items/extra_fields/date_sent to the response with the 200 status
  • added the optional property results/items/extra_fields/document_type to the response with the 200 status
  • added the optional property results/items/extra_fields/effective_permissions to the response with the 200 status
  • added the optional property results/items/extra_fields/parent to the response with the 200 status
  • added the optional property results/items/extra_fields/path to the response with the 200 status
  • added the optional property results/items/extra_fields/recipient_count to the response with the 200 status
  • added the optional property results/items/extra_fields/recipients to the response with the 200 status
  • added the optional property results/items/extra_fields/removed to the response with the 200 status
  • added the optional property results/items/extra_fields/signed_count to the response with the 200 status
  • added the optional property results/items/extra_fields/tags to the response with the 200 status
  • added the optional property results/items/extra_fields/time_to_completion_hours to the response with the 200 status
  • added the optional property results/items/extra_fields/title to the response with the 200 status
  • added the optional property results/items/extra_fields/total to the response with the 200 status
  • added the optional property results/items/extra_fields/type to the response with the 200 status
  • added the optional property results/items/extra_fields/viewed_count to the response with the 200 status
  • added the optional property results/items/extra_fields/viewed_total_count to the response with the 200 status

Removed

  • Improved error response consistency by removing the redundant details property from 500 and 504 error responses, streamlining error handling.

GET /public/beta/documents/search

  • ⚠️ removed the required property details from the response with the 500 status
  • ⚠️ removed the required property details from the response with the 504 status

Added

  • Enhanced document summary retrieval with a new xshort summary type, allowing you to fetch highly condensed document summaries.

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

  • ⚠️ added the new xshort enum value to the type response property for the response status 200
  • added the new enum value xshort to the query request parameter type

Added

  • Enhanced document details with a lock property, allowing you to programmatically determine if a document is currently locked.

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

  • added the optional property lock to the response with the 200 status

Changed

  • Improved error handling across various document modification and management endpoints by introducing the 423 Locked HTTP status code. Your application can now detect when a requested operation cannot be performed because the document is locked.

POST /public/v1/documents/{document_id}/sections/uploads

  • added the non-success response with the status 423

POST /public/v1/documents/{document_id}/sections/uploads?upload

  • added the non-success response with the status 423

DELETE /public/v1/documents/{document_id}/sections/{section_id}

  • added the non-success response with the status 423

DELETE /public/v1/documents/{id}

  • added the non-success response with the status 423

PATCH /public/v1/documents/{id}

  • added the non-success response with the status 423

POST /public/v1/documents/{id}/append-content-library-item

  • added the non-success response with the status 423

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

  • added the non-success response with the status 423

DELETE /public/v1/documents/{id}/attachments/{attachment_id}

  • added the non-success response with the status 423

POST /public/v1/documents/{id}/attachments?upload

  • added the non-success response with the status 423

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

  • added the non-success response with the status 423

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

  • added the non-success response with the status 423

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

  • added the non-success response with the status 423

POST /public/v1/documents/{id}/linked-objects

  • added the non-success response with the status 423

DELETE /public/v1/documents/{id}/linked-objects/{linked_object_id}

  • added the non-success response with the status 423

POST /public/v1/documents/{id}/move-to-folder/{folder_id}

  • added the non-success response with the status 423

PATCH /public/v1/documents/{id}/ownership

  • added the non-success response with the status 423

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

  • added the non-success response with the status 423

PATCH /public/v1/documents/{id}/recipients/recipient/{recipient_id}

  • added the non-success response with the status 423

DELETE /public/v1/documents/{id}/recipients/{recipient_id}

  • added the non-success response with the status 423

POST /public/v1/documents/{id}/recipients/{recipient_id}/reassign

  • added the non-success response with the status 423

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

  • added the non-success response with the status 423

PATCH /public/v1/documents/{id}/status

  • added the non-success response with the status 423

PATCH /public/v1/documents/{id}/status?upload

  • added the non-success response with the status 423

POST /public/v1/documents/{id}/linked-objects

  • added the non-success response with the status 409

Added

  • Added a new endpoint to search for documents, enabling you to programmatically find documents based on various criteria.

GET /public/beta/documents/search

  • endpoint added

Added

  • Added endpoint to change a workspace member's role, allowing you to programmatically assign built-in roles (Admin, Manager, Member, Collaborator) or custom workspace roles without removing and re-adding the member

PATCH /public/v1/workspaces/{workspace_id}/members/{member_id}/role

  • endpoint added
  • Enhanced document recipient management by introducing new properties for RecipientGroup objects. You can now define and update recipient groups with specific IDs, members, and types when modifying a document, providing more granular control over document distribution.

PATCH /public/v1/documents/{id}

  • added the new optional request property recipients/items/anyOf[subschema #2: RecipientGroup]/id
  • added the new optional request property recipients/items/anyOf[subschema #2: RecipientGroup]/members
  • added the new optional request property recipients/items/anyOf[subschema #2: RecipientGroup]/type

Changed

  • Updated the definition of RecipientGroup objects. The name property is now required for recipient groups, and the overall structure has been refined, including changes to its type/format and the removal of BaseActor from its inheritance chain, ensuring a more distinct and robust group definition.

PATCH /public/v1/documents/{id}

  • ⚠️ added the new required request property recipients/items/anyOf[subschema #2: RecipientGroup]/name
  • ⚠️ the recipients/items/anyOf[subschema #2: RecipientGroup]/ request property type/format changed from / to object/``
  • ⚠️ removed #/components/schemas/BaseActor from the recipients/items/anyOf[subschema #1: Recipient]/ request property allOf list
  • ⚠️ removed #/components/schemas/BaseActor, subschema #2 from the recipients/items/anyOf[subschema #2: RecipientGroup]/ request property allOf list

Update docs to reflect current implementation

  • The POST /public/v1/documents/{id}/linked-objects endpoint now returns a 201 Created status for successful operations, aligning with standard REST API practices for resource creation and providing clearer feedback when objects are successfully linked.

POST /public/v1/documents/{id}/linked-objects

  • ⚠️ removed the success response with the status 200
  • added the success response with the status 201

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

  • ⚠️ added the new Can't send SMS reminder to recipient group enum value to the result/items/sms/detail response property for the response status 200
  • removed the Can't send reminder to recipient group enum value from the result/items/email/detail response property for the response status 200
  • removed the Can't send reminder to recipient group enum value from the result/items/sms/detail response property for the response status 200

Changed

  • Updating document fields is now atomic: either all fields are updated or none are, so partial updates no longer leave documents in an inconsistent state. On success, the endpoint now returns 204 No Content instead of 200 OK — update any clients that rely on parsing the response payload.

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

  • ⚠️ removed the success response with the status 200
  • added the success response with the status 204

Added

  • Added a new endpoint to retrieve notarization requests, enabling you to programmatically fetch details about notarization processes.

    GET /public/v2/notary/notarization-requests

    • endpoint added

Changed

  • Enhanced the notarization request creation endpoint with new error responses, providing clearer feedback with 400 Bad Request and 401 Unauthorized statuses for invalid requests or authentication issues.

    POST /public/v2/notary/notarization-requests

    • added the non-success response with the status 400
    • added the non-success response with the status 401

Added

  • Added endpoint to update document fields, allowing programmatic modification of individual field values within a document.

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

  • endpoint added