FLfleetio
Contact Renewal Reminders

Retrieve Contact Renewal Reminder

Retrieve the details of an existing Contact Renewal Reminder.

get/contact_renewal_reminders/{id}

Request

Path parameters

idstring required

The id of the relevant record

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.

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
overdueboolean required

Whether or not this Renewal Reminder is overdue.

due_soonboolean required

Whether or not this Renewal Reminder is due soon.

contact_idinteger required
contact_renewal_type_idinteger required
contact_renewal_type_namestring required

The name for this Renewal Reminder.

contact_archived_atstring date-time nullable required

The date and time at which this Renewal Reminder's Contact was archived.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_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",
  "contact_archived_at": "2023-03-14T13:46:27-06:00"
}

Changes

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