Update fields of agreement
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
OAuth2 authentication.
- Demo:
- authorizationUrl: https://account-d.docusign.com/oauth/auth
- tokenUrl: https://account-d.docusign.com/oauth/token
- Production:
- authorizationUrl: https://account.docusign.com/oauth/auth
- tokenUrl: https://account.docusign.com/oauth/token
Path parameters
Request
“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.
List of languages applicable to the agreement, identified using BCP-47 language codes.
Hypermedia controls (HATEOAS) for agreement specific links to resources.
User-defined/custom attributes included in this agreement.