Update Agreement Terms

Change the wording for this booking only. The supplier's saved template is untouched and every other booking keeps its own terms.

PATCH /v1/bookings/{id}/agreement

Authentication

Requires a valid API key with agreements:write scope.

Path Parameters

Parameter	Type	Description
id	integer	Booking ID

Request Body

Field	Type	Required	Description
terms	string	Yes	The full wording, max 20,000 characters. Merge tags are not re-resolved — send the finished text
title	string	No	Document heading, max 120 characters

Request Example

curl -X PATCH "https://app.equipdash.com/api/v1/bookings/4821/agreement" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "terms": "This agreement is between Example Outfitters and Jane Doe. Items must be returned by 5:00 PM on August 16."
  }'

Response

Returns 200 OK with the updated agreement resource.

Errors

Status	Code	When
403	agreements_disabled	The business has rental agreements switched off
409	agreement_not_applicable	The booking has no rental items, so it has no agreement
404	resource_not_found	No booking with that ID belongs to this API key's business
422	validation_error	terms missing, empty, or over 20,000 characters
422	agreement_update_failed	The agreement is already signed — signed wording is frozen