Function submitBulkEdit

Parameters

• client: Client
• parameters: {
      editedFieldsInput?: {
          cascadingSelectFields?: {
              childOptionValue?: { optionId?: number; [key: string]: unknown };
              fieldId: string;
              parentOptionValue: { optionId?: number; [key: string]: unknown };
              [key: string]: unknown;
          }[];
          clearableNumberFields?: {
              fieldId: string;
              value?: number;
              [key: string]: unknown;
          }[];
          colorFields?: {
              color: { name: string; [key: string]: unknown };
              fieldId: string;
              [key: string]: unknown;
          }[];
          datePickerFields?: {
              date?: { formattedDate: string; [key: string]: unknown };
              fieldId: string;
              [key: string]: unknown;
          }[];
          dateTimePickerFields?: {
              dateTime: { formattedDateTime: string; [key: string]: unknown };
              fieldId: string;
              [key: string]: unknown;
          }[];
          issueType?: { issueTypeId: string; [key: string]: unknown };
          labelsFields?: {
              bulkEditMultiSelectFieldOption:
                  | string & {}
                  | "ADD"
                  | "REMOVE"
                  | "REPLACE"
                  | "REMOVE_ALL";
              fieldId: string;
              labelProperties?: {
                  color?: | (...) & (...)
                  | "GREY_LIGHTEST"
                  | "GREY_LIGHTER"
                  | "GREY"
                  | "GREY_DARKER"
                  | "GREY_DARKEST"
                  | "PURPLE_LIGHTEST"
                  | "PURPLE_LIGHTER"
                  | "PURPLE"
                  | "PURPLE_DARKER"
                  | "PURPLE_DARKEST"
                  | "BLUE_LIGHTEST"
                  | "BLUE_LIGHTER"
                  | "BLUE"
                  | "BLUE_DARKER"
                  | "BLUE_DARKEST"
                  | "TEAL_LIGHTEST"
                  | "TEAL_LIGHTER"
                  | "TEAL"
                  | "TEAL_DARKER"
                  | "TEAL_DARKEST"
                  | "GREEN_LIGHTEST"
                  | "GREEN_LIGHTER"
                  | "GREEN"
                  | "GREEN_DARKER"
                  | "GREEN_DARKEST"
                  | "LIME_LIGHTEST"
                  | "LIME_LIGHTER"
                  | "LIME"
                  | "LIME_DARKER"
                  | "LIME_DARKEST"
                  | "YELLOW_LIGHTEST"
                  | "YELLOW_LIGHTER"
                  | "YELLOW"
                  | "YELLOW_DARKER"
                  | "YELLOW_DARKEST"
                  | "ORANGE_LIGHTEST"
                  | "ORANGE_LIGHTER"
                  | "ORANGE"
                  | "ORANGE_DARKER"
                  | "ORANGE_DARKEST"
                  | "RED_LIGHTEST"
                  | "RED_LIGHTER"
                  | "RED"
                  | "RED_DARKER"
                  | "RED_DARKEST"
                  | "MAGENTA_LIGHTEST"
                  | "MAGENTA_LIGHTER"
                  | "MAGENTA"
                  | "MAGENTA_DARKER"
                  | "MAGENTA_DARKEST";
                  name?: string;
                  [key: string]: unknown;
              }[];
              labels: { name: string; [key: string]: unknown }[];
              [key: string]: unknown;
          }[];
          multipleGroupPickerFields?: {
              fieldId: string;
              groups: { groupName: string; [key: string]: unknown }[];
              [key: string]: unknown;
          }[];
          multipleSelectClearableUserPickerFields?: {
              fieldId: string;
              users?: { accountId: string; [key: string]: unknown }[];
              [key: string]: unknown;
          }[];
          multipleSelectFields?: {
              fieldId: string;
              options: { optionId?: number; [key: string]: unknown }[];
              [key: string]: unknown;
          }[];
          multipleVersionPickerFields?: {
              bulkEditMultiSelectFieldOption: | string & {}
              | "ADD"
              | "REMOVE"
              | "REPLACE"
              | "REMOVE_ALL";
              fieldId: string;
              versions: { versionId?: string; [key: string]: unknown }[];
              [key: string]: unknown;
          }[];
          multiselectComponents?: {
              bulkEditMultiSelectFieldOption: | string & {}
              | "ADD"
              | "REMOVE"
              | "REPLACE"
              | "REMOVE_ALL";
              components: { componentId: number; [key: string]: unknown }[];
              fieldId: string;
              [key: string]: unknown;
          };
          originalEstimateField?: {
              originalEstimateField: string;
              [key: string]: unknown;
          };
          priority?: { priorityId: string; [key: string]: unknown };
          richTextFields?: {
              fieldId: string;
              richText: { adfValue?: Record<string, any>; [key: string]: unknown };
              [key: string]: unknown;
          }[];
          singleGroupPickerFields?: {
              fieldId: string;
              group: { groupName: string; [key: string]: unknown };
              [key: string]: unknown;
          }[];
          singleLineTextFields?: {
              fieldId: string;
              text: string;
              [key: string]: unknown;
          }[];
          singleSelectClearableUserPickerFields?: {
              fieldId: string;
              user?: { accountId: string; [key: string]: unknown };
              [key: string]: unknown;
          }[];
          singleSelectFields?: {
              fieldId: string;
              option: { optionId?: number; [key: string]: unknown };
              [key: string]: unknown;
          }[];
          singleVersionPickerFields?: {
              fieldId: string;
              version: { versionId?: string; [key: string]: unknown };
              [key: string]: unknown;
          }[];
          status?: { statusId: string; [key: string]: unknown };
          timeTrackingField?: { timeRemaining: string; [key: string]: unknown };
          urlFields?: { fieldId: string; url: string; [key: string]: unknown }[];
          [key: string]: unknown;
      };
      selectedActions: string[];
      selectedIssueIdsOrKeys: string[];
      sendBulkNotification?: boolean
      | null;
  }

  • OptionaleditedFieldsInput?: {
        cascadingSelectFields?: {
            childOptionValue?: { optionId?: number; [key: string]: unknown };
            fieldId: string;
            parentOptionValue: { optionId?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        clearableNumberFields?: {
            fieldId: string;
            value?: number;
            [key: string]: unknown;
        }[];
        colorFields?: {
            color: { name: string; [key: string]: unknown };
            fieldId: string;
            [key: string]: unknown;
        }[];
        datePickerFields?: {
            date?: { formattedDate: string; [key: string]: unknown };
            fieldId: string;
            [key: string]: unknown;
        }[];
        dateTimePickerFields?: {
            dateTime: { formattedDateTime: string; [key: string]: unknown };
            fieldId: string;
            [key: string]: unknown;
        }[];
        issueType?: { issueTypeId: string; [key: string]: unknown };
        labelsFields?: {
            bulkEditMultiSelectFieldOption:
                | string & {}
                | "ADD"
                | "REMOVE"
                | "REPLACE"
                | "REMOVE_ALL";
            fieldId: string;
            labelProperties?: {
                color?: | (...) & (...)
                | "GREY_LIGHTEST"
                | "GREY_LIGHTER"
                | "GREY"
                | "GREY_DARKER"
                | "GREY_DARKEST"
                | "PURPLE_LIGHTEST"
                | "PURPLE_LIGHTER"
                | "PURPLE"
                | "PURPLE_DARKER"
                | "PURPLE_DARKEST"
                | "BLUE_LIGHTEST"
                | "BLUE_LIGHTER"
                | "BLUE"
                | "BLUE_DARKER"
                | "BLUE_DARKEST"
                | "TEAL_LIGHTEST"
                | "TEAL_LIGHTER"
                | "TEAL"
                | "TEAL_DARKER"
                | "TEAL_DARKEST"
                | "GREEN_LIGHTEST"
                | "GREEN_LIGHTER"
                | "GREEN"
                | "GREEN_DARKER"
                | "GREEN_DARKEST"
                | "LIME_LIGHTEST"
                | "LIME_LIGHTER"
                | "LIME"
                | "LIME_DARKER"
                | "LIME_DARKEST"
                | "YELLOW_LIGHTEST"
                | "YELLOW_LIGHTER"
                | "YELLOW"
                | "YELLOW_DARKER"
                | "YELLOW_DARKEST"
                | "ORANGE_LIGHTEST"
                | "ORANGE_LIGHTER"
                | "ORANGE"
                | "ORANGE_DARKER"
                | "ORANGE_DARKEST"
                | "RED_LIGHTEST"
                | "RED_LIGHTER"
                | "RED"
                | "RED_DARKER"
                | "RED_DARKEST"
                | "MAGENTA_LIGHTEST"
                | "MAGENTA_LIGHTER"
                | "MAGENTA"
                | "MAGENTA_DARKER"
                | "MAGENTA_DARKEST";
                name?: string;
                [key: string]: unknown;
            }[];
            labels: { name: string; [key: string]: unknown }[];
            [key: string]: unknown;
        }[];
        multipleGroupPickerFields?: {
            fieldId: string;
            groups: { groupName: string; [key: string]: unknown }[];
            [key: string]: unknown;
        }[];
        multipleSelectClearableUserPickerFields?: {
            fieldId: string;
            users?: { accountId: string; [key: string]: unknown }[];
            [key: string]: unknown;
        }[];
        multipleSelectFields?: {
            fieldId: string;
            options: { optionId?: number; [key: string]: unknown }[];
            [key: string]: unknown;
        }[];
        multipleVersionPickerFields?: {
            bulkEditMultiSelectFieldOption: | string & {}
            | "ADD"
            | "REMOVE"
            | "REPLACE"
            | "REMOVE_ALL";
            fieldId: string;
            versions: { versionId?: string; [key: string]: unknown }[];
            [key: string]: unknown;
        }[];
        multiselectComponents?: {
            bulkEditMultiSelectFieldOption: | string & {}
            | "ADD"
            | "REMOVE"
            | "REPLACE"
            | "REMOVE_ALL";
            components: { componentId: number; [key: string]: unknown }[];
            fieldId: string;
            [key: string]: unknown;
        };
        originalEstimateField?: {
            originalEstimateField: string;
            [key: string]: unknown;
        };
        priority?: { priorityId: string; [key: string]: unknown };
        richTextFields?: {
            fieldId: string;
            richText: { adfValue?: Record<string, any>; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        singleGroupPickerFields?: {
            fieldId: string;
            group: { groupName: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        singleLineTextFields?: {
            fieldId: string;
            text: string;
            [key: string]: unknown;
        }[];
        singleSelectClearableUserPickerFields?: {
            fieldId: string;
            user?: { accountId: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        singleSelectFields?: {
            fieldId: string;
            option: { optionId?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        singleVersionPickerFields?: {
            fieldId: string;
            version: { versionId?: string; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        status?: { statusId: string; [key: string]: unknown };
        timeTrackingField?: { timeRemaining: string; [key: string]: unknown };
        urlFields?: { fieldId: string; url: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }

    • OptionalcascadingSelectFields?: {
          childOptionValue?: { optionId?: number; [key: string]: unknown };
          fieldId: string;
          parentOptionValue: { optionId?: number; [key: string]: unknown };
          [key: string]: unknown;
      }[]

      Add or clear a cascading select field:

      • To add, specify optionId for both parent and child.
      • To clear the child, set its optionId to null.
      • To clear both, set the parent's optionId to null.

    • OptionalclearableNumberFields?: { fieldId: string; value?: number; [key: string]: unknown }[]

      Add or clear a number field:

      • To add, specify a numeric value.
      • To clear, set value to null.

    • OptionalcolorFields?: {
          color: { name: string; [key: string]: unknown };
          fieldId: string;
          [key: string]: unknown;
      }[]

      Add or clear a color field:

      • To add, specify the color name. Available colors are: purple, blue, green, teal, yellow, orange, grey, dark purple, dark blue, dark green, dark teal, dark yellow, dark orange, dark grey.
      • To clear, set the color name to an empty string.

    • OptionaldatePickerFields?: {
          date?: { formattedDate: string; [key: string]: unknown };
          fieldId: string;
          [key: string]: unknown;
      }[]

      Add or clear a date picker field:

      • To add, specify the date in d/mmm/yy format or ISO format dd-mm-yyyy.
      • To clear, set formattedDate to an empty string.

    • OptionaldateTimePickerFields?: {
          dateTime: { formattedDateTime: string; [key: string]: unknown };
          fieldId: string;
          [key: string]: unknown;
      }[]

      Add or clear the planned start date and time:

      • To add, specify the date and time in ISO format for formattedDateTime.
      • To clear, provide an empty string for formattedDateTime.

    • OptionalissueType?: { issueTypeId: string; [key: string]: unknown }

    • OptionallabelsFields?: {
          bulkEditMultiSelectFieldOption:
              | string & {}
              | "ADD"
              | "REMOVE"
              | "REPLACE"
              | "REMOVE_ALL";
          fieldId: string;
          labelProperties?: {
              color?: | (...) & (...)
              | "GREY_LIGHTEST"
              | "GREY_LIGHTER"
              | "GREY"
              | "GREY_DARKER"
              | "GREY_DARKEST"
              | "PURPLE_LIGHTEST"
              | "PURPLE_LIGHTER"
              | "PURPLE"
              | "PURPLE_DARKER"
              | "PURPLE_DARKEST"
              | "BLUE_LIGHTEST"
              | "BLUE_LIGHTER"
              | "BLUE"
              | "BLUE_DARKER"
              | "BLUE_DARKEST"
              | "TEAL_LIGHTEST"
              | "TEAL_LIGHTER"
              | "TEAL"
              | "TEAL_DARKER"
              | "TEAL_DARKEST"
              | "GREEN_LIGHTEST"
              | "GREEN_LIGHTER"
              | "GREEN"
              | "GREEN_DARKER"
              | "GREEN_DARKEST"
              | "LIME_LIGHTEST"
              | "LIME_LIGHTER"
              | "LIME"
              | "LIME_DARKER"
              | "LIME_DARKEST"
              | "YELLOW_LIGHTEST"
              | "YELLOW_LIGHTER"
              | "YELLOW"
              | "YELLOW_DARKER"
              | "YELLOW_DARKEST"
              | "ORANGE_LIGHTEST"
              | "ORANGE_LIGHTER"
              | "ORANGE"
              | "ORANGE_DARKER"
              | "ORANGE_DARKEST"
              | "RED_LIGHTEST"
              | "RED_LIGHTER"
              | "RED"
              | "RED_DARKER"
              | "RED_DARKEST"
              | "MAGENTA_LIGHTEST"
              | "MAGENTA_LIGHTER"
              | "MAGENTA"
              | "MAGENTA_DARKER"
              | "MAGENTA_DARKEST";
              name?: string;
              [key: string]: unknown;
          }[];
          labels: { name: string; [key: string]: unknown }[];
          [key: string]: unknown;
      }[]

      Edit a labels field:

      • Options include ADD, REPLACE, REMOVE, or REMOVE_ALL for bulk edits.
      • To clear labels, use the REMOVE_ALL option with an empty labels array.

    • OptionalmultipleGroupPickerFields?: {
          fieldId: string;
          groups: { groupName: string; [key: string]: unknown }[];
          [key: string]: unknown;
      }[]

      Add or clear a multi-group picker field:

      • To add groups, provide an array of groups with groupNames.
      • To clear all groups, use an empty groups array.

    • OptionalmultipleSelectClearableUserPickerFields?: {
          fieldId: string;
          users?: { accountId: string; [key: string]: unknown }[];
          [key: string]: unknown;
      }[]

      Assign or unassign multiple users to/from a field:

      • To assign, provide an array of user accountIds.
      • To clear, set users to null.

    • OptionalmultipleSelectFields?: {
          fieldId: string;
          options: { optionId?: number; [key: string]: unknown }[];
          [key: string]: unknown;
      }[]

      Add or clear a multi-select field:

      • To add, provide an array of options with optionIds.
      • To clear, use an empty options array.

    • OptionalmultipleVersionPickerFields?: {
          bulkEditMultiSelectFieldOption:
              | string & {}
              | "ADD"
              | "REMOVE"
              | "REPLACE"
              | "REMOVE_ALL";
          fieldId: string;
          versions: { versionId?: string; [key: string]: unknown }[];
          [key: string]: unknown;
      }[]

      Edit a multi-version picker field like Fix Versions/Affects Versions:

      • Options include ADD, REPLACE, REMOVE, or REMOVE_ALL for bulk edits.
      • To clear the field, use the REMOVE_ALL option with an empty versions array.

    • OptionalmultiselectComponents?: {
          bulkEditMultiSelectFieldOption:
              | string & {}
              | "ADD"
              | "REMOVE"
              | "REPLACE"
              | "REMOVE_ALL";
          components: { componentId: number; [key: string]: unknown }[];
          fieldId: string;
          [key: string]: unknown;
      }

    • OptionaloriginalEstimateField?: { originalEstimateField: string; [key: string]: unknown }

    • Optionalpriority?: { priorityId: string; [key: string]: unknown }

    • OptionalrichTextFields?: {
          fieldId: string;
          richText: { adfValue?: Record<string, any>; [key: string]: unknown };
          [key: string]: unknown;
      }[]

      Add or clear a rich text field:

      • To add, provide adfValue. Note that rich text fields only support ADF values.
      • To clear, use an empty richText object.

      For ADF format details, refer to: Atlassian Document Format.

    • OptionalsingleGroupPickerFields?: {
          fieldId: string;
          group: { groupName: string; [key: string]: unknown };
          [key: string]: unknown;
      }[]

      Add or clear a single group picker field:

      • To add, specify the group with groupName.
      • To clear, set groupName to an empty string.

    • OptionalsingleLineTextFields?: { fieldId: string; text: string; [key: string]: unknown }[]

      Add or clear a single line text field:

      • To add, provide the text value.
      • To clear, set text to an empty string.

    • OptionalsingleSelectClearableUserPickerFields?: {
          fieldId: string;
          user?: { accountId: string; [key: string]: unknown };
          [key: string]: unknown;
      }[]

      Edit assignment for single select user picker fields like Assignee/Reporter:

      • To assign an issue, specify the user's accountId.
      • To unassign an issue, set user to null.
      • For automatic assignment, set accountId to -1.

    • OptionalsingleSelectFields?: {
          fieldId: string;
          option: { optionId?: number; [key: string]: unknown };
          [key: string]: unknown;
      }[]

      Add or clear a single select field:

      • To add, specify the option with an optionId.
      • To clear, pass an option with optionId as -1.

    • OptionalsingleVersionPickerFields?: {
          fieldId: string;
          version: { versionId?: string; [key: string]: unknown };
          [key: string]: unknown;
      }[]

      Add or clear a single version picker field:

      • To add, specify the version with a versionId.
      • To clear, set versionId to -1.

    • Optionalstatus?: { statusId: string; [key: string]: unknown }

    • OptionaltimeTrackingField?: { timeRemaining: string; [key: string]: unknown }

    • OptionalurlFields?: { fieldId: string; url: string; [key: string]: unknown }[]

      Add or clear a URL field:

      • To add, provide the url with the desired URL value.
      • To clear, set url to an empty string.

  • selectedActions: string[]

    List of all the field IDs that are to be bulk edited. Each field ID in this list corresponds to a specific attribute of an issue that is set to be modified in the bulk edit operation. The relevant field ID can be obtained by calling the Bulk Edit Get Fields REST API (documentation available on this page itself).

  • selectedIssueIdsOrKeys: string[]

    List of issue IDs or keys which are to be bulk edited. These IDs or keys can be from different projects and issue types.

  • OptionalsendBulkNotification?: boolean | null

    A boolean value that indicates whether to send a bulk change notification when the issues are being edited.

    If true, dispatches a bulk notification email to users about the updates.

• Optionaloptions: RequestOptions