Verify against final controller

This page documents the D.1–D.4 lifecycle notification settings. Verify exact field names and PATCH semantics against the final SettingsController implementation before publishing.

Lifecycle Notification Settings

Read and update the customer lifecycle communication settings: pre-arrival messages, post-rental survey options, and the overdue-rental extension offer. These settings correspond to the Customer Lifecycle card in Settings → Notifications in the web UI.

Endpoints

Method	Endpoint	Description	Scope
GET	/v1/settings/lifecycle	Get lifecycle notification settings	settings:read
PATCH	/v1/settings/lifecycle	Update lifecycle notification settings	settings:write

---

GET /v1/settings/lifecycle

Example Request

curl "https://app.equipdash.com/api/v1/settings/lifecycle" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (200 OK)

{
  "data": {
    "pre_arrival": {
      "enabled": true,
      "lead_hours": 24,
      "directions": "We're at 12 Harbour St, Level 1. Parking under the building — enter from Bay Rd. Call us if you can't find it."
    },
    "overdue_extension": {
      "enabled": true,
      "grace_minutes": 15
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-04-01T09:00:00Z"
  }
}

Response Fields

pre_arrival object

Field	Type	Description
enabled	boolean	Whether pre-arrival messages fire automatically
lead_hours	integer	How many hours before pickup/start the message is sent. Range 1–168. Default 24.
directions	string|null	Directions and parking blurb included in the message. Max 1000 chars.

overdue_extension object

Field	Type	Description
enabled	boolean	Whether overdue notices include a one-tap extension offer
grace_minutes	integer	Minutes after scheduled return before the overdue notice fires. Range 0–1440. Default 15.

Dependency

overdue_extension.enabled only adds the extension link when Allow customers to extend online is also enabled in the rental settings. If online extensions are off, the link is omitted from overdue notices regardless of this flag.

---

PATCH /v1/settings/lifecycle

Update any subset of lifecycle notification settings. Only the fields you include are changed.

Authentication

Requires settings:write scope.

Request Body

All fields are optional. Omit any field you do not want to change.

{
  "pre_arrival": {
    "enabled": true,
    "lead_hours": 48,
    "directions": "Find us at the blue shed on the marina. Free parking on Slip Rd."
  },
  "overdue_extension": {
    "enabled": true,
    "grace_minutes": 30
  }
}

Request Fields

Field	Type	Validation
pre_arrival.enabled	boolean	—
pre_arrival.lead_hours	integer	1–168
pre_arrival.directions	string|null	Max 1000 chars. Pass null to clear.
overdue_extension.enabled	boolean	—
overdue_extension.grace_minutes	integer	0–1440

Example Request

curl -X PATCH "https://app.equipdash.com/api/v1/settings/lifecycle" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pre_arrival": {
      "enabled": true,
      "lead_hours": 48
    }
  }'

Response (200 OK)

Returns the full updated lifecycle settings object in the same shape as GET /v1/settings/lifecycle.

---

Survey Clean-Return Gate

The survey-level Only send after a clean return setting is per-survey, not a global setting. It is read and written via the surveys API:

GET  /v1/surveys/{id}
PATCH /v1/surveys/{id}

Relevant survey fields:

Field	Type	Description
skip_if_returned_damaged	boolean	When true, surveys triggered by "After equipment return" are skipped if any item was returned in Poor or Damaged condition. Default true for return-triggered surveys.
delivery_channel	string	"email", "sms", or "email_and_sms". Controls how the survey is delivered.

See Surveys API for the full surveys endpoint reference.

---

Errors

Status	Code	Description
401	authentication_required	No API key provided
401	invalid_api_key	Invalid API key
403	insufficient_scope	API key lacks settings:read or settings:write
422	validation_error	A field failed validation (details in error.details)

---

Related Settings

• Get Settings — full business settings including enabled modules
• Supplier Modules — check whether online extensions (online_extend_enabled) are on
• Surveys API — per-survey delivery channel and clean-return gate
• Webhooks Events — booking.damage_charge.paid and other lifecycle events