Skip to main content

Update Contact Renewal Reminder

Update a ContactRenewalReminder

Path Parameters

  • id string required

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Request Body

  • contact_id integer

    The ID of the Contact this Renewal Reminder is for.

  • contact_renewal_type_id integer

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

  • active boolean

    Whether or not this Renewal Reminder is active.

  • next_due_at date

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

  • due_soon_at 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_interval integer

    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]

Responses

OK

Loading...