5.1.15. Reminders

This part of the Bugzilla API allows creating, listing, and removing of Bugzilla reminders.

5.1.15.1. Get Reminder

This allows you to retrieve information about a specific reminder.

Request

GET /rest/reminder/123

Response

{
  "id": 123,
  "bug_id": 456,
  "note": "This is a reminder note",
  "reminder_ts": "2024-06-08",
  "creation_ts": "2024-06-07",
  "sent": false
}

To get all reminders for your account:

GET /rest/reminder

Response

{
  "reminders": [
    {
      "id": 123,
      "bug_id": 456,
      "note": "This is a reminder note",
      "reminder_ts": "2024-06-08",
      "creation_ts": "2024-06-07",
      "sent": false
    }
  ]
}

Reminder Object

name	type	description
id	int	An integer ID uniquely identifying the reminder in this installation only.
bug_id	int	Bug ID associated with the reminder.
note	string	A descriptive note associated with the reminder.
reminder_ts	date	The date when the reminder will be sent out.
creation_ts	date	The date when the reminder was originally created.
sent	boolean	A boolean value that is set to true when delivered.

5.1.15.2. Create Reminder

This allows you to create a new reminder associated with a specific bug in Bugzilla.

Request

To create a new reminder:

{
  "bug_id": 456,
  "note" : "This is a reminder note",
  "reminder_ts" : "2024-06-08"
}

name	type	description
bug_id	int	Bug ID associated with the reminder.
note	string	A descriptive note associated with the reminder.
reminder_ts	date	The date when the reminder will be sent out.

Response

{
  "id": 123,
  "bug_id": 456,
  "note": "This is a reminder note",
  "reminder_ts": "2024-06-08",
  "creation_ts": "2024-06-07",
  "sent": false
}

A reminder object rest_reminder_object is returned.

5.1.15.3. Remove Reminder

This allows you to remove an existing reminder in Bugzilla.

Request

DELETE /rest/reminder/123

Response

If the removal of the reminder was successful, it should look like:

{
  "success": 1
}

---

This documentation undoubtedly has bugs; if you find some, please file them here.