Create Contact Renewal Reminder

Creates a new ContactRenewalReminder

application/json

Request Body

contact_id integer required
The ID of the Contact this Renewal Reminder is for.
contact_renewal_type_id integer required
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 required
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

Response Headers

application/json

Schema
Example (from schema)

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
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
The ID of the Account that this Renewal Reminder belongs to.
contact_id integer
Possible values: >= 1
contact_renewal_type_id integer
Possible values: >= 1
contact_archived_at date-time
The date and time at which this Renewal Reminder's Contact was archived.
is_sample boolean
Whether or not this belongs to sample data.
comments_count integer
The number of Comments associated with this record.
watchers_count integer
The number of watchers associated with this 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.

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "active": true,
  "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",
  "due_soon_time_threshold_interval": 0,
  "due_soon_time_threshold_frequency": "day",
  "account_id": 0,
  "contact_id": 0,
  "contact_renewal_type_id": 0,
  "contact_archived_at": "2023-03-14T13:46:27-06:00",
  "is_sample": true,
  "comments_count": 0,
  "watchers_count": 0,
  "watchable_options": {},
  "bulk_watch_record": true,
  "skip_automatic_watchers_callbacks": true
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (from schema)
Example

Schema

errors object
type
items string

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}