Function notify

Parameters

• client: Client
• parameters: {
      htmlBody?: string;
      issueIdOrKey: string;
      restrict?: {
          groupIds?: string[];
          groups?: {
              groupId?: string | null;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          permissions?: { id?: string; key?: string; [key: string]: unknown }[];
          [key: string]: unknown;
      };
      subject?: string;
      textBody?: string;
      to?: {
          assignee?: boolean;
          groupIds?: string[];
          groups?: {
              groupId?: string
              | null;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          reporter?: boolean;
          users?: {
              accountId?: string;
              accountType?: string;
              active?: boolean;
              avatarUrls?: {
                  "16x16"?: string;
                  "24x24"?: string;
                  "32x32"?: string;
                  "48x48"?: string;
                  [key: string]: unknown;
              };
              displayName?: string;
              emailAddress?: string;
              self?: string;
              timeZone?: string;
              [key: string]: unknown;
          }[];
          voters?: boolean;
          watchers?: boolean;
          [key: string]: unknown;
      };
  }

  • OptionalhtmlBody?: string

    The HTML body of the email notification for the issue.

  • issueIdOrKey: string

    ID or key of the issue that the notification is sent for.

  • Optionalrestrict?: {
        groupIds?: string[];
        groups?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        permissions?: { id?: string; key?: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }

    • OptionalgroupIds?: string[]

      List of groupId memberships required to receive the notification.

    • Optionalgroups?: {
          groupId?: string | null;
          name?: string;
          self?: string;
          [key: string]: unknown;
      }[]

      List of group memberships required to receive the notification.

    • Optionalpermissions?: { id?: string; key?: string; [key: string]: unknown }[]

      List of permissions required to receive the notification.

  • Optionalsubject?: string

    The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.

  • OptionaltextBody?: string

    The plain text body of the email notification for the issue.

  • Optionalto?: {
        assignee?: boolean;
        groupIds?: string[];
        groups?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        reporter?: boolean;
        users?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        }[];
        voters?: boolean;
        watchers?: boolean;
        [key: string]: unknown;
    }

    • Optionalassignee?: boolean

      Whether the notification should be sent to the issue's assignees.

    • OptionalgroupIds?: string[]

      List of groupIds to receive the notification.

    • Optionalgroups?: {
          groupId?: string | null;
          name?: string;
          self?: string;
          [key: string]: unknown;
      }[]

      List of groups to receive the notification.

    • Optionalreporter?: boolean

      Whether the notification should be sent to the issue's reporter.

    • Optionalusers?: {
          accountId?: string;
          accountType?: string;
          active?: boolean;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      }[]

      List of users to receive the notification.

    • Optionalvoters?: boolean

      Whether the notification should be sent to the issue's voters.

    • Optionalwatchers?: boolean

      Whether the notification should be sent to the issue's watchers.

• Optionaloptions: RequestOptions