Send Agreement for Signature

Email the customer their private signing link. Sending again after an edit delivers the latest wording on the same link.

POST /v1/bookings/{id}/agreement/send

Authentication

Requires a valid API key with agreements:write scope.

Path Parameters

Parameter	Type	Description
id	integer	Booking ID

Request Example

curl -X POST "https://app.equipdash.com/api/v1/bookings/4821/agreement/send" \
  -H "Authorization: Bearer YOUR_API_KEY"

No request body.

Response

Returns 200 OK with the agreement resource — status is now sent, sent_at is stamped and send_count has gone up by one.

{
  "data": {
    "booking_id": 4821,
    "status": "sent",
    "status_label": "Waiting for signature",
    "sent_at": "2026-08-14T09:00:00+00:00",
    "send_count": 1,
    "...": "..."
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-08-14T09:00:00+00:00"
  }
}

The email itself is the supplier's Agreement to Sign template, rendered in the booking's language with their branding.

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	agreement_send_failed	The customer has no email address, or the agreement is already signed