Skip to navigation

Update fields of agreement

View as Markdown

This operation updates one or more fields of a specific agreement identified by its agreementId. The operation supports partial updates, allowing clients to modify only the fields they need without affecting the rest of the agreement data.

The request body should contain a JSON payload with the fields to be updated. Only the fields provided in the request body will be modified; all other fields remain unchanged. The operation returns a 204 No Content response on success.

This operation is essential for maintaining and evolving agreement data throughout the agreement’s lifecycle, such as updating status, provisions, custom fields, or metadata based on business events or reviews.

Use Cases:

  • Updating agreement status or review completion: Mark agreements as reviewed, completed, or pending further action based on internal workflows.
  • Modifying provision details: Update agreement terms, effective dates, expiration dates, or renewal conditions as circumstances change.
  • Managing custom attributes: Add or modify user-defined fields and custom metadata to capture additional business context for the agreement.
  • Recording business events: Update agreements to reflect changes such as amendments, renewals, or termination notices.
  • Synchronizing agreements across systems: Update agreements in response to changes detected in external systems (e.g., ERP, CRM) to maintain data integrity.

Key Features:

  • Partial Updates: Modify only the fields you need; other agreement data remains intact.
  • Flexible Payload: Accept JSON objects with any combination of updateable agreement fields, including provisions, metadata, and custom attributes.
  • Data Integrity: Validates all input data to ensure compliance with agreement structure and data constraints.

Authentication

AuthorizationBearer

Path parameters

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

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. No content is returned.

Errors

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