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
- application/json
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
]
- 204
- 401
- 403
- 404
- 422
- 500
OK
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"
}
The requested resource could not be located
- 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
typeitems 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"
}