Skip to main content

Create Vehicle Renewal Reminder

Creates a new Vehicle Renewal Reminder

Request Body

  • vehicle_id integer required

    Possible values: >= 1

  • vehicle_renewal_type_id integer required

    Possible values: >= 1

  • next_due_at 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_at 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_interval integer

    Possible values: >= 1

    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 string

    Possible values: [day, week, month, year, days, weeks, months, years]

  • active boolean

    Whether this Renewal Reminder is active.

  • custom_fields object

    *Full details on working with Custom Fields here.

Responses

OK

Response Headers

    Schema

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • active boolean

      Whether or not this Renewal Reminder is active.

    • next_due_at date-time

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

    • last_sent_at date-time

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

    • due_soon_at date-time

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

    • due_soon_time_threshold_interval integer

      Possible values: >= 1

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

    • due_soon_time_threshold_frequency string

      Possible values: [day, week, month, year, days, weeks, months, years]

    • account_id integer

      Possible values: >= 1

    • vehicle_id integer

      Possible values: >= 1

    • vehicle_renewal_type_id integer

      Possible values: >= 1

    • vehicle_archived_at date-time

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

    • comments object[]
    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • commentable_type CommentableType

      Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

      The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

    • commentable_id integer

      Possible values: >= 1

    • user_id integer

      Possible values: >= 1

    • title string deprecated

      The title of the Comment.

    • comment string

      The content of the Comment message body.

    • user_full_name string

      The full name of the User who created the Comment.

    • user_image_url string

      The image url for the User who created the Comment.

    • rich_content object
    • html_content string

      The comment message body rendered as HTML.

    • with_mentions boolean

      Indicates if the message body contains @mentions.

    • comments_count integer

      The number of Comments on this Renewal Reminder.

    • custom_fields object
    • is_sample boolean

      Whether this Renewal Reminder is sample data.

    • watchers_count int32

      The count of watchers associated with the record.

    • watchable_options object

      Options related to watching the record.

    • bulk_watch_record boolean

      Indicates if a bulk watch record is created.

    • skip_automatic_watchers_callbacks boolean

      Indicates if automatic watchers callbacks are skipped.

    • is_watched boolean

      Indicates whether the record is being watched.

    Loading...