create amendment

Create an amendment for an existing Agreement.

Any attributes of the existing Agreement that will no longer be relevant after the amendment has been applied must be set to null as part of the amendment. For example, when amending payment_terms.type from "fixed" to "variable", payment_terms.amount must be set to null.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A supplied unique ID

Body Params
sandbox
object

SANDBOX ONLY: Parameter that allows you to simulate the debtor performing certain actions against the created amendment to aid integrators while testing their control flows.

changes
object
required

Changes to be applied to the mandate. Use null values to clear existing attributes, or provide new values to update them in the mandate.

date-time | null

Requested resolution (accept/decline) deadline for this amendment. It will be provided in any notification sent to the debtor. This time is for informational purposes only and does not affect the expiry time. If not provided, it defaults to 5 days from amendment creation. Value must be an ISO8601 date-time in UTC timezone.

Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses
202

accepted

403

forbidden

404

Not Found

500

Internal Server Error

Callbacks
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json