FLfleetio
Contact Renewal Reminders

Create Contact Renewal Reminder

Creates a new ContactRenewalReminder

post/contact_renewal_reminders

Request

Request body

contact_idinteger required

The ID of the Contact this Renewal Reminder is for.

contact_renewal_type_idinteger required

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 required

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

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
account_idinteger

The ID of the Account that this Renewal Reminder belongs to.

contact_idinteger required
contact_renewal_type_idinteger required
contact_archived_atstring date-time nullable required

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

is_sampleboolean

Whether or not this belongs to sample data.

comments_countinteger nullable

The number of Comments associated with this record.

watchers_countinteger

The number of watchers associated with this 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",
  "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.