FLfleetio
Vehicle Renewal Reminders

Create Vehicle Renewal Reminder

Creates a new Vehicle Renewal Reminder

post/vehicle_renewal_reminders

Request

Request body

vehicle_idinteger required
vehicle_renewal_type_idinteger required
next_due_atstring date-time required

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

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
vehicle_idinteger required
vehicle_renewal_type_idinteger required
vehicle_archived_atstring date-time nullable required

The date and time at which this Renewal Reminder's Vehicle was archived, if applicable.

activeboolean nullable required

Whether or not this Renewal Reminder is active.

next_due_atstring date-time required

The date and time at which this Renewal Reminder is next due.

last_sent_atstring date-time nullable required

The date and time at which this Renewal Reminder was last sent.

due_soon_atstring date-time nullable required

The date and time at which this Renewal Reminder will next be marked as "Due Soon".

due_soon_time_threshold_intervalinteger nullable required

The amount of time before a Renewal is due where it will be marked as as "Due Soon".

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

The number of Comments on this Renewal Reminder.

custom_fieldsobject required
is_sampleboolean

Whether this Renewal Reminder is sample data.

watchers_countinteger

The count of watchers associated with the record.

watchable_optionsobject

Options related to watching the record.

bulk_watch_recordboolean

Indicates if a bulk watch record is created.

skip_automatic_watchers_callbacksboolean

Indicates if automatic watchers callbacks are skipped.

Example response

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

Changes

No recorded changes to this operation across all 6 revisions of this API.