Vehicle Renewal Reminders

Update Vehicle Renewal Reminder

Update a Vehicle Renewal Reminder

patch/vehicle_renewal_reminders/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

vehicle_idinteger
vehicle_renewal_type_idinteger
next_due_atstring date-time

The date and time at which this Renewal Reminder will be due next. We recommend using ISO-8601 formatted dates to avoid ambiguity.

due_soon_atstring date-time

The date and time at which this Renewal Reminder will be considered due soon. We recommend using ISO-8601 formatted dates to avoid ambiguity.

due_soon_time_threshold_intervalinteger

Used in conjunction with due_soon_time_threshold_frequency. Together they form a full due soon parameter eg; "1 week", "5 months", "10 years"

due_soon_time_threshold_frequency'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years' nullable
activeboolean

Whether this Renewal Reminder is active.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

Example request

{
  "next_due_at": "2023-03-14T13:46:27-06:00",
  "due_soon_at": "2023-03-14T13:46:27-06:00"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.