Skip to navigation

Update agreement by locating it via document ID

View as Markdown

This operation updates a specific agreement by first locating it using its associated document_id. This is useful when the client knows the document storage identifier but not the agreement ID.

The operation accepts a document_id query parameter to uniquely identify the agreement, then applies the partial updates specified in the request body. The system will search for an agreement containing the specified document ID, and if found, apply the requested modifications. The operation returns a 204 No Content response on success.

This endpoint provides an alternative way to update agreements when the agreement ID is not readily available, making it convenient for systems that primarily work with document references rather than agreement identifiers.

Use Cases:

  • Updating agreements referenced by document storage ID: When integration points provide document IDs but not agreement IDs, this endpoint allows direct updates without a prior lookup.
  • Batch updating via external document references: Systems that track agreements through external document management systems can update agreements using their document storage identifiers.
  • Cross-system synchronization: Update agreements based on document references from external systems (e.g., content management systems, document repositories) without maintaining agreement ID mappings.
  • Document-centric workflows: In document-first business processes, update agreements using the document reference that users are familiar with.

Key Features:

  • Document ID Based Lookup: Locate agreements by their associated document storage identifier rather than requiring the agreement ID upfront.
  • Automatic Resolution: The system automatically finds the agreement associated with the provided document ID.
  • Partial Updates: Modify only the fields you need; other agreement data remains unchanged.

Authentication

AuthorizationBearer

Path parameters

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

Query parameters

document_idstringOptional
The unique document storage identifier associated with the agreement to be updated. This ID is used to locate the agreement.

Request

JSON payload containing the fields to be updated in the agreement.
idstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"
The unique identifier for the agreement document.
titlestring or nullOptional
Title of the agreement document, summarizing its purpose.
file_namestring or nullOptional
The file name of the agreement.
provisionsobjectOptional
"The conditions or rules written in a legal agreement. The set of possible provisions is determined by the agreement type."
custom_provisionsmap from strings to anyOptional

“A dictionary of user-defined provisions that extend the standard provisions set for this agreement type. • Keys = names of additional terms supplied by the customer (e.g., early_termination_fee). • Values = the term’s value, expressed as a primitive JSON type (string, number, boolean, etc.). This object reflects the data model as-defined by the customer, including property names and data types. note - Changes to the underlying data model will be reflected dynamically in this object at runtime.

additional_custom_clm_datamap from strings to anyOptional
Custom attributes originating from CLM in this agreement.
additional_custom_esign_datamap from strings to anyOptional
Custom attributes originating from eSign in this agreement.
languageslist of strings or nullOptional

List of languages applicable to the agreement, identified using BCP-47 language codes.

source_namestringOptional<=128 characters
The name of the source system which created this agreement, e.g. eSign, CLM, or Salesforce.
source_idstringOptional<=128 characters
The ID of the resource in the source system associated with this agreement. For example, it could be an ID of the envelope in eSign.
source_account_idstringOptional1-128 characters
The Account ID of the source system who creates this entity, e.g. eSign Account ID
linked_datalist of objectsOptional
metadataobjectOptional
_actionsobjectOptional
Available actions on the agreement. Actions are conditionally present based on the current state of the resource.
additional_user_defined_datamap from strings to anyOptionalDeprecated

User-defined/custom attributes included in this agreement.

Response

The agreement has been successfully updated via document ID. No content is returned.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error