Retrieve Contact Renewal Reminder

Retrieve the details of an existing Contact Renewal Reminder.

Path Parameters

• id string required

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

  The id of the relevant record

Responses

• 200
• 401
• 403
• 404
• 500

---

OK

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]

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

{
  "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",
  "overdue": false,
  "due_soon": false,
  "contact_id": 0,
  "contact_renewal_type_id": 0,
  "contact_renewal_type_name": "string",
  "contact_archived_at": "2023-03-14T13:46:27-06:00"
}

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"
}

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"
}

Loading...