FLfleetio
Contact Renewal Reminders

Update Contact Renewal Reminder

Update a ContactRenewalReminder

patch/contact_renewal_reminders/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

contact_idinteger

The ID of the Contact this Renewal Reminder is for.

contact_renewal_type_idinteger

The ID of the Contact Renewal Type this Renewal Reminder is for.

activeboolean

Whether or not this Renewal Reminder is active.

next_due_atstring date

The date at which this Renewal Reminder is due. We recommend using ISO-8601 formatted dates to avoid ambiguity.

due_soon_atstring date

The date at which this Renewal Reminder is 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

Example request

{
  "next_due_at": "2023-03-14",
  "due_soon_at": "2023-03-14"
}

Response

OK

Changes

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