Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Overview

This document provides an overview of the GraphQL API for managing reminders within a issue or user. It includes the available queries and mutations, as well as the types used in the API.

...

  • issueId: String - The unique identifier of the bundle.

  • showArchived: Boolean – Whether to include archived reminders (default: true).

Returns:

...

  • issueId is required.

  • subject is required.

  • recipientUsers, recipientGroups, recipientChannels, recipientGoogleChats default to empty arrays.

  • Default values:

    • private: false (Reminders are public by default

    • cancelWhenResolved: true (Reminder is automatically canceled if the issue is resolved

    • autoDelete: true (Reminder is deleted after being sent

    • addIssueComment: false (Does not add a comment to the issue by default

  • Any unknown fields will result in a validation error.

...

Arguments

...

Returns

  • A Reminder object containing the saved reminder's details.

...