Skip to main content

List Contact Renewal Reminders

Returns a list of your ContactRenewalReminders.

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).

Schema

array
  • 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

    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]

  • overdue boolean

    Default value: false

    Indicates whether or not this Renewal Reminder is overdue.

  • due_soon boolean

    Default value: false

    Indicates whether or not this Renewal Reminder is due soon.

  • contact_id integer

    Possible values: >= 1

  • contact_renewal_type_id integer

    Possible values: >= 1

  • contact_renewal_type_name string

    The name for this Renewal Reminder.

  • contact_archived_at date-time

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

Loading...